Trang chủCho các nhà cung cấp logistics Lỗi API

Lỗi API

Hiểu và giải quyết các lỗi được trả về bởi Zonos GraphQL API.

GraphQL

Zonos API trả về hai loại lỗi: mã trạng thái HTTP cho các lỗi ở mức vận chuyển, và lỗi GraphQL cho các vấn đề ở mức ứng dụng. Hầu hết các lỗi là lỗi GraphQL bao gồm một phân loại trong trường extensions để giúp xác định nguyên nhân và giải pháp phù hợp.

Mã trạng thái HTTP

Lỗi HTTP được trả về khi một yêu cầu không thể được xử lý ở mức vận chuyển.

Mã trạng thái↕	Ý nghĩa↕
400	Đối số không hợp lệ / yêu cầu không hợp lệ — yêu cầu chứa đầu vào không hợp lệ.
401	Không được phép — không có thông tin xác thực hợp lệ được cung cấp.
404	Không tìm thấy — tài nguyên được yêu cầu không tồn tại.
409	Xung đột tài nguyên — yêu cầu xung đột với trạng thái hiện tại của tài nguyên.
412	Điều kiện tiên quyết không được đáp ứng — một điều kiện bắt buộc không được đáp ứng trước khi xử lý.
422	Thực thể không thể xử lý — phần thân yêu cầu hợp lệ về cấu trúc nhưng chứa giá trị không hợp lệ.
429	Bị giới hạn tốc độ — quá nhiều yêu cầu trong một khoảng thời gian ngắn. Sử dụng backoff theo cấp số nhân và thử lại.
500	Lỗi máy chủ nội bộ — đã xảy ra lỗi phía máy chủ không mong muốn. Thử lại; liên hệ hỗ trợ nếu tiếp diễn.
503	Dịch vụ không khả dụng — dịch vụ tạm thời ngoại tuyến. Thử lại sau một khoảng thời gian ngắn.
504	Timeout — máy chủ không nhận được phản hồi kịp thời. Thử lại yêu cầu.

Định dạng lỗi GraphQL

Lỗi ở mức ứng dụng được trả về dưới dạng một danh sách trong trường errors của phần thân phản hồi. Mỗi lỗi bao gồm một message, path của hoạt động không thành công, và một đối tượng extensions với loại lỗi và ID yêu cầu.

1{

2 "errors": [

3 {

4 "message": "Description of the error",

5 "path": [

6 "landedCostCalculate"

7 ],

8 "extensions": {

9 "errorType": "BAD_REQUEST",

10 "requestId": "req_abc123"

11 }

12 }

13 ]

14}

Phân loại lỗi

Trường extensions.errorType cho biết danh mục của lỗi và hành động được đề xuất.

Phân loại↕	Tương đương HTTP↕	Ý nghĩa↕	Hành động↕
`BAD_REQUEST`	400	Đầu vào hoặc tham số yêu cầu không hợp lệ.	Sửa yêu cầu — kiểm tra các trường bắt buộc, định dạng và giá trị.
`NOT_FOUND`	404	Tài nguyên được tham chiếu không tồn tại.	Xác minh ID, mã và rằng các mặc định bắt buộc được cấu hình.
`UNAVAILABLE`	503	Dịch vụ hoặc tùy chọn được yêu cầu không khả dụng cho tuyến đường này.	Thử một phương pháp, mức dịch vụ hoặc điểm đến khác.
`PERMISSION_DENIED`	401 / 403	Lỗi xác thực hoặc ủy quyền.	Kiểm tra thông tin xác thực và quyền tài khoản.
`FAILED_PRECONDITION`	412	Một điều kiện cấu hình hoặc thiết lập bắt buộc không được đáp ứng.	Kiểm tra cài đặt tổ chức hoặc liên hệ hỗ trợ.
`INTERNAL`	500	Đã xảy ra lỗi phía máy chủ không mong muốn.	Thử lại yêu cầu; liên hệ hỗ trợ nếu vấn đề tiếp diễn.
`UNKNOWN`	500	Một lỗi không mong muốn mà không có phân loại thêm.	Xác minh định dạng yêu cầu; liên hệ hỗ trợ nếu vấn đề tiếp diễn.

Đặt lịch demo

Lỗi API

Mã trạng thái HTTP

Định dạng lỗi GraphQL

Phân loại lỗi

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