DOCS

Update order status

/

Cập nhật trạng thái đơn hàng

Tìm hiểu cách hoạt động của điểm cuối để cập nhật trạng thái đơn hàng.

Điểm cuối updateVendorOrderStatus được sử dụng để cập nhật trạng thái đơn hàng của một đơn hàng trong hệ thống Zonos. Điều này sẽ được sử dụng để cập nhật trạng thái vận chuyển của đơn hàng một cách lập trình hoặc để yêu cầu hủy đơn hàng.

Giá trị trạng thái đơn hàng hiện tại 

Dưới đây là danh sách hiện tại các trạng thái đơn hàng mà một đơn hàng có thể có.

Cảnh báo - Zonos có thể thêm nhiều trạng thái hơn bất kỳ lúc nào; hệ thống của bạn nên có khả năng tiếp nhận sự hiện diện của các trạng thái bổ sung.

Các trạng thái trong sản xuất sẽ vẫn ở trong sản xuất. Zonos sẽ không bao giờ xóa các trạng thái hiện có.

Trạng tháiMô tảCó thể thiết lập bởi
IGLOBAL_FRAUD_REVIEWĐơn hàng hiện đang được xem xét gian lận bởi iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSĐơn hàng hợp lệ và sẵn sàng để xử lý.Zonos
IGLOBAL_ORDER_ON_HOLDĐơn hàng hiện đang trong trạng thái tạm thời bị giữ.Zonos
IGLOBAL_ORDER_CANCELLEDĐơn hàng đã bị hủy trong hệ thống iGlobal.Zonos
VENDOR_PREPARING_ORDERNhà cung cấp đã đánh dấu đơn hàng đang chuẩn bị.Nhà cung cấp
VENDOR_SHIPMENT_READYNhà cung cấp đã đánh dấu đơn hàng sẵn sàng để vận chuyển.Nhà cung cấp
VENDOR_LABELS_PRINTED_DATENhà cung cấp đã in nhãn vận chuyển.Nhà cung cấp
VENDOR_CANCELLATION_REQUESTĐơn hàng đã được yêu cầu hủy.Nhà cung cấp
VENDOR_END_OF_DAY_COMPLETEĐơn hàng đã được hoàn tất và hoàn thành.Nhà cung cấp

vendorOrderStatus không thể được cập nhật bởi nhà cung cấp trong khi đơn hàng đang ở một trong các trạng thái đơn hàng sau:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Yêu cầu HTTPS

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

TrườngGiá trị
Phương thức HTTPPOST
URL điểm cuốihttps://api.iglobalstores.com/v1/updateVendorOrderStatus
Giao thứcHTTPS
Định dạng tin nhắnJSON
Tiêu đề HTTP chấp nhậnAccept: application/json
Tiêu đề HTTP Content-TypeContent-Type: application/json

Các cặp khóa/giá trị JSON trong thân yêu cầu

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

VÍ DỤ

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

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

TrườngGhi chú
orderId BẮT BUỘCID đơ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 nối (Ví dụ: 123-45678 hoặc 45678). Sau khi hoàn tất đơn hàng và thanh toán, khách hàng sẽ được chuyển hướng đến trang hoàn tất đơn hàng / trang 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
orderStatus BẮT BUỘCTrường này được sử dụng để cập nhật hệ thống Zonos với trạng thái mới của một đơn hàng. Các trạng thái đơn hàng sau đây có thể được thiết lập qua API này.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``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

Định dạng thông điệp: JSON

Ví dụ phản hồi thành công

1
2
3
{
  "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}

Ví dụ phản hồi lỗi

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

Phản hồi lỗi HTTP

Mã Phản hồi HTTPVí dụ/Nội dung Phản hồi
406 - Không chấp nhậnThự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 cần thiết cho updateVendorOrderStatus"
200"error": "Tham số orderStatus cần thiết cho updateVendorOrderStatus."
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 để updateVendorOrderStatus từ orderId: 999-99999"
200"error": "OrderId: 999-99999 đã bị hủy và không thể cập nhật trạng thái."
200"error": "Không thể cập nhật trạng thái đơn hàng thành trạng thái: VENDOR_CANCELLATION_REQUEST"
200"error": "Không thể cập nhật trạng thái đơn hàng thành trạng thái không hợp lệ: NEW_ORDER_STATUS"
200"error": "OrderId: 999-99999 đã có trạng thái hiện tại: VENDOR_SHIPMENT_READY"
200"error": "OrderId: 999-99999 không thể chuyển sang trạng thái đơn hàng: VENDOR_CANCELLATION_REQUEST khi đang ở trạng thái: VENDOR_END_OF_DAY_COMPLETE"
200"error": "Trạng thái mới: NEW_ORDER_STATUS không phải là trạng thái đơn hàng hợp lệ"
200"error": "Không thể xử lý updateVendorOrderStatus."
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
successTham số này sẽ chứa một tóm tắt về cập nhật.string
errorTham 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ả về nguyên nhân.string

Trang này có hữu ích không?