Recevez des notifications d'événements en temps réel pour votre intégration Zonos.
Ce guide détaille les types d'événements que Zonos peut envoyer en réponse webhook. Chaque type renvoie un objet GraphQL spécifique contenant les données pertinentes pour l'événement.
L'événement ORDER_STATUS_CHANGED est déclenché chaque fois qu'un statut de commande change. Il renvoie toujours un objet Order. Les statuts possibles se trouvent dans l'énumération OrderStatus.
L'événement ORDER_RETURN_CREATED est déclenché lorsqu'un retour est créé sur une commande. Le nouveau retour commence avec le statut REQUESTED.
La création d'un retour n'envoie pas également ORDER_RETURN_STATUS_CHANGED. Chaque changement de statut ultérieur, en revanche, l'envoie.
1{
2"eventType":"ORDER_RETURN_CREATED",
3"orderReturnId":"order_return_[ID]"
4}
Obtenir les détails du retour
Les événements de retour ne contiennent que le type d'événement et l'ID du retour. Pour obtenir le statut, les articles, l'étiquette et l'historique du retour, interrogez-le avec orderReturn en demandant les champs dont votre intégration a besoin. Il renvoie un objet OrderReturn.
1queryOrderReturn($id: ID!){
2 orderReturn(id:$id) {
3 id
4 status
5 order {
6 id
7 accountOrderNumber
8}
9 lines {
10 id
11 itemId
12 quantity
13 reason
14 disposition
15 note
16}
17 labelSource
18 carrier
19 trackingNumber
20 statusTransitions {
21 fromStatus
22 toStatus
23 actor
24 note
25 createdAt
26}
27 updatedAt
28}
29}
Remarque : La requête renvoie le retour tel qu'il est au moment où vous l'interrogez, et non tel qu'il était lorsque l'événement a été déclenché. Si un retour change de nouveau rapidement, il peut déjà avoir dépassé le statut concerné par l'événement. Considérez status comme l'état actuel du retour et utilisez statusTransitions pour son historique. L'ordre des entrées de statusTransitions n'est pas garanti : triez-les donc par createdAt.
L'événement ORDER_RETURN_STATUS_CHANGED est déclenché chaque fois qu'un retour passe à un nouveau statut : approuvé, étiquette émise, en transit, reçu, inspecté, terminé, refusé ou annulé.
L'entrée la plus récente de statusTransitions du retour, selon createdAt, indique le changement : son fromStatus, son toStatus, son auteur et toute note laissée, comme le motif du refus d'un retour. Pour la lire, interrogez le retour comme indiqué dans Obtenir les détails du retour ci-dessus.
L'événement ORDER_RETURN_COMPLETED est déclenché lorsqu'un retour est terminé et clôturé.
La finalisation d'un retour envoie également ORDER_RETURN_STATUS_CHANGED. Si vous avez seulement besoin de savoir quand les retours sont clôturés, abonnez-vous uniquement à ORDER_RETURN_COMPLETED plutôt que de traiter chaque changement de statut. Si vous vous abonnez aux deux, attendez-vous à recevoir deux webhooks lorsqu'un retour est terminé.
ORDER_RETURN_COMPLETED n'est pas envoyé pour les retours refusés ou annulés. Ceux-ci se terminent uniquement par ORDER_RETURN_STATUS_CHANGED.
1{
2"eventType":"ORDER_RETURN_COMPLETED",
3"orderReturnId":"order_return_[ID]"
4}
Remarque : La finalisation d'un retour ne rembourse jamais l'acheteur. Le champ linkedRefunds d'un retour terminé répertorie les remboursements que vous avez émis sur la commande et liés au retour. Cela ne signifie pas que Zonos les a émis.
Types d'événements
Types d'événements webhook
Recevez des notifications d'événements en temps réel pour votre intégration Zonos.
Ce guide détaille les types d'événements que Zonos peut envoyer en réponse webhook. Chaque type renvoie un objet GraphQL spécifique contenant les données pertinentes pour l'événement.
ORDER_CREATED
L'événement
ORDER_CREATEDest déclenché lorsqu'une nouvelle commande est créée. Il renvoie toujours un objetOrder.{"data": {"order": {"status": "OPEN","createdAt": "2024-07-23T16:18:57.104Z","accountOrderNumber": null,"currencyCode": "HKD","organization": "organization_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","amountSubtotals": {"duties": 0,"fees": 0,"items": 9999.99,"shipping": 9999.99,"taxes": 0,"variance": -0.01},"root": {"exchangeRates": [{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.99999,"type": "GUARANTEED"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "HKD","targetCurrencyCode": "USD","rate": 0.9999999999999999,"type": "MID_MARKET"}]},"items": [{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "9999.99","sku": "DISCOUNT_SKU","countryOfOrigin": "CN","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 0}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"imageUrl": "https://example.com/product1-image.jpg","currencyCode": "USD","description": "Product 1 Description","hsCode": "9999.99.99","sku": "PRODUCT1_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 999}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"imageUrl": "https://example.com/product2-image.jpg","currencyCode": "USD","description": "Product 2 Description","hsCode": "9999.99.99","sku": "PRODUCT2_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 99}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Insurance","productId": "","amount": 99.99,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "","sku": "INSURANCE_SKU","countryOfOrigin": "US","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 9.999}],"quantity": 1,"attributes": null}],"paymentDetail": {"chargeId": "ch_xxxxxxxxxxxxxxxxxxxxxxxxxx","refunds": []},"landedCosts": [{"method": "DDP","landedCostGuaranteeCode": "GUARANTEE_CODE","currencyCode": "USD","amountSubtotals": {"landedCostTotal": 0,"duties": 0,"fees": 0,"taxes": 0,"items": 999.99,"shipping": 999.99},"remittance": [],"shipmentRating": {"displayName": "Shipping Method","serviceLevelCode": "shipping.service_code","amount": 999.99,"currencyCode": "USD","details": [{"amount": 9999.99,"carrierCode": "Carrier api: standard rate (shipping_rate)","type": "PUBLISHED_RATE"},{"amount": 999.99,"carrierCode": "Carrier api: fuel surcharge (999)","type": "FUEL_SURCHARGE"},{"amount": -9999.99,"carrierCode": "negotiated_rate","type": "DISCOUNT"}],"appliedRules": []},"deMinimis": [{"type": "DUTY","threshold": "ABOVE"},{"type": "TAX","threshold": "ABOVE"}],"duties": [{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"taxes": [{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"fees": []}]}}}ORDER_CANCELED
L'événement
ORDER_CANCELEDest déclenché lorsqu'une commande est annulée. Il renvoie toujours un objetOrder.{"data": {"order": {"status": "OPEN","createdAt": "2024-07-23T16:18:57.104Z","accountOrderNumber": null,"currencyCode": "HKD","organization": "organization_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","amountSubtotals": {"duties": 0,"fees": 0,"items": 9999.99,"shipping": 9999.99,"taxes": 0,"variance": -0.01},"root": {"exchangeRates": [{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.99999,"type": "GUARANTEED"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "HKD","targetCurrencyCode": "USD","rate": 0.9999999999999999,"type": "MID_MARKET"}]},"items": [{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "9999.99","sku": "DISCOUNT_SKU","countryOfOrigin": "CN","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 0}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"imageUrl": "https://example.com/product1-image.jpg","currencyCode": "USD","description": "Product 1 Description","hsCode": "9999.99.99","sku": "PRODUCT1_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 999}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"imageUrl": "https://example.com/product2-image.jpg","currencyCode": "USD","description": "Product 2 Description","hsCode": "9999.99.99","sku": "PRODUCT2_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 99}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Insurance","productId": "","amount": 99.99,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "","sku": "INSURANCE_SKU","countryOfOrigin": "US","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 9.999}],"quantity": 1,"attributes": null}],"paymentDetail": {"chargeId": "ch_xxxxxxxxxxxxxxxxxxxxxxxxxx","refunds": []},"landedCosts": [{"method": "DDP","landedCostGuaranteeCode": "GUARANTEE_CODE","currencyCode": "USD","amountSubtotals": {"landedCostTotal": 0,"duties": 0,"fees": 0,"taxes": 0,"items": 999.99,"shipping": 999.99},"remittance": [],"shipmentRating": {"displayName": "Shipping Method","serviceLevelCode": "shipping.service_code","amount": 999.99,"currencyCode": "USD","details": [{"amount": 9999.99,"carrierCode": "Carrier api: standard rate (shipping_rate)","type": "PUBLISHED_RATE"},{"amount": 999.99,"carrierCode": "Carrier api: fuel surcharge (999)","type": "FUEL_SURCHARGE"},{"amount": -9999.99,"carrierCode": "negotiated_rate","type": "DISCOUNT"}],"appliedRules": []},"deMinimis": [{"type": "DUTY","threshold": "ABOVE"},{"type": "TAX","threshold": "ABOVE"}],"duties": [{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"taxes": [{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"fees": []}]}}}ORDER_STATUS_CHANGED
L'événement
ORDER_STATUS_CHANGEDest déclenché chaque fois qu'un statut de commande change. Il renvoie toujours un objetOrder. Les statuts possibles se trouvent dans l'énumérationOrderStatus.{"data": {"order": {"status": "OPEN","createdAt": "2024-07-23T16:18:57.104Z","accountOrderNumber": null,"currencyCode": "HKD","organization": "organization_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","amountSubtotals": {"duties": 0,"fees": 0,"items": 9999.99,"shipping": 9999.99,"taxes": 0,"variance": -0.01},"root": {"exchangeRates": [{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.99999,"type": "GUARANTEED"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "USD","targetCurrencyCode": "HKD","rate": 9.9999,"type": "MID_MARKET"},{"sourceCurrencyCode": "HKD","targetCurrencyCode": "USD","rate": 0.9999999999999999,"type": "MID_MARKET"}]},"items": [{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "9999.99","sku": "DISCOUNT_SKU","countryOfOrigin": "CN","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 0}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"imageUrl": "https://example.com/product1-image.jpg","currencyCode": "USD","description": "Product 1 Description","hsCode": "9999.99.99","sku": "PRODUCT1_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 999}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"imageUrl": "https://example.com/product2-image.jpg","currencyCode": "USD","description": "Product 2 Description","hsCode": "9999.99.99","sku": "PRODUCT2_SKU","countryOfOrigin": "US","measurements": [{"type": "HEIGHT","unitOfMeasure": "INCH","value": 99},{"type": "LENGTH","unitOfMeasure": "INCH","value": 99},{"type": "WIDTH","unitOfMeasure": "INCH","value": 99},{"type": "WEIGHT","unitOfMeasure": "OUNCE","value": 99}],"quantity": 1,"attributes": null},{"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Insurance","productId": "","amount": 99.99,"imageUrl": "","currencyCode": "USD","description": null,"hsCode": "","sku": "INSURANCE_SKU","countryOfOrigin": "US","measurements": [{"type": "WEIGHT","unitOfMeasure": "POUND","value": 9.999}],"quantity": 1,"attributes": null}],"paymentDetail": {"chargeId": "ch_xxxxxxxxxxxxxxxxxxxxxxxxxx","refunds": []},"landedCosts": [{"method": "DDP","landedCostGuaranteeCode": "GUARANTEE_CODE","currencyCode": "USD","amountSubtotals": {"landedCostTotal": 0,"duties": 0,"fees": 0,"taxes": 0,"items": 999.99,"shipping": 999.99},"remittance": [],"shipmentRating": {"displayName": "Shipping Method","serviceLevelCode": "shipping.service_code","amount": 999.99,"currencyCode": "USD","details": [{"amount": 9999.99,"carrierCode": "Carrier api: standard rate (shipping_rate)","type": "PUBLISHED_RATE"},{"amount": 999.99,"carrierCode": "Carrier api: fuel surcharge (999)","type": "FUEL_SURCHARGE"},{"amount": -9999.99,"carrierCode": "negotiated_rate","type": "DISCOUNT"}],"appliedRules": []},"deMinimis": [{"type": "DUTY","threshold": "ABOVE"},{"type": "TAX","threshold": "ABOVE"}],"duties": [{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "ITEM","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "duty","type": "SHIPPING","formula": "0.0 % cif","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"taxes": [{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "ITEM","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "SHIPPING","formula": "0%","note": null,"item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 1","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 1 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Discount","productId": "","amount": 0,"currencyCode": "USD","quantity": 1,"description": null}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the item","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}},{"amount": 0,"currencyCode": "USD","description": "Tax","type": "DUTY","formula": "0%","note": "Tax on the duty of the shipping","item": {"id": "item_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name": "Product 2","productId": "","amount": 999.99,"currencyCode": "USD","quantity": 1,"description": "Product 2 Description"}}],"fees": []}]}}}ORDER_RETURN_CREATED
L'événement
ORDER_RETURN_CREATEDest déclenché lorsqu'un retour est créé sur une commande. Le nouveau retour commence avec le statutREQUESTED.La création d'un retour n'envoie pas également
ORDER_RETURN_STATUS_CHANGED. Chaque changement de statut ultérieur, en revanche, l'envoie.{"eventType": "ORDER_RETURN_CREATED","orderReturnId": "order_return_[ID]"}Obtenir les détails du retour
Les événements de retour ne contiennent que le type d'événement et l'ID du retour. Pour obtenir le statut, les articles, l'étiquette et l'historique du retour, interrogez-le avec
orderReturnen demandant les champs dont votre intégration a besoin. Il renvoie un objetOrderReturn.query OrderReturn($id: ID!) {orderReturn(id: $id) {idstatusorder {idaccountOrderNumber}lines {iditemIdquantityreasondispositionnote}labelSourcecarriertrackingNumberstatusTransitions {fromStatustoStatusactornotecreatedAt}updatedAt}}ORDER_RETURN_STATUS_CHANGED
L'événement
ORDER_RETURN_STATUS_CHANGEDest déclenché chaque fois qu'un retour passe à un nouveau statut : approuvé, étiquette émise, en transit, reçu, inspecté, terminé, refusé ou annulé.L'entrée la plus récente de
statusTransitionsdu retour, seloncreatedAt, indique le changement : sonfromStatus, sontoStatus, son auteur et toute note laissée, comme le motif du refus d'un retour. Pour la lire, interrogez le retour comme indiqué dans Obtenir les détails du retour ci-dessus.{"eventType": "ORDER_RETURN_STATUS_CHANGED","orderReturnId": "order_return_[ID]"}ORDER_RETURN_COMPLETED
L'événement
ORDER_RETURN_COMPLETEDest déclenché lorsqu'un retour est terminé et clôturé.La finalisation d'un retour envoie également
ORDER_RETURN_STATUS_CHANGED. Si vous avez seulement besoin de savoir quand les retours sont clôturés, abonnez-vous uniquement àORDER_RETURN_COMPLETEDplutôt que de traiter chaque changement de statut. Si vous vous abonnez aux deux, attendez-vous à recevoir deux webhooks lorsqu'un retour est terminé.ORDER_RETURN_COMPLETEDn'est pas envoyé pour les retours refusés ou annulés. Ceux-ci se terminent uniquement parORDER_RETURN_STATUS_CHANGED.{"eventType": "ORDER_RETURN_COMPLETED","orderReturnId": "order_return_[ID]"}SHIPMENT_CANCELED
L'événement
SHIPMENT_CANCELEDest déclenché chaque fois qu'un envoi est annulé. Il renvoie toujours un objetShipment.{"createdAt": 1758753664.363,"shipmentCartons": [],"createdBy": "organization_[ID]","level": "info","parties": [{"person": {"firstName": "[FIRST_NAME]","lastName": "[LAST_NAME]","email": "[EMAIL]"},"location": {"countryCode": "CA","postalCode": "[POSTAL_CODE]","locality": "[LOCALITY]","line1": "[ADDRESS_LINE1]"},"id": "party_[ID]","type": "PAYOR"},{"person": {"firstName": "[FIRST_NAME]","lastName": "[LAST_NAME]","email": "[EMAIL]"},"location": {"countryCode": "CA","postalCode": "[POSTAL_CODE]","locality": "[LOCALITY]","line1": "[ADDRESS_LINE1]"},"id": "party_[ID]","type": "DESTINATION"},{"location": {"countryCode": "US","postalCode": "[POSTAL_CODE]","locality": "[LOCALITY]","line2": "","line1": "[ADDRESS_LINE1]"},"id": "party_[ID]","type": "ORIGIN"},{"person": {"firstName": "[FIRST_NAME]","lastName": "[LAST_NAME]","email": "[EMAIL]"},"location": {"countryCode": "CA","postalCode": "[POSTAL_CODE]","locality": "[LOCALITY]","line1": "[ADDRESS_LINE1]"},"id": "party_[ID]","type": "DESTINATION"}],"id": "shipment_level_[ID]","trackingDetails": [],"serviceLevel": {"carrier": {"code": "ups","name": "UPS"},"name": "Worldwide Economy DDP","id": "service_level_[ID]"},"order": {"accountOrderNumber": "[ACCOUNT_NUMBER]","mode": "LIVE","references": [],"zonosOrderId": "zonos_order_[ID]","organization": "organization_[ID]","id": "order_[ID]"},"timestamp": "2025-09-24T22:41:04.904Z"}SHIPMENT_CREATED
L'événement
SHIPMENT_CREATEDest déclenché chaque fois qu'un envoi est créé. Il renvoie toujours un objetShipment.{"data": {"shipment": {"id": "shipment_[ID]","order": {"accountOrderNumber": "[ACCOUNT_NUMBER]","id": "order_[ID]"},"parties": [{"type": "ORIGIN","location": {"countryCode": "ID","administrativeArea": null,"administrativeAreaCode": "[AREA_CODE]","line1": "[ADDRESS_LINE1]","line2": "","line3": "","locality": "[LOCALITY]","postalCode": "[POSTAL_CODE]"},"person": {"firstName": "[FIRST_NAME]","lastName": "[LAST_NAME]","email": "[EMAIL]","phone": "[PHONE]","companyName": "[COMPANY_NAME]"}},{"type": "DESTINATION","location": {"countryCode": "US","administrativeArea": null,"administrativeAreaCode": "NY","line1": "[ADDRESS_LINE1]","line2": "[LINE2]","line3": null,"locality": "New York","postalCode": "[POSTAL_CODE]"},"person": {"firstName": "[FIRST_NAME]","lastName": "[LAST_NAME]","email": "[EMAIL]","phone": "[PHONE]","companyName": ""}}],"serviceLevel": {"carrier": {"name": "DHL"},"name": "DHL Express Worldwide","code": "dhl.express_worldwide"},"shipmentCartons": [{"id": "shipment_carton_[ID]","carton": {"length": 5.9055,"width": 7.874,"height": 3.937,"dimensionalUnit": "INCH","weight": 0.23,"weightUnit": "POUND","items": [{"quantity": 1,"item": {"id": "item_[ID]","sku": "","name": "Caraco Black - S / Black","description": null,"hsCode": "6109.10.0027","amount": 125,"currencyCode": "USD"}}]},"tracking": {"number": "[TRACKING_NUMBER]"},"label": {"labelAmounts": [{"amount": 22.71,"amountType": "QUOTE","currencyCode": "USD"}],"labelFileType": "PDF","url": "[URL]","statusTransitions": [{"changedAt": "[DATE_TIME]","status": "CREATED"}]}}],"createdAt": "[DATE_TIME]","status": "CREATED","customsDocuments": [{"documentType": "COMMERCIAL_INVOICE","fileUrl": "[URL]"}],"shipmentConsolidation": null}}}Cette page a-t-elle été utile?