Få realtidsaviseringar om händelser för er Zonos-integration.
Den här guiden beskriver de händelsetyper som Zonos kan skicka som ett webhook-svar. Varje typ returnerar ett specifikt GraphQL-objekt som innehåller de data som är relevanta för händelsen.
Händelsen ORDER_STATUS_CHANGED utlöses varje gång en orderstatus ändras. Den returnerar alltid ett Order-objekt. Möjliga statusar finns i enumen OrderStatus.
Händelsen ORDER_RETURN_CREATED utlöses när en retur skapas för en order. Den nya returen börjar med statusen REQUESTED.
När en retur skapas skickas inte även ORDER_RETURN_STATUS_CHANGED. Det görs vid varje statusändring därefter.
1{
2"eventType":"ORDER_RETURN_CREATED",
3"orderReturnId":"order_return_[ID]"
4}
Hämta returens detaljer
Returhändelser innehåller bara händelsetypen och returens ID. För att hämta returens status, artiklar, etikett och historik frågar ni efter den med orderReturn och begär de fält som er integration behöver. Den returnerar ett OrderReturn-objekt.
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}
Obs: Frågan returnerar returen som den ser ut när ni frågar, inte som den såg ut när händelsen utlöstes. Om en retur ändras igen snabbt kan den redan ha gått vidare från den status som händelsen gällde. Behandla status som returens aktuella tillstånd och använd statusTransitions för dess historik. Posterna i statusTransitions är inte garanterat i ordning, så sortera dem efter createdAt.
Händelsen ORDER_RETURN_STATUS_CHANGED utlöses varje gång en retur får en ny status: godkänd, etikett utfärdad, under transport, mottagen, inspekterad, slutförd, avvisad eller annullerad.
Den senaste posten i returens statusTransitions, sorterat efter createdAt, visar ändringen: dess fromStatus, dess toStatus, vem som gjorde den och eventuell anteckning de lämnade, till exempel orsaken till att en retur avvisades. För att läsa den frågar ni efter returen enligt Hämta returens detaljer ovan.
Händelsen ORDER_RETURN_COMPLETED utlöses när en retur slutförs och stängs.
När en retur slutförs skickas även ORDER_RETURN_STATUS_CHANGED. Om ni bara behöver veta när returer stängs kan ni prenumerera enbart på ORDER_RETURN_COMPLETED i stället för att hantera varje statusändring. Om ni prenumererar på båda kan ni förvänta er två webhooks när en retur slutförs.
ORDER_RETURN_COMPLETED skickas inte för avvisade eller annullerade returer. De avslutas endast med ORDER_RETURN_STATUS_CHANGED.
1{
2"eventType":"ORDER_RETURN_COMPLETED",
3"orderReturnId":"order_return_[ID]"
4}
Obs: Att slutföra en retur återbetalar aldrig kunden. En slutförd returs linkedRefunds listar återbetalningar som ni har utfärdat för ordern och kopplat till returen. Det betyder inte att Zonos har utfärdat dem.
Händelsetyper
Webhook-händelsetyper
Få realtidsaviseringar om händelser för er Zonos-integration.
Den här guiden beskriver de händelsetyper som Zonos kan skicka som ett webhook-svar. Varje typ returnerar ett specifikt GraphQL-objekt som innehåller de data som är relevanta för händelsen.
ORDER_CREATED
Händelsen
ORDER_CREATEDutlöses när en ny order skapas. Den returnerar alltid ettOrder-objekt.{"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
Händelsen
ORDER_CANCELEDutlöses när en order avbryts. Den returnerar alltid ettOrder-objekt.{"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
Händelsen
ORDER_STATUS_CHANGEDutlöses varje gång en orderstatus ändras. Den returnerar alltid ettOrder-objekt. Möjliga statusar finns i enumenOrderStatus.{"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
Händelsen
ORDER_RETURN_CREATEDutlöses när en retur skapas för en order. Den nya returen börjar med statusenREQUESTED.När en retur skapas skickas inte även
ORDER_RETURN_STATUS_CHANGED. Det görs vid varje statusändring därefter.{"eventType": "ORDER_RETURN_CREATED","orderReturnId": "order_return_[ID]"}Hämta returens detaljer
Returhändelser innehåller bara händelsetypen och returens ID. För att hämta returens status, artiklar, etikett och historik frågar ni efter den med
orderReturnoch begär de fält som er integration behöver. Den returnerar ettOrderReturn-objekt.query OrderReturn($id: ID!) {orderReturn(id: $id) {idstatusorder {idaccountOrderNumber}lines {iditemIdquantityreasondispositionnote}labelSourcecarriertrackingNumberstatusTransitions {fromStatustoStatusactornotecreatedAt}updatedAt}}ORDER_RETURN_STATUS_CHANGED
Händelsen
ORDER_RETURN_STATUS_CHANGEDutlöses varje gång en retur får en ny status: godkänd, etikett utfärdad, under transport, mottagen, inspekterad, slutförd, avvisad eller annullerad.Den senaste posten i returens
statusTransitions, sorterat eftercreatedAt, visar ändringen: dessfromStatus, desstoStatus, vem som gjorde den och eventuell anteckning de lämnade, till exempel orsaken till att en retur avvisades. För att läsa den frågar ni efter returen enligt Hämta returens detaljer ovan.{"eventType": "ORDER_RETURN_STATUS_CHANGED","orderReturnId": "order_return_[ID]"}ORDER_RETURN_COMPLETED
Händelsen
ORDER_RETURN_COMPLETEDutlöses när en retur slutförs och stängs.När en retur slutförs skickas även
ORDER_RETURN_STATUS_CHANGED. Om ni bara behöver veta när returer stängs kan ni prenumerera enbart påORDER_RETURN_COMPLETEDi stället för att hantera varje statusändring. Om ni prenumererar på båda kan ni förvänta er två webhooks när en retur slutförs.ORDER_RETURN_COMPLETEDskickas inte för avvisade eller annullerade returer. De avslutas endast medORDER_RETURN_STATUS_CHANGED.{"eventType": "ORDER_RETURN_COMPLETED","orderReturnId": "order_return_[ID]"}SHIPMENT_CANCELED
Händelsen
SHIPMENT_CANCELEDutlöses varje gång en försändelse annulleras. Den returnerar alltid ettShipment-objekt.{"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
Händelsen
SHIPMENT_CREATEDutlöses varje gång en försändelse skapas. Den returnerar alltid ettShipment-objekt.{"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}}}Var den här sidan till hjälp?