States
API endpoint to get information about State entities
Retrieve State data
GET
Supported Protocol: HTTPS
GET /api/:version_number/:project_name/entity/store/states?:pagination_params
curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/store/states?sort=state_name&page=1&per_page=10
Request Details
Mandatory fields marked indicated by
*
{
"metadata": {
"page": 1,
"per_page": 200,
"page_count": 1,
"total_count": 1,
"links": {
"self": "?page=0&per_page=200",
"first": "?page=0&per_page=200",
"previous": "",
"next": "",
"last": ""
}
},
"states": [
{
"state_name": "Abu Dhabi",
"state_code": "AD",
"is_deleted": false
},
{
"state_name": "Canada",
"state_code": "CA",
"is_deleted": false
}
]
}
Response
Response Details
The States GET reply body will contain the following fields:
Validation and Errors
The following are the validations and errors that may appear due to an invalid GET request:
Incorrect or expired token
-
Error Code: 401 - Unauthorized
-
Error: Incorrect or expired token
Requesting a forbidden resource
-
Error Code: 403 - Forbidden
-
Error: A forbidden resource has been requested <resource>
Request Headers
Authorization string
Value: 'Auth-Token {project auth token}'
Authentication token provided by Trax
Query Parameters
version_number string *
The current implemented API version. <Major> version (e.g. 'v4')
project_name string *
Project name as provided by Trax
pagination params
For more info see the pagination page. By default the first page will be returned first
metadata object
Info related to pagination
states Object[]
List of states, each containing the following fields:
state_name string
State name (State names that have been configured in coordination with Trax implementation team)
state_code string
State code (State code names that have been configured in coordination with Trax implementation team)
is_deleted boolean
True/False