Public Request Parameters
| Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
|---|---|---|---|---|---|
| Access-Token | String |
Yes | Header | B_x-\_5aVeXNwl-4AB98s5xLVyg0fNzGf_MuTpqtlBA |
Used to authenticate API requests. Obtain an access token from the
Access Token Guide.
Pass it in the Authorization header for every request.
|
| Content-Type | String |
Yes | Header |
application/json
|
Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Feilds
| Parameter Name | Type | Required | Parameter Location | Example Value | Description |
|---|---|---|---|---|---|
| error | String | No | Response Body |
{ "error": "store is not active" }
|
Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example:
{ "error": "store is not active" }.
|
| errors | Array | No | Response Body |
{ "errors": ["No Context"] }
|
A list of errors that occurred during the request processing. Example:
{ "errors": [ "No Context" ] }.
|
| Request-Id | String | Yes | Header | B_x-\_5aVeXNwl-4AB98s5xLVyg0fNzGf_MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |