v1
latestOpenAPI 3.0.02026-07-2455104.8 MBDeliveryNote
🔒 Create delivery note V3
This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.
This endpoint requires the following scopes: deliveryNote:create.
Create a new delivery note.
post/api/v3/deliveryNotes
Request body
Example request
{
"address": {
"id": "13"
},
"project": {
"id": "13"
},
"documentDate": "2025-07-15",
"language": "en",
"tags": [
{
"title": "important"
}
],
"documentAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"internalDesignation": "FB-3860-L",
"bodyIntroduction": "Dear Sir or Madam,",
"bodyOutroduction": "With kind regards,",
"vatId": "DE123456789",
"deliveryTerms": "Lieferung frei Haus",
"internalComment": "This is an internal comment.",
"editor": {
"id": "6"
},
"costCenter": "CC-1234",
"preferredWarehouse": {
"id": "42"
},
"sales": {
"id": "5"
},
"salesOrder": {
"id": "13"
},
"orderPicking": {
"id": "13"
},
"masterReferenceNumber": "MRN-123456",
"commissionConsignmentWarehouse": {
"id": "16"
},
"lineItems": [
{
"product": {
"id": "13"
},
"name": "Product X",
"description": "Description of Product X",
"countryOfOrigin": "DE",
"hsCode": "0101.21",
"deliveryDate": "2025-07-20",
"internalComment": "This is an internal note.",
"customerProductNumber": "CUS-10077",
"unit": "pcs",
"deliveredQuantity": 10.5
}
]
}Response
Create a new delivery note.
Example response
{
"data": {
"id": "1",
"documentNumber": "I-12343",
"documentDate": "2023-10-01",
"customerNumber": "CUST-54321",
"address": {
"id": "42",
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
},
"project": {
"id": "54",
"name": "Standard Project",
"abbreviation": "STANDARD"
},
"tags": [
{
"id": "4",
"title": "important"
}
],
"documentAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"internalDesignation": "FB-3860-L",
"language": "de",
"bodyIntroduction": "Dear customer, we are pleased to send you the following invoice.",
"bodyOutroduction": "Thank you for your business.",
"vatId": "DE123456789",
"deliveryTerms": "DDP",
"internalComment": "This is an internal comment.",
"editor": {
"id": "4"
},
"activity": [
{
"message": "Invoice released",
"causer": "John Doe",
"causedAt": "2023-01-01T00:00:00Z"
}
],
"customFields": [
{
"key": "customer_category",
"value": "Premium",
"label": "Customer Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"updatedAt": "2023-10-01T12:00:00Z",
"createdAt": "2023-10-01T12:00:00Z",
"salesOrder": {
"id": "13"
},
"preferredWarehouse": {
"id": "15"
},
"sales": {
"id": "1"
},
"status": "released",
"customerOrderNumber": "CUST-54321",
"commissionConsignmentWarehouse": {
"id": "16"
},
"supplierNumber": "SUP-98765",
"invoice": {
"id": "42"
},
"orderPicking": {
"id": "12"
},
"lineItems": [
{
"type": "product",
"id": "1",
"number": "2462-SK-D",
"name": "Strawberry Jam",
"description": "Delicious strawberry jam made from fresh strawberries.",
"quantity": 2,
"product": {
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
},
"customFields": [
{
"key": "customer_category",
"value": "Premium",
"label": "Customer Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"unit": "kg",
"packagingUnit": "box",
"internalComment": "This is an internal comment.",
"customerProductNumber": "CUS-10077",
"order": 5,
"updatedAt": "2023-10-01T12:00:00Z",
"createdAt": "2023-10-01T12:00:00Z",
"salesOrderLineItem": {
"id": "1"
},
"deliveredQuantity": 2,
"parentLineItem": {
"id": "1"
},
"desiredQualityControlAttributes": {
"bestBeforeDate": "2024-12-31",
"batch": "BATCH-12345"
},
"customs": {
"valueSingle": {
"amount": "13.37",
"currency": "EUR"
},
"valueTotal": {
"amount": "13.37",
"currency": "EUR"
},
"weightSingle": 0.5,
"weightTotal": 5
},
"sscc": "123456789012345678",
"package": "PKG-001",
"packagingUnitQuantity": 5,
"individualPieceQuantity": 10
}
],
"shippingMethod": {
"id": "16",
"name": "Standard Shipping"
},
"masterReferenceNumber": "24DE1234567890ABCD",
"effectiveAddresses": {
"shipTo": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
}
},
"costCenter": "CC-123"
}
}