ref.adoc

Trax Connecter 1.0 Reference - Mule 4

Support Category: Certified

Anypoint Connector for Trax enables the integration of data from the Trax public facing API

Configurations

---

Default Configuration

Default configuration for Integrating with the Trax API.

Parameters

Name	Type	Description	Default Value	Required	Example
Name	String	The name for this configuration, connectors reference the configuration with this name		x	"Trax API connector configuration"
Base Uri	String	The Base URI for the Trax API		x	Either: " https://services.traxretail.com " or " https://gservices.traxretail.com "
Authorization	String	The API access key used for server authorization prefixed with "Auth-Token"		x	Auth-Token 2Duv6qwtZAVtaltC7lG2ZarFEMO3tVblWGk3HMwsMMb2axdCzxsd6zk9w7D8ng6JR7t0e0z8cri2

Available Actions

Get Audit Cycle Sets

<trax-api-connector-mule-4:entity-controller-get-audit-cycle-sets>

Retrieves a list of Audit cycle sets

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Audit Cycle Sets

Name	Type	Description
pk	number	Audit Cycle Set identifier
name	String	Audit Cycle Set name

Get Branches

<trax-api-connector-mule-4:entity-controller-get-branches>

Retrieves a list of retailer branches

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Branches

Name	Type	Description
branch_name	String	Branch name
branch_code	String	Branch code
is_deleted	Boolean	Branch deletion status

Get Districts

<trax-api-connector-mule-4:entity-controller-get-districts>

Retrieves a list of region districts

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Districts

Name	Type	Description
district_name	String	District name
district_code	String	District code
is_deleted	Boolean	Branch deletion status

Get Planograms

<trax-api-connector-mule-4:entity-controller-get-planograms>

Retrieves a list of shelf planograms

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Planograms

Name	Type	Description
planogram_image_url	String	Image URL for the planogram
planogram_id	Number	Planogram Identifier
name	String	Planogram Name
valid_from	String	Planogram valid from date
valid_to	String	Planogram valid to date
last_modified	String	Last modification date
planogram_code	String	Unique planogram identifier
planogram_status	String	Planogram activation status

Get Products

<trax-api-connector-mule-4:entity-controller-get-products>

Retrieves a list of project products

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Project Name	String	Name of the project to run against.		x
Page	Number	Page number to retrieve for pagination purposes.
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Products

Name	Type	Description
pk	Number	Product identifier
alt_code	String	The product’s alt code
product_name	String	Product name
product_type	String	Product type
product_uuid	String	Unique product identifier
product_local_name	String	Unique product name in the project’s local language
product_short_name	String	Product’s abbreviated name to be displayed in Trax reports/websites
product_item_code	String	Client product code provided by the Customer
product_client_code	String	The product’s EAN or UPC code
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
brand_code	String	Unique brand code related to the product
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	Product deletion status
is_active	Boolean	Product activation status
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
substitution_product_lead	String	Trax product uuid of the substitution lead product
container_type	Number	The product’s container type
size	String	The product size
unit_measurement	String	The product’s size measurements
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
category_attribute_1	String	Custom attribute 1
category_attribute_2	String	Custom attribute 2
category_attribute_3	String	Custom attribute 3
width	String	Product width
height	String	Product height
images	Object	A list of product images & their face count
product_additional_attributes	Object	A list of product attributes
alternative_designs	Array<alternative designs>	A list of alternative product designs

Alternative Designs

Name	Type	Description
alternative_design_name	String	Name of the alternative product design
start_date	Date	Start date for the validity of the design
images	Array<Image>	See below

Images

Name	Type	Descriptionl
image_url	String	Image URL
direction	String	Product facing direction

Get Routes

<trax-api-connector-mule-4:entity-controller-get-routes>

Retrieves a list of project routes

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Routes

Name	Type	Description
name	String	Name of the route
description	String	A short description
external_route_id	String	The client’s Route unique identifier
entities	String	An Object of entities that is linked to the route

Entities

Name	Type	Description
stores	Array	List of store numbers maximum 500 stores per route
users	Array	List of users login name
cycles	Array	List of cycles linked to the route

Get States

<trax-api-connector-mule-4:entity-controller-get-states>

Retrieves a list of country states

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

States

Name	Type	Description
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)

Get Store Types

<trax-api-connector-mule-4:entity-controller-get-store-types>

Retrieves a list of store types

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Store Types

Name	Type	Description
store_type_name	String	Store Type name (Store Type names that have been configured in coordination with Trax implementation team)
store_type_code	String	Store Type code (Store Type codes that have been configured in coordination with Trax implementation team)
is_deleted	Boolean	Was the store type deleted

Get Stores

<trax-api-connector-mule-4:entity-controller-get-stores>

Retrieves a list of stores

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Stores

