Request an API Key

Login to Dashboard

Trackstar

Get an API Key

Billing

Welcome to Trackstar!

Getting Started

Structures and paradigms for the Trackstar API

About the API

Trackstar Link

Integrations

Sandbox

Webhooks

Writing Data

Creates a temporary link token that is required to initiate the `react-trackstar-link` component.
See the [Getting Started guide](/how-to-guides/getting-started) for more details.

Create Link Token

Exchanges a temporary authorization code for a permanent access token.
See the [Getting Started guide](/how-to-guides/getting-started) for more details.

Exchange Auth Code

Returns connected integrations for your organization.

Get Connections

Manually trigger a sync for the connection associated with your access token.

Sync Connection

Deletes the connection associated with your access token.

Delete Connection

Generates a sandbox with mocked out data.
Uses the same connection ID every time, and will reset any existing sandbox.
See the [walkthrough](/how-to-guides/sandbox) for more information.

Generate Sandbox

Inventory

Returns all Inventory for the WMS connection associated with the provided access token.

Get All Inventory Items

Returns a single Inventory Item for the WMS connection with the associated inventory id.

Get Inventory Item

Products

Returns all Products for the WMS connection associated with the provided access token.

Get All Products

Returns a single Product for the WMS connection with the associated product id.

Get Product

Returns the default product create/update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/products/connection-meta).
To be used in the [POST](/wms-api/products/post) or [PUT](/wms-api/products/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Product Create/Update Schema for Integration

To be used in the [POST](/wms-api/products/post) or [PUT](/wms-api/products/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Product Create/Update Schema for Connection

Get the request body shape by calling the [meta](/wms-api/products/meta) endpoint.

Create Product

Update Product

Returns the default kit create/update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/kits/connection-meta).
To be used in the [POST](/wms-api/kits/post) or [PUT](/wms-api/kits/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Kit Create/Update Schema for Integration

To be used in the [POST](/wms-api/kits/post) or [PUT](/wms-api/kits/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Kit Create/Update Schema for Connection

Get the request body shape by calling the [meta](/wms-api/kits/meta) endpoint.

Create a Kit Product

Update a Kit Product

Orders

Returns all Orders for the WMS connection associated with the provided access token.

Get All Orders

Returns a single Order for the WMS connection with the associated order id.

Get Order

Returns the default order create/update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/orders/connection-meta).
To be used in the [POST](/wms-api/orders/post) or [PUT](/wms-api/orders/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Order Create/Update Schema for Integration

To be used in the [POST](/wms-api/orders/post) or [PUT](/wms-api/orders/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Order Create/Update Schema for Connection

Get the request body shape by calling the [meta](/wms-api/orders/meta) endpoint.

Create Order

Update Order

Cancel an order for the WMS connection with the associated order id.

Cancel Order

To be used in the [PUT](/wms-api/orders/fulfill) endpoint.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Order Fulfillment Schema for Connection

Returns the default order fulfill update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/orders/fulfill-meta).
To be used in the [PUT](/wms-api/orders/fulfill) endpoint.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Order Fulfill Schema for Integration

Fulfill an order for the WMS connection with the associated order id.
Get the request body shape by calling the [meta](/wms-api/orders/fulfill-meta) endpoint.

Fulfill Order

Returns all Order Channels for the WMS connection associated with the provided access token.

Get All Order Channels

Inbound Shipments

Returns all Inbound Shipments for the WMS connection associated with the provided access token.

Get All Inbound Shipments

Returns a single Inbound Shipment for the WMS connection with the associated inbound shipment id.

Get Inbound Shipment

Returns the default inbound shipment create/update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/inbound-shipments/connection-meta).
To be used in the [POST](/wms-api/inbound-shipments/post) or [PUT](/wms-api/inbound-shipments/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Inbound Shipment Create/Update Schema for Integration

To be used in the [POST](/wms-api/inbound-shipments/post) or [PUT](/wms-api/inbound-shipments/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Inbound Shipment Create/Update Schema for Connection

Get the request body shape by calling the [meta](/wms-api/inbound-shipments/meta) endpoint.

Create Inbound Shipment

Update Inbound Shipment

Get All Inbound Shipment Suppliers

Shipping Methods

Returns all Shipping Methods for the WMS connection associated with the provided access token.

Get All Shipping Methods

Returns a single Shipping Methodo for the WMS connection with the associated shipping method id.

Get Shipping Method

Returns

Returns all Returns for the WMS connection associated with the provided access token.

Get All Returns

Returns a single Return for the WMS connection with the associated return id.

Get Return

Returns the default return create/update schema for the specified integration.
Does not include any fields that are specific to a [particular connection](/wms-api/returns/connection-meta).
To be used in the [POST](/wms-api/returns/post) or [PUT](/wms-api/returns/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Return Create/Update Schema for Integration

To be used in the [POST](/wms-api/returns/post) or [PUT](/wms-api/returns/put) endpoints.
Read about the [meta endpoint](/how-to-guides/programmatic-writes) for more information.

Get Return Create/Update Schema for Connection

Get the request body shape by calling the [meta](/wms/returns/meta) endpoint.

Create Return

Update Return

Returns all Bills for the WMS connection associated with the provided access token.

Get All Bills

Returns a single Bill for the WMS connection with the associated bill id.

Get Bill

Warehouses

Returns all Warehouses for the WMS connection associated with the provided access token.

Get All Warehouses

Returns a single Warehouse for the WMS connection with the associated warehouse id.

Get Warehouse

Warehouse Customers

Returns all Warehouse Customers for the WMS connection associated with the provided access token.

Get All Warehouse Customers

Returns a single Warehouse Customer for the WMS connection with the associated warehouse customer id.

Home

How-To Guides

API Documentation

Billing