GET
/
wms
/
returns
curl --request GET \
  --url https://production.trackstarhq.com/wms/returns \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "id": "return_id",
      "warehouse_customer_id": "warehouse_customer_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "status": "open",
      "raw_status": "raw_status",
      "order_id": "order_id",
      "line_items": [
        {
          "inventory_item_id": "item_id",
          "quantity": 1,
          "restocked_quantity": 1,
          "warehouse_id": "warehouse",
          "returned_date": "2023-02-03T02:04:06Z"
        }
      ],
      "shipments": [
        {
          "shipped_date": "2023-02-03T02:04:06Z",
          "tracking_number": "tracking_number",
          "carrier": "carrier",
          "shipping_cost": 1.23,
          "measurements": {
            "length": 1,
            "width": 1,
            "height": 1,
            "unit": "in",
            "weight": 1,
            "weight_unit": "lb"
          }
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

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.

status
enum<string>

The status of the return. See the return information for more details.

Available options:
open,
in-transit,
receiving,
received,
cancelled,
other
status[eq]
enum<string>
Available options:
open,
in-transit,
receiving,
received,
cancelled,
other
status[neq]
enum<string>
Available options:
open,
in-transit,
receiving,
received,
cancelled,
other
status[in]
enum<string>[]

Comma-separated.

Available options:
open,
in-transit,
receiving,
received,
cancelled,
other
status[nin]
enum<string>[]

Comma-separated.

Available options:
open,
in-transit,
receiving,
received,
cancelled,
other
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.

Response

200 - application/json
data
object[]
next_token
string | null

See pagination for more details.

total_count
integer

The number of items returned.

ReturnsGet Return