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

# List provisional returns

`GET /api/v1/provisionalReturns`

Lists existing provisional 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.
- `order` object[]
  - `field` 'deliveryNoteId'
  - `dir` 'asc' | 'desc'
- `filter` object[]
  - `key` 'salesOrder'
  - `op` 'equals' | 'in'
  - `value` union
    - string
    - string[] — Used for the operations 'in'.

## Response `200`

Provisional Return list

- object
  - `data` object[], required
    - `id` string, required — Resource identifier.
    - `tracking` object, required — Tracking information for the provisional return
      - `number` string, required — The tracking number provided by the carrier.
    - `deliveryNote` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `salesOrder` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
  - `extra` object, required
    - `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
- `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)