Get All Products - Trackstar

GET

wms

products

page_token

string

created_date

string

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

array

created_date[nin]

array

updated_date

string

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

updated_date[in]

array

updated_date[nin]

array

limit

integer

ids

string

ids[in]

array

warehouse_customer_id

string

warehouse_customer_id[eq]

string

warehouse_customer_id[neq]

string

warehouse_customer_id[in]

array

warehouse_customer_id[nin]

array

sku

string

sku[eq]

string

sku[in]

array

sku[nin]

array

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Query Parameters

page_token

string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

created_date

string

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gt]=2023-03-10T00:00:00Z&created_date[lt]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ.

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

string[]

Comma-separated.

created_date[nin]

string[]

Comma-separated.

updated_date

string

Same syntax as created_date.

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

updated_date[in]

string[]

Comma-separated.

updated_date[nin]

string[]

Comma-separated.

limit

integer

The maximum number of items to return. The default is 1000.

ids

string

A comma separated list of resource Ids. If provided, all other query params are ignored.

ids[in]

string[]

Comma-separated.

warehouse_customer_id

string

The ID of the customer associated with the resource

warehouse_customer_id[eq]

string

warehouse_customer_id[neq]

string

warehouse_customer_id[in]

string[]

Comma-separated.

warehouse_customer_id[nin]

string[]

Comma-separated.

sku

string

The SKU of the product.

sku[eq]

string

sku[in]

string[]

Comma-separated.

sku[nin]

string[]

Comma-separated.

Response

200 - application/json

data

object[]

data.id

string

The unique ID of the product.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the product. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the product was created.

data.updated_date

string

The date the product was last updated.

data.name

string

name

data.sku

string | null

sku

data.gtin

string | null

The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.

data.unit_price

number | null

The price of the product.

data.inventory_items

object[]

A list of inventory items associated with the product.

data.is_kit

boolean

data.active

boolean

Whether the product is active.

data.supplier

string | null

Deprecated in favor of supplier_object.

data.supplier_object

object | null

data.country_of_origin

string | null

The country of origin of the product.

data.harmonized_code

string | null

The harmonized HS code of the product.

data.supplier_products

object[]

A list of supplier products associated with the product.

data.external_system_url

string | null

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

data.trackstar_tags

any[] | null

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

next_token

string | null

See pagination for more details.

total_count

integer

The number of items returned.

Products Get Product

API Documentation

Headers

Query Parameters

Response