DOCS

Update order status

/

Perbarui status pesanan

Pelajari cara kerja endpoint untuk memperbarui status pesanan.

Endpoint updateVendorOrderStatus digunakan untuk memperbarui status pesanan dari sebuah pesanan di dalam Sistem Zonos. Ini akan digunakan untuk memperbarui status pengiriman pesanan secara programatis atau untuk meminta pembatalan.

Nilai status pesanan saat ini 

Berikut adalah daftar status pesanan saat ini yang mungkin dimiliki oleh sebuah pesanan.

Perhatian - Zonos dapat menambahkan lebih banyak status kapan saja; sistem Anda harus dapat mengakomodasi keberadaan status tambahan.

Status yang ada di produksi akan tetap ada di produksi. Zonos tidak akan pernah menghapus status yang ada.

StatusDeskripsiDapat diatur oleh
IGLOBAL_FRAUD_REVIEWPesanan saat ini sedang dalam tinjauan penipuan oleh iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSPesanan valid dan siap untuk diproses.Zonos
IGLOBAL_ORDER_ON_HOLDPesanan saat ini dalam status tahan sementara.Zonos
IGLOBAL_ORDER_CANCELLEDPesanan telah dibatalkan dalam Sistem iGlobal.Zonos
VENDOR_PREPARING_ORDERVendor telah menandai pesanan dalam persiapan.Vendor
VENDOR_SHIPMENT_READYVendor telah menandai pesanan siap untuk pengiriman.Vendor
VENDOR_LABELS_PRINTED_DATEVendor telah mencetak label pengiriman.Vendor
VENDOR_CANCELLATION_REQUESTPesanan telah diminta untuk dibatalkan.Vendor
VENDOR_END_OF_DAY_COMPLETEPesanan telah diselesaikan dan lengkap.Vendor

vendorOrderStatus tidak dapat diperbarui oleh vendor sementara pesanan berada dalam salah satu status pesanan berikut:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Permintaan HTTPS

POST | https://api.iglobalstores.com/v1/updateVendorOrderStatus

FieldValue
Metode HTTPPOST
URL Endpointhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtokolHTTPS
Format pesanJSON
Header HTTP AcceptAccept: application/json
Header HTTP Content-TypeContent-Type: application/json

Pasangan kunci/nilai JSON dalam body permintaan

Format pesan: JSON

CONTOH

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

Permintaan definisi JSON

FieldCatatan
orderId DIWAJIBKANID pesanan Zonos dapat diteruskan dengan atau tanpa ID toko dan tanda hubung (Contoh: 123-45678 atau 45678). Setelah penyelesaian dan pembayaran pesanan, pelanggan akan diarahkan ke halaman penyelesaian pesanan / halaman terima kasih pesanan yang dihosting di domain Anda. URL akan berisi parameter querystring orderID yang akan berisi nilai ini.integer / string
orderStatus DIWAJIBKANBidang ini digunakan untuk memperbarui sistem Zonos dengan status baru dari sebuah pesanan. Status pesanan berikut dapat diatur melalui API ini.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret DIWAJIBKAN | GUID rahasia API yang diberikan oleh Zonos.string | | store DIWAJIBKAN | ID toko yang diberikan oleh Zonosinteger |

Respons HTTPS

Format pesan: JSON

Contoh respons sukses

1
2
3
{
  "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}

Contoh respons kesalahan

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

Respon Kesalahan HTTP

Kode Respon HTTPContoh Deskripsi/Tubuh Respon
406 - Tidak DiterimaEntitas HTML. Header HTTP “Accept” tidak valid.
415 - Tipe media tidak didukungEntitas HTML. Header HTTP “Content-Type” tidak valid.
200“error”:“tidak dapat mengurai input”
200“error”:“Parameter orderId diperlukan untuk updateVendorOrderStatus”
200“error”:“Parameter orderStatus diperlukan untuk updateVendorOrderStatus.”
200“error”:“orderId: 999-99999 bukan orderId yang valid”
200“error”:“Tidak dapat mengambil pesanan untuk updateVendorOrderStatus dari orderId: 999-99999”
200“error”:“OrderId: 999-99999 sudah dibatalkan dan status tidak dapat diperbarui.”
200“error”:“Tidak dapat memperbarui status pesanan menjadi status: VENDOR_CANCELLATION_REQUEST”
200“error”:“Tidak dapat memperbarui status pesanan menjadi status tidak valid: NEW_ORDER_STATUS”
200“error”:“OrderId: 999-99999 sudah memiliki status saat ini: VENDOR_SHIPMENT_READY”
200“error”:“OrderId: 999-99999 tidak dapat dipindahkan ke status pesanan: VENDOR_CANCELLATION_REQUEST saat dalam status: VENDOR_END_OF_DAY_COMPLETE”
200“error”:“Status Baru: NEW_ORDER_STATUS bukan status pesanan yang valid”
200“error”:“Tidak dapat memproses updateVendorOrderStatus.”
200“error”:“Kredensial keamanan tidak valid”

Definisi JSON Respon

PesanDefinisi
successParameter ini akan berisi ringkasan dari pembaruan.string
errorParameter ini hanya akan ada dalam respon ketika terjadi kesalahan dan akan berisi deskripsi penyebabnya.string

Apakah halaman ini membantu?