Điểm cuối
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Yêu cầu HTTPS
| Trường | Ghi chú |
|---|---|
| Phương thức HTTP | POST |
| URL điểm cuối | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Giao thức | HTTPS |
| Định dạng tin nhắn | JSON |
| Tiêu đề HTTP Accept | Accept: application/json |
| Tiêu đề HTTP Content-Type | Content-Type: application/json |
Các cặp khóa/giá trị JSON trong thân yêu cầu
Ví dụ
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Định nghĩa JSON yêu cầu
| Trường | Ghi chú |
|---|---|
merchantOrderId BẮT BUỘC | Tham số này được sử dụng để truyền ID đơn hàng nội bộ của cửa hàng bạn vào đơn hàng trong hệ thống Zonos. Điều này được khuyến nghị để cải thiện việc đối chiếu, giao tiếp và kiểm toán.string |
orderId BẮT BUỘC | ID đơn hàng Zonos - có thể được truyền với hoặc không có ID cửa hàng và dấu gạch ngang (Ví dụ: 123-45678 hoặc 45678). Lưu ý: Sau khi hoàn thành đơn hàng và thanh toán, khách hàng sẽ được chuyển hướng đến trang Hoàn thành Đơn hàng / Cảm ơn Đơn hàng được lưu trữ trên miền của bạn. URL sẽ chứa tham số chuỗi truy vấn “orderId” sẽ chứa giá trị này.integer / string |
secret BẮT BUỘC | GUID bí mật API được cung cấp bởi Zonos.string |
store BẮT BUỘC | ID cửa hàng được cung cấp bởi Zonosinteger |
Phản hồi HTTPS
Ví dụ phản hồi thành công
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Ví dụ phản hồi lỗi
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Phản hồi lỗi HTTP
| Mã lỗi | Định 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": "Tham số orderId là bắt buộc để xử lý Cập nhật Mã đơn hàng Thương gia" |
| 200 | "error": "Tham số merchantOrderId là bắt buộc để cập nhật Mã đơn hàng Thương gia." |
| 200 | "error": "orderId: 999-99999 không phải là orderId hợp lệ" |
| 200 | "error": "Không thể truy xuất đơn hàng để cập nhật Mã đơn hàng Thương gia cho orderId: 999-99999" |
| 200 | "error": "Không thể xử lý cập nhật mã đơn hàng thương gia." |
| 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
| Thông điệp | Định nghĩa |
|---|---|
error | Tham số này chỉ xuất hiện trong phản hồi khi có lỗi xảy ra và sẽ chứa mô tả nguyên nhân.string |
success | Tham số này sẽ chứa một tóm tắt về cập nhật.string |
Cập nhật số đơn hàng
Tìm hiểu cách hoạt động của điểm cuối để cập nhật số đơn hàng.
Điểm cuối
updateMerchantOrderIdđược sử dụng để cập nhật một đơn hàng trong hệ thống Zonos với mã đơn hàng của cửa hàng bạn để cải thiện việc đối chiếu, giao tiếp và kiểm toán.