Create Integration Instance
POST/api/trackstar/integration-instances
Create a new Trackstar WMS integration instance. Requires Bearer token.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request body fields:
- name (required, string, unique): Display name for this integration
- integration_id (required, integer): ID of the Trackstar integration type
- connection_settings.access_token (optional, string): Trackstar API access token
- connection_settings.connection_id (optional, string): Trackstar connection identifier
- integration_settings.enable_fulfillment (optional, boolean): Enable fulfillment via Trackstar
- is_automatic_sync_enabled (optional, boolean): Toggle automatic background sync
Requires the integrations.create permission.
connection_settings never contains saved credentials: each secret key (API keys, secrets, passwords, tokens) is left out and replaced by a has_<snake_case_key> boolean saying whether one is saved (apiKey → has_api_key, password → has_password).
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.