v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB

Auth

Exchange Auth Code

Exchanges a temporary authorization code for a permanent access token. See the Getting Started guide for more details.

post/link/exchange

Headers

x-trackstar-api-keystring required

Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Request body

auth_codestring required

The authorization code returned from the frontend after a user installs an integration.

customer_idstring nullable

An identifier for your end customer.

Example request

{
  "auth_code": "auth_code",
  "customer_id": "customer_id"
}

Response

Successful response

access_tokenstring required

The permanent access token for the integration used to make requests to the Trackstar API.

connection_idstring required

A unique connection ID for the integration.

integration_namestring required

The name of the integration that was installed.

customer_idstring nullable required

An identifier for your end customer.

available_actionsstring[] required

A list of actions that the integration supports.

meobject nullable required

Information that helps identify the connected account. If null, the integration does not provide this information.

Example response

{
  "access_token": "your_permanent_access_token",
  "connection_id": "unique_connection_id",
  "integration_name": "shipbob",
  "customer_id": "customer_id",
  "available_actions": [
    "get_inventory",
    "get_products"
  ],
  "me": {
    "account_id": "account_12345",
    "account_name": "My WMS Account"
  }
}