top of page

Store Types

API endpoint to get information about Store Type entities ​

Retrieve store types data 

GET

Supported Protocol: HTTPS

GET /api/:version_number/:project_name/entity/store/store_type?:pagination_params

curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/store/store_type?sort=store_type_name&page=1&per_page=10

metadata object 

Info related to pagination

store_type Object[]

List of store types, each containing the following fields:

store_type_name string

Store Type name (Store Type names that have been configured in coordination with Trax implementation team) 

is_deleted boolean

True/False​

store_type_code number

Code of the given store type

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": ""

}

},

"store_type": [

{

"store_type_name": "My store type",

"store_type_code": null, 

"is_deleted": false

},

{

"store_type_name": "My store_type-1",

"store_type_code": null,

"is_deleted": false

}

  ]

}

Response

Response Details

The Store Type 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

bottom of page