Products
API endpoint to get information about Product entities ​
Retrieve products data
GET
Supported Protocol: HTTPS
GET /api/:version_number/:project_name/entity/product?:pagination_params
​
curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/product?page=1&per_page=10
metadata object
Info related to pagination​
​
product Object[]
List of products, each containing the following fields:
​
pk number
Unique identifier of the product (primary key in the product database table) for the given project
​
product_item_code string
Client product code provided by the customer
​
product_client_code string
The product's EAN or UPC code
product_uuid string
Trax product UUID
​
product_name string
Unique product name
​
product_local_name string
Unique product name in the project's local language
​
product_short_name string
Product's abbreviate name to be displayed in Trax reports/websites
​
brand_name string
Unique brand name related to the product
​
brand_local_name string
Unique brand name related to the product in the project's local language
​
manufacturer_name string
Unique manufacturer name related to the brand
​
manufacturer_local_name string
Unique manufacturer name related to the brand in the project's local language
​
is_deleted boolean
True/False
​
is_active boolean
True/False
​
last_update_time number
Product's last update time in Epoch Unix Time timestamp
​
category_name string
Unique category name related to the product
​
category_local_name string
Unique category name related to the product in the project's local language
​
subcategory_name string
Unique subcategory name related to the product
​
subcategory_local_name string
Unique subcategory name related to the product in the project's local language
​
container_type string
The product's container type
​
size number
The product size
​
unit_measurement string
The product's size measurement
​
number_of_subpackages number
The product's number of subpackages
​
units number
The product's number of units
​
discovered_by_brand_watch boolean
Indicates whether the product has been discovered by Trax Brand Watch
​
images Object
A list of product images & their face count
​
product_additional_attributes Object
A list of products attributes in key-value pairs. These attributes are coordinated with Trax implementation
​
alt_code string
the product's alt code
​
product_type string
Type of the given product (SKU, POS, Menu etc)​
​
width number
Width param for the product in mm​
​
height number
Height param for the product in mm
​
alternative_designs Object
A list of the product's alternative
designs which are alternative versions of the product's packaging & design:
​
alternative_design_name
string
The name given to the alternative product design
​
start_date
string (YYYY-MM-DD)
The date Trax will start identifying the alternative design
​
end_date string (YYYY-MM-DD)
The date Trax will stop identifying the alternative design
​
images Object
A list of alternative product images & their face count:
image_url string
The product image​
direction string
The image direction:
1. Front
2. Back
3. Side1
4. Side2
5. Top
6. Bottom
Request Details
Mandatory fields marked indicated by
*
{
"metadata": {
"page": 1,
"per_page": "2",
"page_count": 1902,
"total_count": 3804,
"links": {
"self": "/api/v4/my-project/entity/product?&page=1&per_page=10",
"first": "/api/v4/my-project/entity/product?&page=0&per_page=10",
"previous": "",
"next": "/api/v4/my-project/entity/product?&page=2&per_page=10",
"last": "/api/v4/my-project/entity/product?&page=1166&per_page=10"
}
},
"product": [
{
"pk": "Unique identifier of the product (primary key in the product database table) for the given project",
"product_type": "Type of the given product (SKU, POS, Menu etc)",
"width": "Width param for the product in mm",
"height": "Height param for the product in mm",
"alt_code": "My alt code",
"product_name": "My Product Name The Long Version",
"product_uuid": "18f0fokn-c00a-31e5-b4ba-02c9c691",
"product_local_name": "My Product Name In Local Language The Long Version",
"product_short_name": "My Product Name In Reports (Shortened)",
"product_additional_attributes": { },
"brand_name": "My Brand Name",
"brand_local_name": "My Brand Name In Local Language",
"manufacturer_name": "My Manufacturer Name",
"manufacturer_local_name": "My Manufacturer Name In Local Language",
"is_deleted": false,
"is_active": true,
"last_update_time": "2020-04-22 16:10:03",
"category_name": "My Category",
"category_local_name": "My Category In Local Language",
"physical_attributes": {
"container_type": "metal box",
"size": 250, "unit_measurement": "g"
},
"images": [
{ "image_url": "/my-project/Product_Images/1",
"direction": "Front"
}
],
},
{
"pk": "Unique identifier of the product (primary key in the product database table) for the given project",
"product_type": "Type of the given product (SKU, POS, Menu etc)",
"width": "Width param for the product in mm",
"height": "Height param for the product in mm",
"alt_code": "My alt code",
"product_name": "My Product Name The Long Version",
"product_uuid": "25kjd-nyh-85pkjd-369-rft34",
"product_local_name": "My Product Name In Local Language The Long Version",
"product_short_name": "My Product Name In Reports (Shortened)",
"product_additional_attributes": { },
"brand_name": "My Brand Name", "brand_local_name": "My Brand Name In Local Language",
"manufacturer_name": "My Manufacturer Name",
"manufacturer_local_name": "My Manufacturer Name In Local Language",
"is_deleted": true,
"is_active": false,
"last_update_time": "2020-05-12 08:41:52",
"category_name": "My Category",
"category_local_name": "My Category In Local Language",
"physical_attributes": {
"container_type": "can",
"size": 62,
"unit_measurement": "mg"
},
"images": [
{ "image_url": "/my_project/Product_Images/4",
"direction": "Front"
}
],
"alternative_designs": [
{ "alternative_design_name": "My Product Alternative Design 1",
"end_date": "2100-01-01",
"images": [
{ "image_url": "/my_project/Product_Images/5",
"direction": "Front"
}
]
}
],
}
]
}
Response
Response Details
The Product 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
​