Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Permintaan HTTPS
| Field | Catatan |
|---|---|
| Metode HTTP | POST |
| URL Endpoint | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protokol | HTTPS |
| Format pesan | JSON |
| Header HTTP Accept | Accept: application/json |
| Header HTTP Content-Type | Content-Type: application/json |
Pasangan kunci/nilai JSON dalam tubuh permintaan
Contoh
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Permintaan definisi JSON
| Field | Catatan |
|---|---|
merchantOrderId DIWAJIBKAN | Parameter ini digunakan untuk mengirimkan ID pesanan internal toko Anda ke pesanan dalam sistem Zonos. Ini disarankan untuk rekonsiliasi, komunikasi, dan audit yang lebih baik.string |
orderId DIWAJIBKAN | ID pesanan Zonos - dapat dikirimkan dengan atau tanpa ID toko Anda dan tanda hubung (Contoh: 123-45678 atau 45678). Catatan: Setelah penyelesaian pesanan dan pembayaran, pelanggan akan diarahkan ke halaman Penyelesaian Pesanan / Terima Kasih Pesanan yang dihosting di domain Anda. URL akan berisi parameter querystring “orderId” yang akan berisi nilai ini.integer / string |
secret DIWAJIBKAN | GUID rahasia API yang diberikan oleh Zonos.string |
store DIWAJIBKAN | ID toko yang diberikan oleh Zonosinteger |
Respons HTTPS
Contoh respons sukses
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Contoh respons kesalahan
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Respon kesalahan HTTP
| Kode kesalahan | Definisi |
|---|---|
| 406 - Tidak Diterima | Entitas HTML. Header HTTP “Accept” tidak valid. |
| 415 - Tipe media tidak didukung | Entitas HTML. Header HTTP “Content-Type” tidak valid. |
| 200 | “error”:”tidak dapat mengurai input” |
| 200 | “error”:”Parameter orderId diperlukan untuk processUpdateMerchantOrderId” |
| 200 | “error”:”Parameter merchantOrderId diperlukan untuk updateMerchantOrderId.” |
| 200 | “error”:”orderId: 999-99999 bukan orderId yang valid” |
| 200 | “error”:”Tidak dapat mengambil pesanan untuk updateMerchantOrderId untuk orderId: 999-99999” |
| 200 | “error”:”Tidak dapat memproses pembaruan id pesanan pedagang.” |
| 200 | “error”:”Kredensial keamanan tidak valid” |
Definisi JSON Respon
| Pesan | Definisi |
|---|---|
error | Parameter ini hanya akan ada dalam respon ketika terjadi kesalahan dan akan berisi deskripsi penyebabnya.string |
success | Parameter ini akan berisi ringkasan dari pembaruan.string |
Perbarui nomor pesanan
Pelajari cara kerja endpoint untuk memperbarui nomor pesanan.
Endpoint
updateMerchantOrderIddigunakan untuk memperbarui pesanan dalam sistem Zonos dengan id pesanan toko Anda untuk rekonsiliasi, komunikasi, dan audit yang lebih baik.