Skip to main content
POST
Request an Integration

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

Body

application/json
integration_type
enum<string>
required
Available options:
wms,
cart,
carrier
integration_name
string
required
flows
string[]
required

The flows you need from this integration. For wms, one of: read_inventory, read_products, read_orders, read_inbounds, read_returns, read_warehouses, create_order, cancel_order, create_product, create_inbound, create_return. For cart and carrier, the action names that type supports. Pass "not_sure" if you do not know yet, and we will follow up. Call GET /integration-requests/flows for the current list.

Minimum array length: 1
Example:
integration_contact_email
string | null
brand_name
string | null
brand_contact_email
string | null
api_docs_url
string | null
api_docs_via_email
boolean
Example:

true

prod_creds_url
string | null
sandbox_creds_url
string | null
notes
string | null

Response

Successful response

success
boolean
required
Example:

true