# Trax API **Canonical:** https://apis.io/apis/trax/trax-api/ **Provider:** Trax — https://apis.io/providers/trax/ **Base URL:** https://services.traxretail.com **Documentation:** https://www.apidoc.traxretail.com/tasks Trax API is one of 2 APIs that [Trax](https://apis.io/providers/trax/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas. Trax API as documented publicly: 48 operations. Contract generated from the documentation by API Evangelist (2026-10-20); not the provider's own document. ## Operations (48) | Method | Path | Summary | |---|---|---| | GET | `/api/{versionNumber}/{projectName}/{entities}` | Pagination is available with certain routes where the quantity of the data returned may be large. | | POST | `/api/{versionNumber}/{projectName}/analysis-results/queue/ack` | Acknowledge the reception of messages pulled from the queue and remove them from it. | | POST | `/api/{versionNumber}/{projectName}/analysis-results/queue/pull` | Pull messages from the analysis results queue to extract headers and links to analysis results files. | | GET | `/api/{versionNumber}/{projectName}/analysis-results/queue/size` | Determine the size of the analysis results queue. | | POST | `/api/{versionNumber}/{projectName}/async-job` | This method should be used to add an asynchronous job to Trax servers, with the request to add/remove/modify entities. | | GET | `/api/{versionNumber}/{projectName}/async-job/status/{async}-job-id` | A client may use the returned job identifier id to query the progress of the job. | | GET | `/api/{versionNumber}/{projectName}/entity/assortment` | Retrieve assortments data | | GET | `/api/{versionNumber}/{projectName}/entity/product` | Retrieve products data | | GET | `/api/{versionNumber}/{projectName}/entity/routes` | Retrieve Routes Data | | GET | `/api/{versionNumber}/{projectName}/entity/store` | Retrieve Stores Data | | GET | `/api/{versionNumber}/{projectName}/entity/store/audit_cycle_set` | Retrieve Store Audit Cycle data | | GET | `/api/{versionNumber}/{projectName}/entity/store/branches` | Retrieve branches data | | GET | `/api/{versionNumber}/{projectName}/entity/store/district` | API endpoint to get information about District entities | | GET | `/api/{versionNumber}/{projectName}/entity/store/region` | API endpoint to get information about Region entities | | GET | `/api/{versionNumber}/{projectName}/entity/store/retailer` | API endpoint to get information about Retailer entities | | GET | `/api/{versionNumber}/{projectName}/entity/store/states` | Retrieve State data | | GET | `/api/{versionNumber}/{projectName}/entity/store/store_type` | API endpoint to get information about Store Type entities. | | GET | `/api/{versionNumber}/{projectName}/entity/task` | Retrieve Task data | | GET | `/api/{versionNumber}/{projectName}/entity/user` | Querying users from Trax | | POST | `/api/{versionNumber}/{projectName}/metadata-file` | A method to update Trax with general metadata files, commonly used for configuration for KPI-related metadata. | | GET | `/api/{versionNumber}/{projectName}/metadata-file/status/{metadata}-file-id` | Query the metadata file job status. | | PUT | `/api/{versionNumber}/{projectName}/session/{sessionUid}` | API endpoint for submitting Session information as part of Visit Data | | PUT | `/api/{versionNumber}/{projectName}/session/{sessionUid}/scenes/{sceneUid}` | Route for sending a scene data to Trax API endpoint for submitting Scene information as part of Visit Data. | | PUT | `/api/{versionNumber}/{projectName}/session/{sessionUid}/scenes/{sceneUid}/images/{my}-image-uid` | PUT Route for sending a image data to Trax API endpoint for submitting Images information as part of Visit Data | | DELETE | `/api/notifier/public/{projectName}/subscription` | Delete subscription configuration for a project. | | GET | `/api/notifier/public/{projectName}/subscription` | Retrieve subscription configuration for a project. | | PUT | `/api/notifier/public/{projectName}/subscription` | Update subscription configuration with URLs and wave types. | | GET | `/api/v4/my-project/analysis-results/queue/ack` | GET /api/v4/my-project/analysis-results/queue/ack | | GET | `/api/v4/my-project/analysis-results/queue/pull` | GET /api/v4/my-project/analysis-results/queue/pull | | PUT | `/api/v4/my-project/sessions/my-session-UID` | PUT /api/v4/my-project/sessions/my-session-UID | | PUT | `/api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID` | PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID | | PUT | `/api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID/images/my-image-uid` | PUT /api/v4/my-project/sessions/my-session-UID/scenes/my-scene-UID/images/my-image-uid | | POST | `/api/v5/{projectName}/entity/products/import` | Import a File | | DELETE | `/api/v5/{projectName}/entity/products/import/{importId}` | Delete an Import | | GET | `/api/v5/{projectName}/entity/products/import/details/{importId}` | Get Import Details by ID | | GET | `/targets/api/{versionNumber}/projects/{projectName}/uploads` | Retrieve all uploaded targets data files with all available data from Trax. | | POST | `/targets/api/{versionNumber}/projects/{projectName}/uploads` | Upload an Excel or CSV file with targets data to one set of KPIs. | | GET | `/targets/api/{versionNumber}/projects/{projectName}/uploads/{uploadId}/download-errors` | Retrieve the errors found in an uploaded targets data file during validation. | | POST | `/targets/api/{versionNumber}/projects/{projectName}/uploads/{uploadId}/finalize` | Finalize Upload (commit data to the database). | | POST | `/targets/api/{versionNumber}/projects/{projectName}/uploads/batch` | Upload an Excel file with target data to multiple KPIs (Batch). | | GET | `/targets/api/{versionNumber}/projects/{projectName}/uploads/details/{uploadId}` | Retrieve an uploaded targets data file with all available data (source file, metadata, status etc.) from Trax. | | GET | `/targets/api/{versionNumber}/projects/{projectName}/uploads/download` | Retrieve an excel file with all (active and historical) target data from Trax. | | POST | `/targets/api/{versionNumber}/projects/{projectName}/uploads/update/{uploadId}` | Replace the uploaded file or change the variable group of a previously uploaded file. | | GET | `/targets/api/v4/my-project/uploads/62f4f1dd68bcdd097cca1938/download-errors` | GET /targets/api/v4/my-project/uploads/62f4f1dd68bcdd097cca1938/download-errors | | GET | `/targets/api/v4/my-project/uploads/details/62f4f1dd68bcdd097cca1938` | GET /targets/api/v4/my-project/uploads/details/62f4f1dd68bcdd097cca1938 | | GET | `/targets/api/v4/projects/myproject/uploads/62f4f1dd68bcdd097cca1938/finalize` | GET /targets/api/v4/projects/myproject/uploads/62f4f1dd68bcdd097cca1938/finalize | | GET | `/targets/api/v4/projects/myproject/uploads/batch` | GET /targets/api/v4/projects/myproject/uploads/batch | | GET | `/targets/api/v4/projects/myproject/uploads/update/62f4f1dd68bcdd097cca1938` | GET /targets/api/v4/projects/myproject/uploads/update/62f4f1dd68bcdd097cca1938 | ## Machine-readable artifacts (7) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/openapi/_ae-authored/trax-openapi-generated.yml - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-put-api-versionnumber-projectname-session-sessionuid-scenes-sceneui2-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-api-versionnumber-projectname-entity-store-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-targets-api-versionnumber-projects-projectname-uploads-details-u-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-post-targets-api-versionnumber-projects-projectname-uploads-update-u2-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-targets-api-versionnumber-projects-projectname-uploads-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trax/refs/heads/main/json-schema/trax-get-api-versionnumber-projectname-metadata-file-status-metadata-file-schema.json ## Other Trax APIs (1) - [Trax Retail Platform API](https://apis.io/apis/trax/trax-retail-platform-api/) --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/trax/trax-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/trax/.