Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "file number error"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"page not found"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
404
Not Found
The charge Id is not found or empty.
"Record not found"
422
Unprocessable Entity
Invalid or empty Topic
"Topic is not allowed, allowed topic are: app/expired,app/uninstalled,cart/create,cart/update,collections/create,collections/delete,collections/update,customers/create,customers/delete,customers/update,fulfillments/create,fulfillments/update,orders/cancelled,orders/create,orders/delete,orders/finished,orders/fulfilled,orders/paid,orders/partially_fulfilled,orders/partially_refunded,orders/refunded,orders/update,procurements/create,procurements/update,products/create,products/delete,products/publish,products/unpublish,products/update,shop/update,stores/subscribe,suppliers/create,suppliers/delete,suppliers/update"
topic is exist.
"Topic already exists"
Invalid or empty address url
"Address can't be blank",
"Address is invalid",
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
