Attributes
JSON key/value pairs in the request body
POST | https://api.zonos.com/v1/orders
HEADER zonos-version: 2021-01-01
The header above is a required input for this order complete request to complete successfully.
| Field | Notes |
|---|---|
account_order_id OPTIONAL | The number string for the order. |
landed_cost_id REQUIRED | The unique landed cost identifier for the merchant or exporter. |
parties REQUIRED | A list of the parties involved in the shipment. This includes the information for the party who is shipping the package, receiving the package, brokering the package, and responsible for payment of duties and taxes.Providing the ship_from and ship_to parties is required. |
parties.city REQUIRED | A string for the address city, town, district, suburb, or village of the listed party. |
parties.contact_email REQUIRED | A string for the contact email. |
parties.contact_name REQUIRED | A string for the contact name. |
parties.contact_phone REQUIRED | The contact phone number. |
parties.company_name OPTIONAL | The company name. |
parties.country REQUIRED | The country, represented by a two-letter ISO code. |
parties.line1 REQUIRED | A string for line 1 of the address. |
parties.line2 REQUIRED | A string for line 2 of the address. |
parties.postal_code REQUIRED | A string for the postal code. Optional for ship_to depending on the country of import. |
parties.state OPTIONAL | A string for the state code when available. Only required in Canada and Brazil for ship_to. |
parties.tax_id OPTIONAL | The ship_to party must provide a tax ID to import into countries like Brazil. If it is not provided for shipments to Brazil, the shipment will be held at customs until the receiver can be contacted to provide the tax ID. If the receiver cannot be reached, deliveries will likely be delayed, potentially resulting in returned or abandoned packages. |
parties.type REQUIRED | The type of party the provided information represents. Possible values include ship_to, ship_from, shipper, sold_to, duties_taxes_payor, and broker. |
test OPTIONAL | If populated with the value of true, you will not be invoiced for charges related to this order. |
tracking_numbers OPTIONAL | A list for the order tracking numbers. |
Example request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_order_id": "123456",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"parties": [
{
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
Example response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"id": "ordr_5LwjnR9AW6L9eXs9lfeMC7",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"account_order_id": "123456",
"zonos_order_id": "1000151",
"parties": [
{
"id": "prty_12165151351",
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"line3": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
Request an order complete
Explore the key/value pairs in an order complete request.The Order Complete API allows you to create a new request for completed order information, providing essential details for accurate processing. This API ensures successful order completion by specifying vital information about the involved parties and tracking numbers, among other required fields.