---
title: "List all returns"
method: GET
path: "/commerce/{connection_id}/return"
tags: ["commerce", "return"]
---

# List all returns

`GET /commerce/{connection_id}/return`

## Request

- Base URL: `https://api.unified.to`
- URL: `https://api.unified.to/commerce/{connection_id}/return`
- Auth: API key in header `authorization`
- TypeScript: <https://skmtc.dev/unified/apis/unified-to-api/docs/commerce/:connection_id/return/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of CommerceReturns. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string
- `sort` string
- `order` string
- `query` string
- `order_id` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- CommerceReturn[]
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `order_id` string
  - `status` 'REQUESTED' | 'OPEN' | 'APPROVED' | 'REJECTED' | 'CLOSED' | 'CANCELLED' | 'OTHER'
  - `type` string
  - `currency` string
  - `total_refund_amount` number
  - `customer_email` string
  - `customer_name` string
  - `return_by_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `lineitems` CommerceReturnLineitem[]
    - `id` string
    - `order_line_id` string
    - `item_id` string: (reference to CommerceItem)
    - `sku` string
    - `name` string
    - `quantity` number
    - `refund_amount` number
    - `reason` string
    - `status` string
    - `raw` object
  - `metadata` CommerceMetadata[]
    - `id` string: The ID of the custom field definition (from the metadata/metadata endpoint).
    - `value` union: The field's value, typed by `format`: DATE as ISO-8601 (`YYYY-MM-DD`, or `YYYY-MM-DDTHH:MM:SSZ` for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL': The data type of the custom field, which determines how `value` is formatted.
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `slug` string: The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
    - `description` string
    - `is_required` boolean
  - `raw` object

## Changes

- **2026-10-30** `86953cae0191`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/unified/apis/unified-to-api/changes/commerce/:connection_id/return/get.md)

---

[API](https://skmtc.dev/unified/apis/unified-to-api.md) - [All operations](https://skmtc.dev/unified/apis/unified-to-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api/revisions/266f05d14af8?raw)