Điểm cuối
POST | https://api.iglobalstores.com/v1/orderNumbers
Yêu cầu HTTPS
| Trường | Ghi chú |
|---|---|
| Phương thức HTTP | POST |
| Điểm cuối | https://api.iglobalstores.com/v1/orderNumbers |
| Giao thức | HTTPS |
| Định dạng tin nhắn | JSON |
| Tiêu đề HTTP chấp nhận | Accept: application/json |
| Tiêu đề HTTP Content-Type | Content-Type: application/json |
Khóa/giá trị JSON trong thân yêu cầu
Định dạng tin nhắn: JSON
VÍ DỤ YÊU CẦU: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
YÊU CẦU VÍ DỤ: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
YÊU CẦU VÍ DỤ: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
YÊU CẦU VÍ DỤ: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
YÊU CẦU VÍ DỤ: trạng thái
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Định nghĩa JSON yêu cầu
| trường | ghi chú |
|---|---|
missingMerchantOrderId TÙY CHỌN, nếu truyền tham số khác | Tham số này được sử dụng để truy vấn một tập hợp các đơn hàng trong vòng hai tuần qua mà thiếu merchantOrderId. Khi merchantOrderId được gửi qua điểm cuối 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 | GUID bí mật API đượ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 hợp các đơn hàng sau một ngày cụ thể.sinceDate và sinceOrderId không thể được gửi cùng nhau.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 gửi kèm hoặc không kèm theo ID cửa hàng và dấu gạch ngang (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 hợ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ùng nhau.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ó mặt trong 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 | ID cửa hàng đượ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 hợp các đơn hàng trong khoảng thời gian cụ thể.Cần được gửi kèm với tham số sinceDate .string - ngày UTC/GMT; định dạng: yyyymmdd |
Phản hồi HTTPS
Định dạng thông điệp: JSON
VÍ DỤ PHẢN HỒI THÀNH CÔNG
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"
}
]
}
Ví dụ phản hồi thành công với tham số '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"
}
]
}
Ví dụ phản hồi lỗi
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Phản hồi lỗi HTTP
| Lỗi | Ý nghĩa |
|---|---|
| 406 - Không chấp nhận | Thực thể HTML. Tiêu đề HTTP “Accept” không hợp lệ. |
| 415 - Loại phương tiện không được hỗ trợ | Thực thể HTML. Tiêu đề HTTP “Content-Type” không hợp lệ. |
| 200 | “error”:”không thể phân tích đầu vào” |
| 200 | “error”:”orderId: 999-99999 không phải là một orderId hợp lệ” |
| 200 | “error”:”Tham số orderId hoặc referenceId là bắt buộc.” |
| 200 | “error”:”Không thể chỉ định cả hai tham số orderId và referenceId.” |
| 200 | “error”:”Không thể xử lý chi tiết đơn hàng.” |
| 200 | “error”:”Thông tin xác thực bảo mật không hợp lệ” |
Định nghĩa JSON phản hồi
| trường | ghi chú |
|---|---|
error | Tham số này chỉ có mặt trong phản hồi khi có lỗi xảy ra và sẽ chứa mô tả về nguyên nhân.string |
orderCount | Tổng số đơn hàng đang hoạt động được truy xuất.integer |
order.testOrderCount | Tổng số đơn hàng thử nghiệm được truy xuất.integer |
orders | Danh sách các bản đồ đơn hàng.string |
orders[index].id | Toàn bộ Zonos Order Id bao gồm id cửa hàng và dấu gạch ngang.string |
orders[index].merchantOrderId | MerchantOrderId liên kết với đơn hàng thông qua điểm cuối 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 | Thời gian 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 | Chỉ ra liệu đơn hàng có phải là “đơn hàng thử nghiệm” hay “đơn hàng thực tế”.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 thực tế và đơn hàng thử nghiệm được truy xuất.integer |
Số đơn hàng
Tìm hiểu cách hoạt động của điểm cuối Số đơn hàng.Điểm cuối
orderNumbersđược sử dụng để lấy một cách an toàn danh sách các số đơn hàng đã hoàn thành thông qua Zonos Checkout. Nó thường được sử dụng cho việc đối chiếu đơn hàng để đảm bảo rằng tất cả các đơn hàng đã được nhập tính đến một ngày hoặc orderID cũng như các đơn hàng trong khoảng thời gian.