---
title: "View delivery note"
method: GET
path: "/api/v1/deliveryNotes/{id}"
tags: ["Delivery Note"]
---

# View delivery note

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

Returns details of a delivery note

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

Operation completed successfully.

- object
  - `data` object — Data representation of a single delivery note
    - `id` string — Resource identifier.
    - `documentNumber` string — Internal identification for the delivery note
    - `salesOrder` object, nullable — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `transactionNumber` string — Transaction number associated with a delivery note
    - `customerOrderNumber` string, nullable — Customer order associated with a delivery note
    - `salesChannel` object, nullable — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `bodyIntroduction` string — Initial description message for delivery note
    - `bodyOutroduction` string — Ending description message for delivery note
    - `internalDesignation` string — Internal designation for delivery note
    - `date` string, date — Date of creation of a delivery note
    - `status` 'completed' | 'created' | 'released' | 'canceled' | 'unknown' — Status of the delivery note
    - `customer` object — Customer linked to a Sales Order
      - `id` string — Resource identifier.
      - `number` string, nullable
    - `comment` string, nullable — Comment included in the delivery note
    - `project` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `language` object — Language information for a Sales Order
      - `iso2` string, nullable, required — ISO 639-1 Code
    - `updatedAt` string, datetime, nullable — Update date
    - `log` object — Log information
      - `createdAt` string, date-time, nullable — Creation date
      - `createdBy` object — Author
        - `id` string — Resource identifier.
        - `name` string
        - `email` string, email
    - `delivery` object — Delivery information for the delivery note
      - `shippingMethod` object, required — Reference to another resource
        - `id` string, required — Resource identifier.
      - `deliveryTerms` object, nullable — Nullable reference to another resource
        - `id` string, required — Resource identifier.
      - `shippingAddress` object
        - `type` 'herr' | 'frau' | 'firma' | 'other'
        - `name` string, required
        - `department` string
        - `contactPerson` string
        - `subDepartment` string
        - `street` string, required
        - `zipCode` string, required
        - `city` string, required
        - `state` string
        - `country` string, required
        - `addressSupplement` string
        - `gln` string
        - `email` string
        - `title` string
        - `phoneNumber` string
        - `fax` string
        - `salutation` string, nullable
      - `email` string, email
      - `conditions` string
    - `tags` object[] — Tags associated with the delivery note
      - `id` string, required — Resource identifier.
      - `type` string, nullable
      - `title` string, nullable
    - `positions` object[] — Items included within the delivery note
      - `id` string — Resource identifier.
      - `quantity` number, float, required
      - `deliveredQuantity` number, float
      - `comment` string
      - `product` object, required
        - `id` string, required — Resource identifier.
        - `name` string
        - `description` string
        - `freeFields` object[], nullable
          - `id` string, required — Resource identifier.
          - `value` string, required
        - `number` string, nullable
      - `stockMovements` object[]
        - `storageLocation` object
          - `id` string — Resource identifier.
        - `warehouse` object
          - `id` string — Resource identifier.
        - `quantity` number, float
        - `qualityControlAttributes` object, nullable
          - `quantity` number, float
          - `batch` string, nullable
          - `bestBeforeDate` string, date, nullable
          - `serialNumbers` object[], nullable
            - `number` string

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges

---

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