v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Delivery Note

View delivery note

Returns details of a delivery note

get/api/v1/deliveryNotes/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "1",
    "documentNumber": "200001",
    "salesOrder": {
      "id": "1"
    },
    "transactionNumber": "transaction1",
    "customerOrderNumber": "customerOrder1",
    "salesChannel": {
      "id": "1"
    },
    "bodyIntroduction": "Initial info",
    "bodyOutroduction": "Additional info",
    "internalDesignation": "internalDN1",
    "date": "2025-01-01",
    "status": "completed",
    "customer": {
      "id": "1"
    },
    "comment": "A comment about this delivery note",
    "project": {
      "id": "1"
    },
    "language": {
      "iso2": "DE"
    },
    "log": {
      "createdAt": "2023-12-01 00:00:00",
      "createdBy": {
        "id": "1",
        "name": "User 1"
      }
    },
    "delivery": {
      "autoShipping": true,
      "fastLane": true,
      "shippingMethod": {
        "id": "1"
      },
      "shippingCosts": [
        {
          "id": "1",
          "quantity": 3,
          "shippingCostProduct": {
            "id": "1"
          }
        }
      ],
      "email": "user.email@email.org",
      "conditions": "none"
    },
    "tags": [
      {
        "id": "1"
      }
    ],
    "positions": [
      {
        "product": {
          "id": "1"
        },
        "quantity": 5,
        "comment": "Some comment",
        "stockMovements": [
          {
            "storageLocation": {
              "id": "1"
            },
            "warehouse": {
              "id": "1"
            },
            "quantity": 5,
            "qualityControlAttributes": {
              "quantity": 5,
              "batch": "batch1",
              "bestBeforeDate": null,
              "serialNumbers": null
            }
          }
        ]
      }
    ]
  }
}