Dapatkan notifikasi acara real-time untuk integrasi Zonos Anda.
Panduan ini merinci jenis acara yang dapat Zonos kirim sebagai respons webhook. Setiap tipe mengembalikan objek GraphQL spesifik yang berisi data yang relevan dengan acara tersebut.
Acara ORDER_STATUS_CHANGED dipicu setiap kali status pesanan berubah. Selalu mengembalikan objek Order. Status yang mungkin ditemukan pada enum OrderStatus.
Acara ORDER_RETURN_CREATED dipicu saat pengembalian dibuat pada pesanan. Pengembalian baru dimulai dengan status REQUESTED.
Membuat pengembalian tidak sekaligus mengirim ORDER_RETURN_STATUS_CHANGED. Setiap perubahan status setelahnya akan mengirimnya.
1{
2"eventType":"ORDER_RETURN_CREATED",
3"orderReturnId":"order_return_[ID]"
4}
Dapatkan detail pengembalian
Acara pengembalian hanya membawa jenis acara dan ID pengembalian. Untuk mendapatkan status, item, label, dan riwayat pengembalian, kueri dengan orderReturn, dengan meminta kolom yang dibutuhkan integrasi Anda. Kueri ini mengembalikan objek 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}
Catatan: Kueri mengembalikan pengembalian sebagaimana kondisinya saat Anda memintanya, bukan saat acara dipicu. Jika pengembalian berubah lagi dengan cepat, statusnya mungkin sudah melewati status yang dimaksud oleh acara tersebut. Perlakukan status sebagai kondisi pengembalian saat ini, dan gunakan statusTransitions untuk riwayatnya. Entri dalam statusTransitions tidak dijamin berurutan, jadi urutkan berdasarkan createdAt.
Acara ORDER_RETURN_STATUS_CHANGED dipicu setiap kali pengembalian berpindah ke status baru: disetujui, label diterbitkan, dalam perjalanan, diterima, diperiksa, selesai, ditolak, atau dibatalkan.
Entri terbaru dalam statusTransitions pengembalian, berdasarkan createdAt, menunjukkan perubahannya: fromStatus, toStatus, siapa yang melakukannya, dan catatan apa pun yang ditinggalkan, seperti alasan pengembalian ditolak. Untuk membacanya, kueri pengembalian seperti yang ditunjukkan di bagian Dapatkan detail pengembalian di atas.
Acara ORDER_RETURN_COMPLETED dipicu saat pengembalian diselesaikan dan ditutup.
Menyelesaikan pengembalian juga mengirim ORDER_RETURN_STATUS_CHANGED. Jika Anda hanya perlu tahu kapan pengembalian ditutup, berlangganan ORDER_RETURN_COMPLETED saja alih-alih menangani setiap perubahan status. Jika Anda berlangganan keduanya, Anda akan menerima dua webhook saat pengembalian selesai.
ORDER_RETURN_COMPLETED tidak dikirim untuk pengembalian yang ditolak atau dibatalkan. Pengembalian tersebut berakhir hanya dengan ORDER_RETURN_STATUS_CHANGED.
1{
2"eventType":"ORDER_RETURN_COMPLETED",
3"orderReturnId":"order_return_[ID]"
4}
Catatan: Menyelesaikan pengembalian tidak pernah mengembalikan dana kepada pembeli. linkedRefunds pada pengembalian yang telah selesai mencantumkan pengembalian dana yang Anda terbitkan pada pesanan dan tautkan ke pengembalian tersebut. Ini tidak berarti Zonos yang menerbitkannya.
Jenis acara
Jenis acara webhook
Dapatkan notifikasi acara real-time untuk integrasi Zonos Anda.
Panduan ini merinci jenis acara yang dapat Zonos kirim sebagai respons webhook. Setiap tipe mengembalikan objek GraphQL spesifik yang berisi data yang relevan dengan acara tersebut.
ORDER_CREATED
Acara
ORDER_CREATEDdipicu ketika pesanan baru dibuat. Selalu mengembalikan objekOrder.{"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
Acara
ORDER_CANCELEDdipicu ketika pesanan dibatalkan. Selalu mengembalikan objekOrder.{"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
Acara
ORDER_STATUS_CHANGEDdipicu setiap kali status pesanan berubah. Selalu mengembalikan objekOrder. Status yang mungkin ditemukan pada enumOrderStatus.{"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
Acara
ORDER_RETURN_CREATEDdipicu saat pengembalian dibuat pada pesanan. Pengembalian baru dimulai dengan statusREQUESTED.Membuat pengembalian tidak sekaligus mengirim
ORDER_RETURN_STATUS_CHANGED. Setiap perubahan status setelahnya akan mengirimnya.{"eventType": "ORDER_RETURN_CREATED","orderReturnId": "order_return_[ID]"}Dapatkan detail pengembalian
Acara pengembalian hanya membawa jenis acara dan ID pengembalian. Untuk mendapatkan status, item, label, dan riwayat pengembalian, kueri dengan
orderReturn, dengan meminta kolom yang dibutuhkan integrasi Anda. Kueri ini mengembalikan objekOrderReturn.query OrderReturn($id: ID!) {orderReturn(id: $id) {idstatusorder {idaccountOrderNumber}lines {iditemIdquantityreasondispositionnote}labelSourcecarriertrackingNumberstatusTransitions {fromStatustoStatusactornotecreatedAt}updatedAt}}ORDER_RETURN_STATUS_CHANGED
Acara
ORDER_RETURN_STATUS_CHANGEDdipicu setiap kali pengembalian berpindah ke status baru: disetujui, label diterbitkan, dalam perjalanan, diterima, diperiksa, selesai, ditolak, atau dibatalkan.Entri terbaru dalam
statusTransitionspengembalian, berdasarkancreatedAt, menunjukkan perubahannya:fromStatus,toStatus, siapa yang melakukannya, dan catatan apa pun yang ditinggalkan, seperti alasan pengembalian ditolak. Untuk membacanya, kueri pengembalian seperti yang ditunjukkan di bagian Dapatkan detail pengembalian di atas.{"eventType": "ORDER_RETURN_STATUS_CHANGED","orderReturnId": "order_return_[ID]"}ORDER_RETURN_COMPLETED
Acara
ORDER_RETURN_COMPLETEDdipicu saat pengembalian diselesaikan dan ditutup.Menyelesaikan pengembalian juga mengirim
ORDER_RETURN_STATUS_CHANGED. Jika Anda hanya perlu tahu kapan pengembalian ditutup, berlanggananORDER_RETURN_COMPLETEDsaja alih-alih menangani setiap perubahan status. Jika Anda berlangganan keduanya, Anda akan menerima dua webhook saat pengembalian selesai.ORDER_RETURN_COMPLETEDtidak dikirim untuk pengembalian yang ditolak atau dibatalkan. Pengembalian tersebut berakhir hanya denganORDER_RETURN_STATUS_CHANGED.{"eventType": "ORDER_RETURN_COMPLETED","orderReturnId": "order_return_[ID]"}SHIPMENT_CANCELED
Acara
SHIPMENT_CANCELEDdipicu setiap kali pengiriman dibatalkan. Selalu mengembalikan objekShipment.{"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
Acara
SHIPMENT_CREATEDdipicu setiap kali pengiriman dibuat. Selalu mengembalikan objekShipment.{"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}}}Apakah halaman ini bermanfaat?