Error codes

Every error has the same shape. type groups codes; code is stable and safe to match on; message is for people; param names the field at fault; docs links here.

{
  "error": {
    "type": "invalid_request",
    "code": "validation_failed",
    "message": "Title is required.",
    "param": "title",
    "trace_id": "tr_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "docs": "https://docs.storelyne.com/errors/validation_failed"
  }
}

`invalid_request`

Code	Status	Meaning
`validation_failed`	400	A field in the request is missing or invalid. See param.
`invalid_json`	400	The request body is not valid JSON.
`bad_request`	400	The request could not be understood.
`payload_too_large`	413	The request body is larger than allowed.
`unsupported_media_type`	415	Send JSON with Content-Type: application/json.
`token_invalid`	400	The link is invalid, already used or expired. Ask for a new one.
`store_required`	400	Send the Store-Id header to choose which of your stores this request is for.
`setting_invalid`	400	The value is not valid for this setting.
`method_not_allowed`	405	This endpoint does not support the HTTP method.
`signature_invalid`	400	The payment confirmation could not be verified. The payment is checked with the provider instead.

`authentication_error`

Code	Status	Meaning
`authentication_required`	401	Send a valid access token or session.
`invalid_token`	401	The access token is invalid, revoked or expired.
`invalid_credentials`	401	The email or password is wrong.
`ops_login_failed`	401	The email or authenticator code is wrong.

`permission_error`

Code	Status	Meaning
`missing_scope`	403	The app token does not have the scope this endpoint needs.
`session_required`	403	This endpoint needs a seller session; app tokens cannot call it.
`forbidden`	403	You do not have access to this resource.
`not_a_member`	403	You are not a member of this store, or your role cannot do this.
`csrf_failed`	403	The X-CSRF-Token header is missing or does not match. Reload the page and try again.
`step_up_required`	403	Confirm with a fresh authenticator code before doing this.

`not_found`

Code	Status	Meaning
`route_not_found`	404	No endpoint exists at this method and path.
`resource_not_found`	404	The object does not exist or belongs to another store.

`conflict`

Code	Status	Meaning
`email_taken`	409	An account with this email already exists. Sign in instead.
`conflict`	409	The request conflicts with the current state of the object.
`retry_conflict`	409	A concurrent change got there first. Retry the request.
`out_of_stock`	409	An item does not have enough stock for this quantity. Lower the quantity or remove it.
`checkout_closed`	409	This checkout is already completed or expired. Start again from the cart.
`price_changed`	409	A price changed since the checkout started. Review the new total and place the order again.

`idempotency_error`

Code	Status	Meaning
`replay_unavailable`	409	This request already succeeded and its response held a secret that is shown only once.
`idempotency_key_required`	400	Every POST needs an Idempotency-Key header.
`idempotency_key_invalid`	400	Idempotency-Key must be 1 to 255 visible ASCII characters.
`idempotency_in_progress`	409	A request with this Idempotency-Key is still running.
`idempotency_key_reused`	422	This Idempotency-Key was used with a different request.

`rate_limit_error`

Code	Status	Meaning
`login_throttled`	429	Too many failed sign-in attempts. Wait and try again.
`ops_locked`	429	This staff account is locked after repeated failures. Wait and try again.
`rate_limited`	429	Too many requests. Wait for the time in RateLimit-Reset.

`api_error`

Code	Status	Meaning
`internal_error`	500	Something went wrong on our side. Quote the trace_id to support.
`service_unavailable`	503	A dependency is unavailable. Retry with backoff.
`server_agent_unavailable`	503	The server agent is not running, so the super admin cannot reach the server. It is installed by the next deploy.
`server_action_failed`	502	The server agent tried the action and it failed. The message says what the server answered.
`database_timeout`	503	The request took too long. Retry with backoff.