---
title: "List deliveries"
method: GET
path: "/api/v1/deliveries"
tags: ["Delivery"]
---

# List deliveries

`GET /api/v1/deliveries`

Lists existing deliveries

## 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` 'salesOrderId'
  - `dir` 'asc' | 'desc'
- `filter` object[]
  - `key` 'salesOrderId' | 'shippingMethodId' | 'deliveryNoteId' | 'trackingNumber' | 'carrier' | 'sentAt' | 'sentAtTimestamp', required — Field to filter by.
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'lessThan' | 'lessThanOrEquals' | 'greaterThan' | 'greaterThanOrEquals' | 'startsWith' | 'endsWith', required — Operator to use for filtering.
  - `value` union, required
    - string — Always passed as string in query; backend parses as string, numeric, date, or datetime based on 'key'.
    - string[] — Used for the 'in' operator. Items must be strings representing numeric, date, etc.

## Response `200`

Delivery list

- object
  - `data` object[], required
    - `id` string, required — Resource identifier.
    - `tracking` object, required — Tracking information for the delivery
      - `number` string, required — The tracking number provided by the carrier.
      - `link` string — Carrier tracking link
      - `carrier` string — Carrier that shipping the delivery
    - `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.
    - `shippingMethod` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `sentAt` string, date, nullable — Date when the delivery was sent
    - `sentAtTimestamp` string, datetime, nullable — Timestamp when the delivery was sent
    - `label` object, nullable — Shipping label for the delivery
      - `fileType` string, required — Label's file type
      - `fileContent` string, required — Base 64 encoded label
    - `additionalPackages` object[] — Additional parcels associated with this shipment
      - `id` string, required — Resource identifier.
      - `trackingNumber` string, nullable, required — The tracking number for this parcel.
      - `weight` number, float, nullable — Weight of the parcel
      - `createdAt` string, datetime, nullable — Creation timestamp of the parcel record
      - `updatedAt` string, datetime, nullable — Last update timestamp of the parcel record
  - `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.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)