Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
Permintaan HTTPS
| Field | Catatan |
|---|---|
| Metode HTTP | POST |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protokol | HTTPS |
| Format pesan | JSON |
| Header HTTP Accept | Accept: application/json |
| Header HTTP Content-Type | Content-Type: application/json |
Kunci/nilai JSON dalam body permintaan
Format pesan: JSON
CONTOH PERMINTAAN: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
CONTOH PERMINTAAN: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
CONTOH PERMINTAAN: sejakTanggal, hinggaTanggal
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
CONTOH PERMINTAAN: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
CONTOH PERMINTAAN: status
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Definisi JSON Permintaan
| field | notes |
|---|---|
missingMerchantOrderId OPSIONAL, jika mengirim parameter opsi lain | Parameter ini digunakan untuk menanyakan sekumpulan pesanan dalam dua minggu terakhir yang tidak memiliki merchantOrderId. Ketika merchantOrderId dikirim melalui endpoint API updateMerchantOrderID, pesanan tidak akan lagi muncul dalam kueri ini.boolean: true/false |
secret DIWAJIBKAN | GUID rahasia API yang diberikan oleh Zonos. string |
sinceDate OPSIONAL, jika mengirim parameter sinceOrderId. | Parameter ini digunakan untuk menanyakan sekumpulan pesanan setelah tanggal tertentu.sinceDate dan sinceOrderId tidak dapat dikirim bersamaan.string - tanggal UTC/GMT; format: yyyymmdd |
sinceOrderId OPSIONAL, jika mengirim parameter sinceDate / throughDate | ID pesanan Zonos, dapat dikirim dengan atau tanpa ID toko dan tanda hubung (Contoh: 123-45678 atau 45678). Catatan: Parameter ini akan digunakan untuk menanyakan sekumpulan pesanan setelah ID pesanan Zonos tertentu. sinceDate dan sinceOrderId tidak dapat dikirim bersamaan.integer / string |
statuses OPSIONAL | Parameter ini digunakan untuk menyertakan status pesanan saat ini dan merchantOrderId dalam respons. Jika ada dalam permintaan, terlepas dari nilainya, status akan disertakan.boolean: true |
store DIWAJIBKAN | ID toko yang diberikan oleh Zonos.integer |
throughDate OPSIONAL | Parameter ini digunakan untuk menanyakan sekumpulan pesanan antara rentang tanggal tertentu. Harus dikirim bersama dengan parameter sinceDate .string - tanggal UTC/GMT; format: yyyymmdd |
Respons HTTPS
Format pesan: JSON
CONTOH RESPONS BERHASIL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"totalCount": 6,
"orderCount": 5,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0"
},
{
"testOrder": false,
"id": "999-99993",
"timestamp": "2015-01-01 14:50:54.0"
},
{
"testOrder": false,
"id": "999-99994",
"timestamp": "2015-01-02 20:14:01.0"
},
{
"testOrder": false,
"id": "999-99995",
"timestamp": "2015-01-02 20:57:47.0"
},
{
"testOrder": false,
"id": "999-99996",
"timestamp": "2015-01-02 22:11:40.0"
}
]
}
Contoh respons sukses dengan parameter 'statuses'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
Contoh respons kesalahan
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Respon kesalahan HTTP
| Kesalahan | Arti |
|---|---|
| 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”:”orderId: 999-99999 bukan orderId yang valid” |
| 200 | “error”:”Parameter orderId atau referenceId diperlukan.” |
| 200 | “error”:”Tidak dapat menentukan kedua Parameter orderId dan referenceId.” |
| 200 | “error”:”Tidak dapat memproses detail pesanan.” |
| 200 | “error”:”Kredensial keamanan tidak valid” |
Definisi JSON respons
| field | catatan |
|---|---|
error | Parameter ini hanya akan ada dalam respons ketika terjadi kesalahan dan akan berisi deskripsi penyebabnya.string |
orderCount | Total jumlah pesanan aktif yang diambil.integer |
order.testOrderCount | Total jumlah pesanan uji yang diambil.integer |
orders | Daftar peta pesanan.string |
orders[index].id | ID Pesanan Zonos lengkap termasuk id toko dan dash.string |
orders[index].merchantOrderId | MerchantOrderId yang terkait dengan pesanan melalui endpoint layanan API updateMerchantOrderId .string |
orders[index].orderStatus | Status pesanan saat ini untuk nilai yang mungkin.string |
orders[index].orderStatusDate | Epoch yang mewakili kapan status terakhir diperbarui.integer |
orders[index].orderStatusDateString | Timestamp yang mewakili kapan status terakhir diperbarui dalam UTC/GMT.timestamp |
orders[index].testOrder | Menunjukkan apakah pesanan adalah “pesanan uji” atau “pesanan aktif”.boolean |
orders[index].timestamp | Timestamp yang mewakili kapan pesanan ditempatkan dalam UTC/GMT.timestamp |
totalCount | Total jumlah pesanan aktif dan uji yang diambil.integer |
Nomor pesanan
Pelajari cara kerja endpoint Nomor pesanan.Endpoint
orderNumbersdigunakan untuk mengamankan pengambilan daftar nomor pesanan yang diselesaikan melalui Zonos Checkout. Ini biasanya digunakan untuk rekonsiliasi pesanan untuk memastikan semua pesanan diimpor per tanggal atau orderID serta pesanan antara rentang tanggal.