Get All Warehouses

GET

wms

warehouses

curl --request GET \
  --url https://production.trackstarhq.com/wms/warehouses \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "id": "warehouse_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "name": "Bethlehem (PA)",
      "code": "ABE-1",
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token

string

required

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

Example:

"<x-trackstar-access-token>"

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.

Example:

"page_token"

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.

Example:

"2022-03-10T13:00:00Z"

created_date[eq]

string

Example:

"2022-03-10T13:00:00Z"

created_date[neq]

string

Example:

"2022-03-10T13:00:00Z"

created_date[gt]

string

Example:

"2022-03-10T13:00:00Z"

created_date[gte]

string

Example:

"2022-03-10T13:00:00Z"

created_date[lt]

string

Example:

"2022-03-10T13:00:00Z"

created_date[lte]

string

Example:

"2022-03-10T13:00:00Z"

created_date[in]

string[]

Comma-separated.

created_date[nin]

string[]

Comma-separated.

updated_date

string

Same syntax as created_date.

Example:

"2022-03-11T13:00:00Z"

updated_date[eq]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[neq]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[gt]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[gte]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[lt]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[lte]

string

Example:

"2022-03-11T13:00:00Z"

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.

Example:

1000

ids[in]

string[]

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

Response

200

application/json

Successful response

data

object[]

data.id

string

The unique ID of the warehouse.

Example:

"warehouse_id"

data.created_date

string

The date the warehouse was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the warehouse was last updated.

Example:

"2022-01-02T05:05:05Z"

data.name

string

The name of the warehouse.

Example:

"Bethlehem (PA)"

data.code

string | null

The warehouse code.

Example:

"ABE-1"

data.address

object

data.trackstar_tags

any[] | null

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

Example:

["tag1", "tag2", { "tag3": "value3" }]

next_token

string | null

See pagination for more details.

Example:

"next_token"

total_count

integer

The number of items returned.

Example:

1

Warehouses Get Warehouse

curl --request GET \
  --url https://production.trackstarhq.com/wms/warehouses \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "id": "warehouse_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "name": "Bethlehem (PA)",
      "code": "ABE-1",
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

API Documentation

Headers

Query Parameters

Response