Motta sanntidsvarslinger for hendelser i Zonos-integreringen din.
Denne veiledningen beskriver de hendelsestypene som Zonos kan sende som webhook-respons. Hver type returnerer et spesifikt GraphQL-objekt som inneholder dataene som er relevante for hendelsen.
Hendelsen ORDER_STATUS_CHANGED utløses når en ordrestatus endres. Den returnerer alltid et Order-objekt. Mulige statuser finnes i enumerasjonen OrderStatus.
Hendelsen ORDER_RETURN_CREATED utløses når en retur opprettes på en ordre. Den nye returen starter i statusen REQUESTED.
Når en retur opprettes, sendes ikke ORDER_RETURN_STATUS_CHANGED i tillegg. Det gjør derimot hver statusendring etter det.
1{
2"eventType":"ORDER_RETURN_CREATED",
3"orderReturnId":"order_return_[ID]"
4}
Hent returens detaljer
Returhendelser inneholder bare hendelsestypen og returens ID. For å hente returens status, varer, etikett og historikk, spør etter den med orderReturn og be om feltene integrasjonen din trenger. Den returnerer et 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}
Merk: Spørringen returnerer returen slik den er når du spør, ikke slik den var da hendelsen ble utløst. Hvis en retur endres igjen raskt, kan den allerede ha gått forbi statusen hendelsen gjaldt. Behandle status som returens nåværende tilstand, og bruk statusTransitions for historikken. Oppføringene i statusTransitions er ikke garantert å komme i rekkefølge, så sorter dem etter createdAt.
Hendelsen ORDER_RETURN_STATUS_CHANGED utløses hver gang en retur går over til en ny status: godkjent, etikett utstedt, under transport, mottatt, inspisert, fullført, avvist eller kansellert.
Den nyeste oppføringen i returens statusTransitions, etter createdAt, viser endringen: fromStatus, toStatus, hvem som gjorde den, og eventuelle notater vedkommende la igjen, for eksempel årsaken til at en retur ble avvist. For å lese den, spør etter returen som vist under Hent returens detaljer ovenfor.
Hendelsen ORDER_RETURN_COMPLETED utløses når en retur er fullført og lukket.
Når en retur fullføres, sendes også ORDER_RETURN_STATUS_CHANGED. Hvis du bare trenger å vite når returer lukkes, abonner kun på ORDER_RETURN_COMPLETED i stedet for å håndtere hver statusendring. Hvis du abonnerer på begge, kan du forvente to webhooks når en retur fullføres.
ORDER_RETURN_COMPLETED sendes ikke for avviste eller kansellerte returer. Disse avsluttes kun med ORDER_RETURN_STATUS_CHANGED.
1{
2"eventType":"ORDER_RETURN_COMPLETED",
3"orderReturnId":"order_return_[ID]"
4}
Merk: Å fullføre en retur refunderer aldri kunden. linkedRefunds på en fullført retur viser refusjoner du har utstedt på ordren og koblet til returen. Det betyr ikke at Zonos har utstedt dem.
Hendelsestyper
Webhook-hendelsestyper
Motta sanntidsvarslinger for hendelser i Zonos-integreringen din.
Denne veiledningen beskriver de hendelsestypene som Zonos kan sende som webhook-respons. Hver type returnerer et spesifikt GraphQL-objekt som inneholder dataene som er relevante for hendelsen.
ORDER_CREATED
Hendelsen
ORDER_CREATEDutløses når en ny ordre opprettes. Den returnerer alltid etOrder-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
Hendelsen
ORDER_CANCELEDutløses når en ordre kanselleres. Den returnerer alltid etOrder-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
Hendelsen
ORDER_STATUS_CHANGEDutløses når en ordrestatus endres. Den returnerer alltid etOrder-objekt. Mulige statuser finnes i enumerasjonenOrderStatus.{"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
Hendelsen
ORDER_RETURN_CREATEDutløses når en retur opprettes på en ordre. Den nye returen starter i statusenREQUESTED.Når en retur opprettes, sendes ikke
ORDER_RETURN_STATUS_CHANGEDi tillegg. Det gjør derimot hver statusendring etter det.{"eventType": "ORDER_RETURN_CREATED","orderReturnId": "order_return_[ID]"}Hent returens detaljer
Returhendelser inneholder bare hendelsestypen og returens ID. For å hente returens status, varer, etikett og historikk, spør etter den med
orderReturnog be om feltene integrasjonen din trenger. Den returnerer etOrderReturn-objekt.query OrderReturn($id: ID!) {orderReturn(id: $id) {idstatusorder {idaccountOrderNumber}lines {iditemIdquantityreasondispositionnote}labelSourcecarriertrackingNumberstatusTransitions {fromStatustoStatusactornotecreatedAt}updatedAt}}ORDER_RETURN_STATUS_CHANGED
Hendelsen
ORDER_RETURN_STATUS_CHANGEDutløses hver gang en retur går over til en ny status: godkjent, etikett utstedt, under transport, mottatt, inspisert, fullført, avvist eller kansellert.Den nyeste oppføringen i returens
statusTransitions, ettercreatedAt, viser endringen:fromStatus,toStatus, hvem som gjorde den, og eventuelle notater vedkommende la igjen, for eksempel årsaken til at en retur ble avvist. For å lese den, spør etter returen som vist under Hent returens detaljer ovenfor.{"eventType": "ORDER_RETURN_STATUS_CHANGED","orderReturnId": "order_return_[ID]"}ORDER_RETURN_COMPLETED
Hendelsen
ORDER_RETURN_COMPLETEDutløses når en retur er fullført og lukket.Når en retur fullføres, sendes også
ORDER_RETURN_STATUS_CHANGED. Hvis du bare trenger å vite når returer lukkes, abonner kun påORDER_RETURN_COMPLETEDi stedet for å håndtere hver statusendring. Hvis du abonnerer på begge, kan du forvente to webhooks når en retur fullføres.ORDER_RETURN_COMPLETEDsendes ikke for avviste eller kansellerte returer. Disse avsluttes kun medORDER_RETURN_STATUS_CHANGED.{"eventType": "ORDER_RETURN_COMPLETED","orderReturnId": "order_return_[ID]"}SHIPMENT_CANCELED
Hendelsen
SHIPMENT_CANCELEDutløses når en forsendelse blir annullert. Den returnerer alltid etShipment-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
Hendelsen
SHIPMENT_CREATEDutløses når en forsendelse opprettes. Den returnerer alltid etShipment-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 denne siden nyttig?