DOCS

Order complete object

/

Order Complete object

Explore the capabilities and functions of the Order Complete object.

The Order Complete object provides the Zonos-specific order ID for a completed order.

Attributes 

FieldNotes
id STRINGThe unique identifier for the object. The id for the Order Complete object will always be prefixed with ordr.
landed_cost_id STRINGThe unique landed cost identifier for the merchant or exporter.
account_order_id STRINGThe number string for the order.
zonos_order_id STRINGThe Zonos number string for the order.
parties STRINGA 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.id STRINGThe unique identifier for the object. The id for the parties object will always be prefixed with prty.
parties.city STRINGA string for the address city, town, district, suburb, or village of the listed party.
parties.contact_email STRINGA string for the contact email.
parties.contact_name STRINGA string for the contact name.
parties.contact_phone STRINGThe contact phone number.
parties.company_name STRINGThe company name.
parties.country STRINGThe country, represented by a two-letter ISO code.
parties.line1 STRINGA string for line 1 of the address.
parties.line2 STRINGA string for line 2 of the address.
parties.postal_code STRINGA string for the postal code. Optional for ship_to depending on the country of import.
parties.state STRINGA string for the state code when available. Only required in Canada and Brazil for ship_to.
parties.tax_id STRINGThe tax id of the party. For the ship_to this is required for import into countries like Brazil.
parties.type STRINGThe type of party the provided information represents. Possible values include ship_to, ship_from, shipper, sold_to, duties_taxes_payor, and broker.
tracking_numbers STRINGA string 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"]
}

Was this page helpful?