---
title: "View return"
method: GET
path: "/api/v1/returns/{id}"
tags: ["Return"]
---

# View return

`GET /api/v1/returns/{id}`

Return details of an existing return

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

One return.

- object
  - `data` object — Representation of a Return order
    - `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' — Status of the Return order
    - `progress` 'announced' | 'received' | 'checked' | 'done' — Proress of the Return order
    - `documentNumber` string, nullable — Internal identification of the Return order
    - `bodyOutroduction` string — Free text for return note
    - `internalComment` string — Internal comment about the return.
    - `shippingMethod` object — Shipping method used for the return note
      - `id` integer
      - `name` string
    - `project` object — Project of return
      - `id` integer
      - `name` string
    - `salesOrder` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `positions` object[], required — Items included within the Return order
      - `id` string, required — Resource identifier.
      - `quantity` number, double, required
      - `salesOrderPosition` object, nullable, required — Nullable reference to another resource
        - `id` string, required — Resource identifier.
      - `product` object, required
        - `id` string, required — Resource identifier.
        - `number` string, required
        - `name` string, required
      - `returnReason` object, required
        - `designation` string, nullable, required

## 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)