Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Delivery Note

List delivery notes

Returns all delivery notes with pagination and filtering options.

get/api/v1/deliveryNotes

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id, deliveryNoteNumber'
dir'asc' | 'desc'
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'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "number": "200001",
      "createdAt": "2024-01-01 00:00:00",
      "updatedAt": "2024-01-01 00:00:00",
      "documentDate": "2024-01-01",
      "receiver": {
        "name": "Mr. John Doe",
        "number": "10"
      },
      "country": "DE",
      "project": {
        "id": "1"
      },
      "shippingMethod": {
        "id": "1"
      },
      "type": "type",
      "status": "created",
      "salesOrder": {
        "id": "1337"
      }
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}