Skip to main content
POST
/
sandbox
/
generate-sandbox
/
{integration_type}
Generate Sandbox
curl --request POST \
  --url https://production.trackstarhq.com/sandbox/generate-sandbox/{integration_type} \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "access_token": "your_permanent_access_token",
  "connection_id": "unique_connection_id",
  "integration_name": "sandbox",
  "customer_id": "customer_id",
  "available_actions": [
    "get_inventory",
    "get_products"
  ],
  "me": {
    "account_id": "account_12345",
    "account_name": "My WMS Account"
  },
  "available_endpoints": [
    "GET /inventory",
    "GET /products"
  ]
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

Path Parameters

​
integration_type
string
required

Response

Successful response

​
access_token
string
required

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

Example:

"your_permanent_access_token"

​
connection_id
string
required

A unique connection ID for the integration.

Example:

"unique_connection_id"

​
integration_name
string
required

The name of the integration that was installed.

Example:

"sandbox"

​
customer_id
string | null
required

An identifier for your end customer.

Example:

"customer_id"

​
available_actions
string[]
required

A list of actions that the integration supports.

Actions supported by the integration

Example:
["get_inventory", "get_products"]
​
me
object
required

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

Example:
{
  "account_id": "account_12345",
  "account_name": "My WMS Account"
}
​
available_endpoints
string[]
required

DEPRECATED: Use available_actions instead.

Endpoints supported by the integration

Example:
["GET /inventory", "GET /products"]