Request an API Key

Login to Dashboard

Trackstar

API Reference

Get an API Key

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

Get Return

The disposition of the item received, eg restocked or discarded.

How many units were received in this condition and disposition.

URL link to the return in the external system (WMS/Freight etc).

A list of inventory items included in the return.

A list of notes associated with the return.

The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.

The raw status (if available) returned directly from the WMS.

List of the shipments associated with the return.

The status of the return. See the [return information](info) for more details.

A list of custom tags associated with the return. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.

List of inventory items items in the shipment.

The ID of the warehouse the shipment was sent to. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.

Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.

Details about received items in the shipment.

The unit of measurement for the size of the shipment.

The unit of measurement for the weight of the shipment.

The number of returned inventory items that have been restocked.

Welcome to Trackstar!

Getting Started

Structures and paradigms for the Trackstar API

About the API

Trackstar Link

Integrations

Connection Permissions

Sandbox

Webhooks

Writing Data

Trackstar Tags

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

Get Connection

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

Sync Connection

Deletes the connection associated with your access token.

Delete Connection

Information about the data provided by each integration.

Integration Info

Information about the data provided by a single integration.

Integration Info for Single Integration

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

Adjust the inventory for the specified inventory item.

Adjust Inventory Item

Update the trackstar tags for the specified inventory item.

Update Inventory Trackstar Tags

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

Get the required, optional, and integration specific fields by calling the [integrations](/mgmt/integrations) endpoint.

Create Product

Update Product

Create a Kit Product

Update a Kit Product

Update the trackstar tags for the specified product.

Update Product Trackstar Tags

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

Create Order

Update Order

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

Cancel Order

Create Order Shipment

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

Get All Order Channels

Update the trackstar tags for the specified order.

Update Order Trackstar Tags

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

Create Inbound Shipment

Update Inbound Shipment

Receive an inbound shipment for the WMS connection with the associated inbound shipment id.

Receive Inbound Shipment

Get All Inbound Shipment Suppliers

Update the trackstar tags for the specified inbound shipment.

Update Inbound Shipment Trackstar Tags

Shipping Methods

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

Get All Shipping Methods

Returns a single Shipping Method 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

Create Return

Update Return

Update the trackstar tags for the specified return.

Update Return Trackstar Tags

Billing

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

Returns all Warehouse Locations for the WMS connection with the associated warehouse id.

Get All Warehouse Locations

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

Get Warehouse Location

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.

API Documentation

Get Return

Headers

Path Parameters

Response