Định dạng yêu cầu HTTPS cho API Checkout là gì?

Yêu cầu HTTPS cho API Checkout bao gồm phương thức HTTP (POST), endpoint, giao thức (HTTPS), định dạng tin nhắn (JSON), và HTTP headers (Accept: application/json, Content-Type: application/json).

Các cặp khóa/giá trị JSON trong phần body của yêu cầu cho API Checkout là gì?

Các cặp khóa/giá trị JSON trong phần body của yêu cầu cho API Checkout bao gồm các tham số như "store", "secret", "sinceOrderId", "sinceDate", "throughDate", "missingMerchantOrderId", và "statuses".

Định dạng phản hồi HTTPS cho API Checkout là gì?

Phản hồi HTTPS cho API Checkout ở định dạng JSON. Nó bao gồm các tham số như "totalCount", "orderCount", "testOrderCount", "orders", và "error" (nếu có).

Các phản hồi lỗi HTTP có thể có cho API Checkout là gì?

Các phản hồi lỗi HTTP có thể có cho API Checkout bao gồm 406 (Not Acceptable), 415 (Unsupported media type), và 200 với các thông báo lỗi khác nhau.

Checkout•

Trang chủTài liệu tham khảo API Checkout REST API Số đơn hàng

Số đơn hàng

Q: API Checkout là gì?

API Checkout được sử dụng để lấy an toàn danh sách các số đơn hàng được hoàn thành thông qua Zonos Checkout. Nó thường được sử dụng để kiểm tra đơn hàng nhằm đảm bảo tất cả các đơn hàng được nhập theo ngày hoặc orderID cũng như các đơn hàng trong khoảng thời gian.

Tìm hiểu cách Endpoint số đơn hàng hoạt động.

Endpoint orderNumbers được sử dụng để lấy an toàn danh sách các số đơn hàng được hoàn thành thông qua Zonos Checkout. Nó thường được sử dụng để kiểm tra đơn hàng nhằm đảm bảo tất cả các đơn hàng được nhập theo ngày hoặc orderID cũng như các đơn hàng trong khoảng thời gian.

Endpoint

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

HTTPS request

Trường↕	Ghi chú↕
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

JSON key/value trong phần body của yêu cầu

Định dạng tin nhắn: JSON

1{

2 "store": "999",

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

4 "sinceOrderId": "999-99999"

5}

Định nghĩa JSON yêu cầu

trường↕	ghi chú↕
`missingMerchantOrderId` TÙY CHỌN, nếu truyền lựa chọn tham số khác	Tham số này được sử dụng để truy vấn một tập các đơn hàng trong hai tuần qua không có `merchantOrderId`. Khi `merchantOrderId` được gửi qua Endpoint API `updateMerchantOrderID`, các đơn hàng sẽ không còn xuất hiện trong truy vấn này.`boolean: true/false`
`secret` BẮT BUỘC	API secret GUID được cung cấp bởi Zonos. `string`
`sinceDate` TÙY CHỌN, nếu truyền tham số `sinceOrderId`.	Tham số này được sử dụng để truy vấn một tập các đơn hàng sau một ngày cụ thể.`sinceDate` và `sinceOrderId` không thể được gửi cả hai.`string` - ngày UTC/GMT; định dạng: `yyyymmdd`
`sinceOrderId` TÙY CHỌN, nếu truyền tham số `sinceDate` / `throughDate`	ID đơn hàng Zonos, có thể được truyền có hoặc không có ID cửa hàng và dấu gạch ngang của bạn (Ví dụ: 123-45678 hoặc 45678).Lưu ý: Tham số này sẽ được sử dụng để truy vấn một tập các đơn hàng sau một đơn hàng Zonos cụ thể. `sinceDate` và `sinceOrderId` không thể được gửi cả hai.`integer / string`
`statuses` TÙY CHỌN	Tham số này được sử dụng để bao gồm trạng thái đơn hàng hiện tại và `merchantOrderId` trong phản hồi. Nếu nó có trên yêu cầu, bất kể giá trị, nó sẽ bao gồm các trạng thái.`boolean: true`
`store` BẮT BUỘC	Store ID được cung cấp bởi Zonos.`integer`
`throughDate` TÙY CHỌN	Tham số này được sử dụng để truy vấn một tập các đơn hàng trong một khoảng thời gian cụ thể.Phải được truyền cùng với tham số `sinceDate`.`string` - ngày UTC/GMT; định dạng: `yyyymmdd`

HTTPS response

Định dạng tin nhắn: 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}

Phản hồi lỗi HTTP

Lỗi↕	Ý nghĩa↕
406 - Not Acceptable	HTML Entity. HTTP "Accept" header là không hợp lệ.
415 - Unsupported media type	HTML Entity. HTTP "Content-Type" header là không hợp lệ.
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"

Định nghĩa JSON phản hồi

trường↕	ghi chú↕
`error`	Tham số này sẽ chỉ xuất hiện trong phản hồi khi đã xảy ra lỗi và sẽ chứa mô tả nguyên nhân.`string`
`orderCount`	Tổng số đơn hàng trực tiếp được lấy.`integer`
`order.testOrderCount`	Tổng số đơn hàng thử nghiệm được lấy.`integer`
`orders`	Danh sách các đối tượng đơn hàng.`string`
`orders[index].id`	ID đơn hàng Zonos đầy đủ bao gồm ID cửa hàng và dấu gạch ngang.`string`
`orders[index].merchantOrderId`	`MerchantOrderId` được liên kết với đơn hàng thông qua endpoint dịch vụ API `updateMerchantOrderId`.`string`
`orders[index].orderStatus`	Trạng thái đơn hàng hiện tại cho các giá trị có thể.`string`
`orders[index].orderStatusDate`	Epoch đại diện cho thời điểm trạng thái được cập nhật lần cuối.`integer`
`orders[index].orderStatusDateString`	Dấu thời gian đại diện cho thời điểm trạng thái được cập nhật lần cuối theo UTC/GMT.`timestamp`
`orders[index].testOrder`	Cho biết liệu đơn hàng là "đơn hàng thử nghiệm" hay "đơn hàng trực tiếp".`boolean`
`orders[index].timestamp`	Dấu thời gian đại diện cho thời điểm đơn hàng được đặt theo UTC/GMT.`timestamp`
`totalCount`	Tổng số cả đơn hàng trực tiếp và thử nghiệm được lấy.`integer`

Đặt lịch demo