---
title: "Get All Returns"
method: GET
path: "/wms/returns"
tags: ["wms", "Returns"]
---

# Get All Returns

`GET /wms/returns`

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

## Query parameters

- `page_token` string, nullable
- `limit` integer
- `ids` WmsReturnIdsQueryParam
  - `in` string[], required — A comma-separated list of resource IDs. If provided, all other query params are ignored.
- `created_date` WmsReturnCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `updated_date` WmsReturnUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_created_date` WmsReturnTrackstarCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_updated_date` WmsReturnTrackstarUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_tags` WmsReturnTrackstarTagsFlatQueryParam
  - `contains` string[] — Comma-separated.
  - `not_contains` string[] — Comma-separated.
- `status` WmsReturnStatusQueryParam
  - `eq` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
  - `neq` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `warehouse_customer_id` WmsReturnWarehouseCustomerIdQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `order_id` WmsReturnOrderIdQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string

## Headers

- `x-trackstar-api-key` string, required
- `x-trackstar-access-token` string, required

## Response `200`

Successful response

- WmsReturnsListEndpoint
  - `data` WmsReturnApiItemSchema[], required
    - `id` string, required — The unique ID of the return.
    - `warehouse_customer_id` string, nullable, required — 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.
    - `created_date` string, date-time, required — The date the return was created.
    - `updated_date` string, date-time, required — The date the return was last updated.
    - `status` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other', required — The status of the return. See the [return information](info) for more details.
    - `raw_status` string, nullable, required — The raw status (if available) returned directly from the WMS.
    - `order_id` string, nullable, required — 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.
    - `notes` string[], required — A list of notes associated with the return.
    - `line_items` WmsReturnLineItem[], required — A list of inventory items included in the return.
      - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
      - `sku` string, nullable, required
      - `expected_quantity` integer, required — How many units are expected to arrive.
      - `received_quantity` integer, required — How many units actually arrived.
      - `restocked_quantity` integer, nullable, required — The number of returned inventory items that have been restocked.
      - `return_reason` string, nullable, required — The reason for the return.
    - `shipments` ReturnShipment[], required — List of the shipments associated with the return.
      - `tracking_number` string, nullable, required — The tracking number of the shipment.
      - `shipped_date` string, date-time, nullable, required — The date the shipment was sent.
      - `arrived_date` string, date-time, nullable, required — The date the shipment arrived.
      - `warehouse_id` string, nullable, required — 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.
      - `carrier_id` string, nullable, required — The ID of the carrier for the shipment.
      - `carrier_name` string, nullable, required — The name of the carrier for the shipment.
      - `scac` string, nullable, required — The Standard Carrier Alpha Code (SCAC) for the shipment.
      - `shipping_cost` number, nullable, required — The cost of the shipment.
      - `measurements` ShipmentMeasurements, required
        - `length` number, nullable, required
        - `width` number, nullable, required
        - `height` number, nullable, required
        - `unit` 'cm' | 'in', nullable, required — The unit of measurement for the size of the shipment.
        - `weight` number, nullable, required
        - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required — The unit of measurement for the weight of the shipment.
      - `line_items` ReturnShipmentLineItem[], required — List of inventory items items in the shipment.
        - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
        - `sku` string, nullable, required
        - `quantity` integer, required — How many units were shipped.
        - `receiving_details` ReceivingDetails[], required — Details about received items in the shipment.
          - `quantity` integer, required — How many units were received in this condition and disposition.
          - `condition` string, nullable, required — The condition of the item received.
          - `disposition` string, nullable, required — The disposition of the item received, eg restocked or discarded.
    - `external_system_url` string, nullable, required — URL link to the return in the external system (WMS/Freight etc).
    - `trackstar_tags` unknown[], nullable, required — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
      - unknown
    - `additional_fields` object, required — Integration-specific fields
    - `trackstar_created_date` string, date-time, required
    - `trackstar_updated_date` string, date-time, required
  - `next_token` string, nullable, required — See [pagination](/how-to-guides/about-the-api#pagination) for more details.
  - `total_count` integer, required — The number of items returned.

## Other responses

- `422` — Validation error

---

[API](https://skmtc.net/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.net/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/versions/4bc5c6e1a8bf/schema)