Apa format permintaan HTTPS untuk Checkout API?

Permintaan HTTPS untuk Checkout API mencakup metode HTTP (POST), titik akhir, protokol (HTTPS), format pesan (JSON), dan header HTTP (Accept: application/json, Content-Type: application/json).

Apa sajakah pasangan kunci/nilai JSON dalam isi permintaan untuk Checkout API?

Pasangan kunci/nilai JSON dalam isi permintaan untuk Checkout API mencakup parameter seperti 'store', 'secret', 'sinceOrderId', 'sinceDate', 'throughDate', 'missingMerchantOrderId', dan 'statuses'.

Apa format respons HTTPS untuk Checkout API?

Respons HTTPS untuk Checkout API dalam format JSON. Mencakup parameter seperti 'totalCount', 'orderCount', 'testOrderCount', 'orders', dan 'error' (jika ada).

Apa sajakah respons HTTP error yang mungkin untuk Checkout API?

Kemungkinan respons HTTP error untuk Checkout API mencakup 406 (Not Acceptable), 415 (Unsupported media type), dan 200 dengan berbagai pesan error.

Checkout•

BerandaReferensi API API REST Checkout Nomor pesanan

Nomor pesanan

Q: Apa itu Checkout API?

Checkout API digunakan untuk mengambil daftar nomor pesanan yang selesai melalui Zonos Checkout dengan aman. Biasanya digunakan untuk rekonsiliasi pesanan guna memastikan semua pesanan diimpor per tanggal atau orderID serta pesanan dalam rentang tanggal.

Pelajari cara kerja titik akhir Nomor pesanan.

Titik akhir orderNumbers digunakan untuk mengambil daftar nomor pesanan yang selesai melalui Zonos Checkout dengan aman. Biasanya digunakan untuk rekonsiliasi pesanan guna memastikan semua pesanan diimpor per tanggal atau orderID serta pesanan dalam rentang tanggal.

Titik akhir

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

Permintaan HTTPS

Field↕	Notes↕
HTTP method	POST
Endpoint	`https://api.iglobalstores.com/v1/orderNumbers`
Protocol	HTTPS
Message format	JSON
Accept HTTP header	Accept: application/json
Content-Type HTTP header	Content-Type: application/json

Pasangan kunci/nilai JSON dalam isi permintaan

Format pesan: JSON

1{

2 "store": "999",

3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",

4 "sinceOrderId": "999-99999"

5}

Definisi JSON permintaan

field↕	notes↕
`missingMerchantOrderId` OPTIONAL, if passing another parameter option	Parameter ini digunakan untuk menanyakan serangkaian pesanan dalam dua minggu terakhir yang tidak memiliki `merchantOrderId`. Ketika `merchantOrderId` dikirimkan melalui titik akhir API `updateMerchantOrderID`, pesanan tidak akan lagi muncul dalam kueri ini.`boolean: true/false`
`secret` REQUIRED	Kunci keamanan API GUID yang disediakan oleh Zonos. `string`
`sinceDate` OPTIONAL, if passing `sinceOrderId` parameter.	Parameter ini digunakan untuk menanyakan serangkaian pesanan setelah tanggal tertentu.`sinceDate` dan `sinceOrderId` tidak dapat dikirim keduanya.`string` - tanggal UTC/GMT; format: `yyyymmdd`
`sinceOrderId` OPTIONAL, if passing `sinceDate` / `throughDate` parameter	ID pesanan Zonos, dapat dikirim dengan atau tanpa ID toko dan tanda hubung Anda (Contoh: 123-45678 atau 45678).Catatan: Parameter ini akan digunakan untuk menanyakan serangkaian pesanan setelah pesanan Zonos tertentu. `sinceDate` dan `sinceOrderId` tidak dapat dikirim keduanya.`integer / string`
`statuses` OPTIONAL	Parameter ini digunakan untuk menyertakan status pesanan saat ini dan `merchantOrderId` dalam respons. Jika ada dalam permintaan, terlepas dari nilainya, ini akan menyertakan statusnya.`boolean: true`
`store` REQUIRED	ID Toko yang disediakan oleh Zonos.`integer`
`throughDate` OPTIONAL	Parameter ini digunakan untuk menanyakan serangkaian pesanan antara rentang tanggal tertentu.Harus dikirim bersama parameter `sinceDate`.`string` - tanggal UTC/GMT; format: `yyyymmdd`

Respons HTTPS

Format pesan: JSON

1{

2 "totalCount": 6,

3 "orderCount": 5,

4 "testOrderCount": 1,

5 "orders": [

6 {

7 "testOrder": false,

8 "id": "999-99991",

9 "timestamp": "2015-01-01 00:33:14.0"

10 },

11 {

12 "testOrder": true,

13 "id": "999-99992",

14 "timestamp": "2015-01-01 05:12:46.0"

15 },

16 {

17 "testOrder": false,

18 "id": "999-99993",

19 "timestamp": "2015-01-01 14:50:54.0"

20 },

21 {

22 "testOrder": false,

23 "id": "999-99994",

24 "timestamp": "2015-01-02 20:14:01.0"

25 },

26 {

27 "testOrder": false,

28 "id": "999-99995",

29 "timestamp": "2015-01-02 20:57:47.0"

30 },

31 {

32 "testOrder": false,

33 "id": "999-99996",

34 "timestamp": "2015-01-02 22:11:40.0"

35 }

36 ]

37}

Respons HTTP error

Error↕	Meaning↕
406 - Not Acceptable	HTML Entity. Header HTTP "Accept" tidak valid.
415 - Unsupported media type	HTML Entity. Header HTTP "Content-Type" tidak valid.
200	"error":"could not parse input"
200	"error":"orderId: 999-99999 is not a valid orderId"
200	"error":"Parameter orderId or referenceId is required."
200	"error":"Cannot specify both Parameters orderId and referenceId."
200	"error":"Could not process order details."
200	"error":"Invalid security credentials"

Definisi JSON respons

field↕	notes↕
`error`	Parameter ini hanya akan ada dalam respons ketika terjadi kesalahan dan akan berisi deskripsi penyebabnya.`string`
`orderCount`	Jumlah total pesanan aktif yang diambil.`integer`
`order.testOrderCount`	Jumlah total pesanan pengujian yang diambil.`integer`
`orders`	Daftar peta pesanan.`string`
`orders[index].id`	ID Pesanan Zonos lengkap termasuk ID toko dan tanda hubung.`string`
`orders[index].merchantOrderId`	`MerchantOrderId` yang terkait dengan pesanan melalui titik akhir layanan API `updateMerchantOrderId`.`string`
`orders[index].orderStatus`	Status pesanan saat ini untuk nilai yang mungkin.`string`
`orders[index].orderStatusDate`	Epoch yang mewakili ketika status terakhir diperbarui.`integer`
`orders[index].orderStatusDateString`	Stempel waktu yang mewakili ketika status terakhir diperbarui dalam UTC/GMT.`timestamp`
`orders[index].testOrder`	Menunjukkan apakah pesanan adalah "pesanan pengujian" atau "pesanan aktif".`boolean`
`orders[index].timestamp`	Stempel waktu yang mewakili kapan pesanan ditempatkan dalam UTC/GMT.`timestamp`
`totalCount`	Jumlah total pesanan aktif dan pengujian yang diambil.`integer`

Pesan demo