---
title: "List delivery notes"
method: GET
path: "/api/v1/deliveryNotes"
tags: ["Delivery Note"]
---

# List delivery notes

`GET /api/v1/deliveryNotes`

Returns all delivery notes with pagination and filtering options.

## 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` 'id, deliveryNoteNumber'
  - `dir` 'asc' | 'desc'
- `filter` object[]
  - `key` 'documentDate' | 'createdAt' | 'status' | 'salesOrderId' | 'updatedAt' | 'country' | 'projectId' | 'customerId' | 'customerNumber' | 'shippingAddressName' | 'documentNumber'
  - `op` 'greaterThan' | 'lessThan' | 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'lessThanOrEquals' | 'greaterThanOrEquals'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.

## Response `200`

Operation completed successfully.

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `number` string — Number of the document
    - `createdAt` string, datetime — Creation date of the delivery note
    - `updatedAt` string, datetime — Last update date of the delivery note
    - `documentDate` string, date — Date of the document
    - `receiver` object, nullable — Receiver contact for the delivery
      - `id` string — Resource identifier.
      - `name` string, nullable, required
      - `number` string, nullable, required
    - `country` string — Country code for the delivery
    - `project` object — Project to which the delivery note belongs to
      - `id` string — Resource identifier.
      - `name` string
    - `shippingMethod` object — Shipping method used for the delivery note
      - `id` string — Resource identifier.
      - `name` string
    - `type` string — Internal type of the delivery note
    - `status` 'created' | 'released' | 'canceled' | 'sent' | 'unknown' — Status of the delivery note
    - `salesOrder` object, nullable — Nullable reference to another resource
      - `id` string, required — Resource identifier.
  - `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

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `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)