---
title: "List returns"
method: GET
path: "/api/v1/returns"
tags: ["Return"]
---

# List returns

`GET /api/v1/returns`

Lists existing returns

## Query parameters

- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `filter` object[]
  - `key` 'documentNumber' | 'customerId' | 'salesOrderId' | 'updatedAt' | 'createdAt'
  - `op` 'equals' | 'in' | 'greaterThan' | 'notEquals' | 'lessThanOrEquals' | 'greaterThanOrEquals' | 'isOnOrBefore' | 'isOnOrAfter' | 'notIn' | 'contains'
  - `value` union
    - string
    - string[]

## Response `200`

A list of returns

- object
  - `data` object[] — Data representation of a list of Return orders
    - `id` string, required — Resource identifier.
    - `date` string, date, nullable, required — Date of creation of the Return order
    - `status` 'unknown' | 'open' | 'canceled' | 'completed' | 'sent' | 'created' | 'announced' | 'released' | 'checked' | 'done', required — Status of the Return order
    - `documentNumber` string, nullable, required — Internal identification of the Return order
    - `tags` object[], required — A list of tags
      - `id` string — The identifier of the tag
      - `name` string — The name of the tag
      - `color` string — Hexadecimal color value in 6-digit format without the leading # character.
    - `salesOrder` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `customer` object, nullable, required — Customer linked to the Return order
      - `id` string, required — Resource identifier.
      - `number` string, nullable, required
    - `shippingMethod` object, nullable — Customer linked to the Return order
      - `id` string, required — Resource identifier.
      - `name` string, nullable, required
    - `project` object, nullable — Customer linked to the Return order
      - `id` string, required — Resource identifier.
      - `name` string, nullable, required
    - `progress` string, nullable — Internal identification of the Return order
    - `bodyOutroduction` string, nullable — Internal identification of the Return order
    - `internalComment` string, nullable — Internal identification of the Return order
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) · [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)