top of page


API endpoint to get information about Assortment entities ​

Retrieve assortments data

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>


Supported Protocol: HTTPS

GET /api/:version_number/:project_name/entity/assortment?:pagination_params

curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY"

metadata object 

Info related to pagination

assortment Object[]

List of assortments, each containing the following fields:

assortment_id string

Unique identifier of the assortment

assortment_name string

Name of the assortment​

assortment_type string

the type of the assortment refers to the KPI that is linked to it. For example Power SKUs, Must have, New Products, etc.



Specify the number of products that needs to appear in the visit in order to determine this group as 100% in stock. For example an assortment can contain 50 products, but it is enough that 20 products will appear in order to set the availability KPI as 100%.

The object will contain the following fields: 

target number

Target number that needs to be reached​

start_date Date

Start date for the level target​

end_date Date

End date for the level target

shelf_policy Object

The attributes of the shelf ​(scene type/task) that are associated with the planogram. This can be either scene type or template group (scene type group). Only one of these two options will appear. The fields in the shelf policy are: 

template_group string

The id of the group of tasks (scene types) that the planogram is linked to. Between this field and scene_type_id only one will be present​

scene_type_id string

The id of the group of scene type associated with the planogram Between this field and template_group only one will be present

name string

Name of the scene type associated with the planogram

story_policy Object

The attributes of the stores (region, retailer, etc) that are the context of the assortment. ​ There will be a section for each store attribute

linked_products Object

The group of products to be in store in order to set the availability KPI as 100%. Each product in the list of products will contain the following fields:

product_id string

Id of the product​

name string

Product name

product_item_code string

Product EAN code

product_client_code string

Customer's identification number of the product ​

local_name string

Name in the local language​

start_date string

Start date in which the product is part of the assortment. For example, in case of future launch of SKUs the start will be the future one ​

end_date string

End date in which the product is no longer part of the assortment​

uuid string

The UUID of the product




Additional attributes for the assortment product in key value pairs​

Request Details

Mandatory fields marked indicated by



"metadata": {

"page": 0,

"per_page": 20,

"page_count": 3,

"total_count": 46,

"links": {

"self": "/api/projects/my-project/assortment/get-project-assortment-data?page=0&per_page=20",


"first": "/api/projects/my-project/assortment/get-project-assortment-data?page=0&per_page=20",


"previous": "/api/projects/my-project/assortment/get-project-assortment-data?page=0&per_page=20",


"next": "/api/projects/my-project/assortment/get-project-assortment-data?page=1&per_page=20",


"last": "/api/projects/my-project/ ssortment/get-project-assortment-data?page=3&per_page=20"





"assortment_id": "id",

"assortment_name": "My assortment name",

"assortment_type": "power SKU",

"assortment_level_target": {

"targets": {

"target": "1",

"start_date": "2018-10-10",

"end_date": "2020-10-10"



"shelf_policy": {

"scene_type_id": "12",

"name": "My shelf name",

"template_group": "My template group"


"store_policy": {

"store_types": [ { "value": "Walmart" } ],

"retailer_name": [ { "value": "Don Quixote" } ]


"linked_products": [


"product_id": "Product id #1",

"name": "Product id #1 name",

"product_item_code": "Product id #1 code",

"product_client_code": "Product id #1 code",

"local_name": "Product id #1 type",

"start_date": "2018-10-10",

"end_date": "2020-10-10"







Response Details

The Assortments 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:

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