Trax’ Store Import API V5 enables its clients to send new stores to Trax or to update already existing stores in the Trax database.

Store data should be added to a file to be sent as part of the corresponding POST request (see below). Supported file formats:

1. Excel

2. CSV

3. JSON.

Store import is an async process, ie. the response contains a job ID which can be used to poll the API to get all available data incl. the status for the given upload.

The Excel/CSV/json should/can contain the following fields (mandatory fields are marked with an asterisk *):

1. Store Number (json: store_number) - string(100) *
   The client's store unique identifier​

2. Store Name (json: store_name) - string(100) *
   Name of the store

3. Display Name (json: store_display_name) - string(100)
   A display (short-version) name of the store for report use (for Trax output solutions)

4. Store Type (json: store_type_name) - string(100)
   One of the values for the Store Type store attribute that have been implemented from the client to Trax.

5. Region (json: region_name) - string(45) *
   One of the values for the Region store attribute that have been implemented from the client to Trax.

6. District (json: district_name) - string(45)
   One of the values for the District store attribute that have been implemented from the client to Trax.

7. Branch (json: branch_name) - string(45)
   One of the values for the Branch store attribute that have been implemented from the client to Trax.

8. Retailer (json: retailer_name) - string(100)
   One of the values for the Retailer store attribute that have been implemented from the client to Trax.

9. State (json: state_name) - string(100)
   One of the values for the State store attribute that have been implemented from the client to Trax.

10. Street (json: street) - string(200) *
    Address street info e.g. "65 Chulia Street"

11. Address Line 2 (json: address_line_2) - string(100)
    Additional address information

12. City (json: city) - string(100) *
    Address City info

13. Deleted (json: is_deleted) - boolean
    True - delete the store
    False - remove the delete flag (By default false)

14. Postal Code (json: postal_code) - string(45)
    Address Postal (ZIP) code

15. Latitude (json: latitude) - Float(10,6)
    GPS latitude coordinate (in degrees) 

16. Longitude (json: longitude) - Float(10,6)
    GPS longitude coordinate (in degrees) 

17. Active (json: is_active) - boolean
    Indicates whether the store is active or has been deactivated. Optional values 'true' or 'false'
    (Settings this value to 'false' will remove the store from the Trax Mobile Application. It will still appear in Trax reports) - default value is 'true'

18. Manager Name (json: manager_name) - string(45)
    Name of the store's manager (or another contact person for the store)

19. Manager Email (json: manager_email) - string(100)
    Email of the store's manager

20. Manager Phone (json: manager_phone) - string(45)
    Phone number of the store's manager

21. Audit Cycle Set (json: audit_cycle_set) - string(100)
    Name of the audit cycle set to be connected to the store

In addition, you can also include additional attribute values as they are available for your project by using the following additional fields:​

1. Additional Attribute 1 (json: additional_attribute_1) - string(100)
   Additional attribute for the store

2. Additional Attribute 2 (json: additional_attribute_2) - string(100)
   Additional attribute for the store

3. Additional Attribute 3 (json: additional_attribute_3) - string(100)
   Additional attribute for the store

4. ...

Store Update Operation Details:

1. Operations are done in an "update + insert" style

2. In order to add a new store

   1. Add an object/row with all the required fields.

   2. The operation will succeed only if all the mandatory fields will be provided

3. In order to update a store: 

   1. Add an object/row with all the required fields. The operation will succeed only if all the mandatory fields will be provided 

   2. The unique identifier of a store is the 'store_number' field. This field is not editable

   3. Empty or missing field values will be treated as clearing the field values.

4. In order to delete a store:

   1. Add an object/row with the store_number of the store, which serves as a unique identifier, and in addition to the rest of the mandatory fields

   2. Set the 'is_deleted' value to true 

5. Note that setting a store to 'is_active: false' does not delete the store​.

Each object/row of the file will be validated. Invalid objects/rows will be added to an error file, while the valid ones are upserted to the database.

Depending on your project's configuration, some store attributes (eg. retailer) are prepared to receive new values via this Store Import V5 API. New values are automatically added to a warning log. Please reach out to Trax to discuss these store attribute configuration.