Bỏ qua đến nội dung
ShopNexus Docs
Trên trang này Status code 1/2

Mọi response lỗi có chung một dạng body:

{
  "error": {
    "code": "invalid_request",
    "message": "request does not match the API description",
    "fields": { "phone_token": "required" },
    "trace_id": "4bf92f3577b34da6..."
  }
}
  • code cố định, dạng snake_case. App map nó sang câu tiếng Việt của mình.
  • message là tiếng Anh, dành cho developer, không hiện cho người dùng.
  • fields có khi request sai hình dạng, mỗi trường sai một mục, key là đường dẫn JSON của trường. Giá trị là luật bị vi phạm, ví dụ required, minLength, additionalProperties.
  • details chứa giá trị mà client cần dùng, ví dụ retry_after tính bằng giây.
  • trace_id trùng với header Trace-Id của response. Khi báo lỗi thì gửi kèm nó, từ đó tìm ra request trong log và trace.

Status code

StatusÝ nghĩaMã thường gặp
400Request không khớp specinvalid_request, malformed_json
401Không có thông tin đăng nhập hợp lệunauthenticated, invalid_token, invalid_refresh_token, session_revoked, session_expired, invalid_phone_token
403Tài khoản bị khóaaccount_suspended
404Không có tài nguyên này với người gọilisting_not_found, deal_not_found, …
409Lần ghi đụng với lần ghi kháctry_again
413Body quá 1 MBbody_too_large
422Đúng hình dạng nhưng vi phạm một luậtmỗi luật một mã, ví dụ invalid_phone
428Người gọi phải làm một việc trướcreauth_required
429Bị giới hạn tần suấtxem details.retry_after
500Lỗi ngoài dự kiếninternal
503Một dịch vụ mà request cần đang không chạyunavailable

Tài nguyên mà người gọi không được xem cũng trả 404, giống như tài nguyên không tồn tại. Ví dụ phiên của tài khoản khác là 404.

try_again dùng chung cho mọi module: lần ghi thua một lần ghi khác vào cùng bản ghi, gửi lại là an toàn. Mỗi operation trong spec liệt kê các mã nó có thể trả, nên xem operation trước khi xử lý một mã.

Nguyên nhân thật của lỗi 500 chỉ nằm trong log server, không bao giờ nằm trong body.

Mã lỗi theo ca sử dụng

Luồng ngoại lệ nào kết thúc bằng một mã lỗi thì ghi mã đó trong registry. Bảng dưới sinh từ các mã đó; mã không có ở đây là mã dùng chung cho mọi module hoặc chưa được truy vết tới ca sử dụng nào.

ShopNexus Docs
EN VI

Gợi ý cho trang này

Thao tác nhanh