Attributs
Paires clé/valeur JSON dans le corps de la demande
POST | https://api.zonos.com/v1/orders
HEADER zonos-version: 2021-01-01
L'en-tête ci-dessus est une entrée requise pour que cette demande de commande complète soit complétée avec succès.
| Champ | Notes |
|---|---|
account_order_id OPTIONNEL | La chaîne de caractères pour le numéro de commande. |
landed_cost_id REQUIS | L'identifiant unique de landed cost pour le marchand ou l'exportateur. |
parties REQUIS | Une liste des parties impliquées dans l'expédition. Cela inclut les informations pour la partie qui expédie le colis, reçoit le colis, courtage le colis, et est responsable du paiement des droits et taxes. Fournir les parties ship_from et ship_to est requis. |
parties.city REQUIS | Une chaîne de caractères pour la ville, le village, le district, la banlieue ou le village de l'adresse de la partie listée. |
parties.contact_email REQUIS | Une chaîne de caractères pour l'email de contact. |
parties.contact_name REQUIS | Une chaîne de caractères pour le nom du contact. |
parties.contact_phone REQUIS | Le numéro de téléphone du contact. |
parties.company_name OPTIONNEL | Le nom de l'entreprise. |
parties.country REQUIS | Le pays, représenté par un code ISO à deux lettres. |
parties.line1 REQUIS | Une chaîne de caractères pour la ligne 1 de l'adresse. |
parties.line2 REQUIS | Une chaîne de caractères pour la ligne 2 de l'adresse. |
parties.postal_code REQUIS | Une chaîne de caractères pour le code postal. Optionnel pour ship_to selon le pays d'importation. |
parties.state OPTIONNEL | Une chaîne de caractères pour le code de l'état lorsque disponible. Requis uniquement au Canada et au Brésil pour ship_to. |
parties.tax_id OPTIONNEL | La partie ship_to doit fournir un identifiant fiscal pour importer dans des pays comme le Brésil. S'il n'est pas fourni pour les envois au Brésil, l'envoi sera retenu à la douane jusqu'à ce que le destinataire puisse être contacté pour fournir l'identifiant fiscal. Si le destinataire ne peut pas être joint, les livraisons seront probablement retardées, ce qui pourrait entraîner le retour ou l'abandon des colis. |
parties.type REQUIS | Le type de partie que représentent les informations fournies. Les valeurs possibles incluent ship_to, ship_from, shipper, sold_to, duties_taxes_payor, et broker. |
test OPTIONNEL | Si rempli avec la valeur true, vous ne serez pas facturé pour les frais liés à cette commande. |
tracking_numbers OPTIONNEL | Une liste pour les numéros de suivi de la commande. |
Exemple de demande
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"]
}
Exemple de réponse
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"]
}
Demander une commande complète
Explorez les paires clé/valeur dans une demande de commande complète.
L'API Order Complete vous permet de créer une nouvelle demande d'informations sur les commandes complétées, fournissant des détails essentiels pour un traitement précis. Cette API garantit l'achèvement réussi des commandes en spécifiant des informations vitales sur les parties impliquées et les numéros de suivi, entre autres champs requis.