v1
latestOpenAPI 3.0.02026-07-2455104.8 MBSalesOrder
View sales order V3
This endpoint requires the following scopes: salesOrder:read.
View a single sales order
Content Negotiation: This endpoint supports additional response formats: application/pdf. Use the Accept header to request a specific format.
get/api/v3/salesOrders/{id}
Path parameters
idstring required
Query parameters
includestring[]
Response
View a single sales order
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",
"financials": {
"paymentMethod": {
"id": "1"
},
"paymentTerms": {
"paymentTargetDays": 30,
"paymentTargetDiscount": 2.5,
"paymentTargetDiscountDays": 10
},
"tax": {
"taxation": "domestic",
"taxRates": {
"standard": 19,
"reduced": 7
}
},
"currency": "EUR",
"exchangeRate": 1.0875
},
"totals": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
},
"contributionMargin": 42
},
"offer": {
"id": "13"
},
"preferredWarehouse": {
"id": "15"
},
"sales": {
"id": "1"
},
"status": "released",
"deviatingShipToAddress": {
"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"
},
"externalOrderNumber": "EXT-12345",
"customerOrderNumber": "CUST-54321",
"transactionNumber": "TXN-1234567890",
"externalOrderId": "EXT-ORDER-12345",
"desiredDeliveryDate": "2023-10-15",
"earliestFulfillmentDate": "2023-10-10",
"reservationDate": "2023-10-05",
"commissionConsignmentWarehouse": {
"id": "16"
},
"storageCountry": "DE",
"autoDispatch": true,
"vatChecked": true,
"createDocuments": "deliveryNoteAndInvoice",
"deviatingDebtorAccountNumber": "4001-12345",
"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",
"taxRate": "standard",
"effectiveTaxRate": 19,
"price": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"discount": 10,
"itemRevenue": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"lineItemRevenue": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"purchasePrice": {
"net": {
"amount": "13.37",
"currency": "EUR"
}
},
"contributionMargin": 0.25,
"taxLegalNotice": "Tax exempt according to §19 UStG",
"externalNumber": "WEB-12345",
"parentLineItem": {
"id": "1"
},
"desiredQualityControlAttributes": {
"bestBeforeDate": "2024-12-31",
"batch": "BATCH-12345"
}
}
],
"directDebitDate": "2023-10-05",
"shippingMethod": {
"id": "16"
},
"effectiveAddresses": {
"soldTo": {
"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"
},
"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"
}
},
"masterReferenceNumber": "24DE1234567890ABCD",
"salesChannel": {
"id": "3"
},
"costCenter": "CC-123"
}
}