Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
wms
Returns

Get All Returns

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

get/wms/returns

Query parameters

page_tokenstring nullable
Example:page_token

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

limitinteger
Example:1000

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

instring[] required

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

eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
containsstring[]

Comma-separated.

not_containsstring[]

Comma-separated.

Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings.

eq'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
neq'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

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

{
  "eq": "open"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The ID of the customer associated with the resource

{
  "eq": "warehouse_cust_id"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The ID of the order that the return is associated with.

{
  "eq": "order_123"
}

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

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

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

Example response

{
  "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",
      "notes": [
        "This is a note"
      ],
      "line_items": [
        {
          "inventory_item_id": "item_id",
          "sku": "sku",
          "expected_quantity": 1,
          "received_quantity": 1,
          "restocked_quantity": 1,
          "return_reason": "Too Small"
        }
      ],
      "shipments": [
        {
          "tracking_number": "tracking_number",
          "shipped_date": "2023-02-03T02:04:06Z",
          "arrived_date": "2023-02-03T02:04:06Z",
          "warehouse_id": "warehouse_id",
          "carrier_id": "carrier_id",
          "carrier_name": "carrier_name",
          "scac": "FDXG",
          "shipping_cost": 1.23,
          "measurements": {
            "length": 1,
            "width": 1,
            "height": 1,
            "unit": "in",
            "weight": 1,
            "weight_unit": "lb"
          },
          "line_items": [
            {
              "inventory_item_id": "item_id",
              "sku": "sku",
              "quantity": 4,
              "receiving_details": [
                {
                  "quantity": 1,
                  "condition": "good",
                  "disposition": "restocked"
                },
                {
                  "quantity": 1,
                  "condition": "damaged",
                  "disposition": "scrapped"
                }
              ]
            }
          ]
        }
      ],
      "external_system_url": "https://example.com/return/123",
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ],
      "additional_fields": {
        "key": "value"
      }
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}