Name	Type	Description
store_number	String	The client’s store unique identifier
store_name	String	Name of the store
store_display_name	String	A display (short-version) name of the store for report use (for Trax output solutions)
store_type_name	String	Store type (Store types that have been configured in coordination with Trax implementation team)
region_name	String	Region Name (Regions that have been configured in coordination with Trax implementation team)
district_name	String	District Name (Districts that have been configured in coordination with Trax implementation team)
branch_name	String	Branch Name (Branches that have been configured in coordination with Trax implementation team)
retailer_name	String	Retailer Name (Retailers that have been configured in coordination with Trax implementation team)
state_name	String	State Name (States that have been configured in coordination with Trax implementation team)
state_code	String	ISO code for a state or province (State codes that have been configured in coordination with Trax implementation team)
street	String	Address street info
city	String	Address info
address_line_2	String	Address info
postal_code	String	Address info
latitude	Number(Float)	GPS latitude coordinate (in degrees)
longitude	Number(Float)	GPS longitude coordinate (in degrees)
audit_cycle_set	String	Audit cycle set name that the store is assigned to
is_active	Boolean	Indicates whether the store is active or has been deactivated
manager_name	String	Name of the store’s manager (or another contact person for the store)
manager_email	String	Email of the store’s manager
manager_phone	String	Phone number of the store’s manager
last_update_time	Number (Epoch Unix Timestamp)	The store’s last update time in Epoch Unix Time timestamp
store_additional_attributes	Object	In addition to the attributes above, it is possible to add additional attributes for stores (currently, Trax supports up to 45 name-value pairs)
is_deleted	Boolean	Was the store deleted

Additional Attributes

In addition to the attributes above, it is possible to add additional attributes for stores (currently, Trax supports up to 45 name-value pairs)

Name	Type	Description
<key>	String	Attribute name as coordinated with Trax implementation. Currently limited to 'additional_attribute_n' where n is 1-45. The values will correspond to additional_attribute_n. e.g. additional_attribute_1
<value>	String	Attribute name as coordinated with Trax implementation

Get Tasks

<trax-api-connector-mule-4:entity-controller-get-tasks>

Retrieves a list of Tasks

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Tasks

Name	Type	Description
task_name	String	Task name (Task names that have been configured in coordination with Trax implementation team)
task_code	String	Task code (Task codes that have been configured in coordination with Trax implementation team)
task_uuid	String	Unique identifier for the task
template_group	String	The template’s template group
additional_attribute_1	String	Custom attribute 1
additional_attribute_2	String	Custom attribute 2
additional_attribute_3	String	Custom attribute 3
additional_attribute_4	String	Custom attribute 4
fixture	String	A type of display in the store such as a cooler, main shelf, or secondary display

Get Users

<trax-api-connector-mule-4:entity-controller-get-users>

Retrieves a list of users

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Users

Name	Type	Description
login_name	String	Users login name
email_address	String	A valid, working email that is universally unique
mobile_number	String	A valid, working, mobile number that is universally unique and in use,e.g +447813988839
first_name	String	Users first name
last_name	String	Users last name
supervisors_username	String	The username (email/telephone) of the supervisor of the user
operational_role	String	The user’s operational role. The optional values are: Sales Rep, Auditor, Supervisor, Manager
entities	Object[]	List of entities that are linked to the user

entities

Name	Type	Description
routes	Array	List of external_route_id that are linked to the user
stores	Array	List of store_numbers that are linked to the user

Get Analysis Results

<trax-api-connector-mule-4:analysis-results-controller-get-analysis-result>

Retrieves a list of analysis result reports between a start time and an end time (both in UNIX Epoch timestamps)

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Project Name	String	Name of the project to run against		x
Page	Number	Page number to retrieve for pagination purposes
Per Page	Number	Number of results to return per page
From	Number (UNIX Epoch timestamp)	The start time for the analysis reports range
To	Number (UNIX Epoch timestamp)	The end time for the analysis reports range
Visit Type ID	Number	The visit type id of the wanted sessions, where the id is a number
Visit Type Display Name	String	The visit type display name of the wanted session
Include Incomplete Visits	Boolean	T/F if to include incomplete visits

Output

Metadata

Name	Type	Description
page	Number	Current page number
per_page	Number	Number of results per page
page_count	Number	Total number of pages available
total_count	Number	Total number of available results
links	Object	See below

Links

Name	Type	Description
self	String	Link to current page number
first	String	Link to first page
previous	String	Link to previous page
next	String	Link to next page
last	String	Link to last page

Non-Metadata

Name	Type	Description
from_time	String	Start time of the time range for reports (in YYYY-MM-DD HH:MM:SS format)
to_time	String	End time of the time range for reports (in YYYY-MM-DD HH:MM:SS format)
results_generated	Number	Number of results the query has returned
results	Object[]	List of analysis result reports - See Below

Results

Name	Type	Description
session_uid	String	Session UUID generated by Trax
client_session_uid	String	Session UID generated by the client
project_name	String	Project name as provided by Trax
store_number	String	Client store unique identifier
external_route_id	String	Client store unique identifier
session_date	String	Visit date in local time zone (YYYY-MM-DD format)
session_start_time	Number (UNIX Epoch timestamp)	The Unix Epoch Timestamp of the session start time as provided by the client application
session_end_time	Number (UNIX Epoch timestamp)	The Unix Epoch Timestamp of the session end time as provided by the client application. This value is empty in case: * Session didn’t begin to upload User * User did not click on the "End Visit" button
last_item_upload_time	String	The time the last item was uploaded
visitor_identifier	String	The user email
visit_date	String	Visit date in local time zone (YYYY-MM-DD format)
results_link	String	Analysis Results JSON file link
report_metadata	Object	Analysis Results API response metadata (See Below)

Report Metadata

Name	Type	Description
generation_time	Number (UNIX Epoch timestamp)	The Unix Epoch Timestamp of analysis data generation
version	Number	The report may have versions. For example, if an additional section has been computed and added to an initial report, another version will be generated
status	String	Will be either: completed or partial. Partial reports are automatically generated by Trax when the expected SLA time has passed and some data from the client has failed to arrive. For example, one or more images from a store visit failed to upload. If and when the missing data will arrive, the results will be updated

See Also

• Introduction to Anypoint Connectors

• MuleSoft Help Center