v1
latestOpenAPI 3.0.02026-07-2455104.8 MBReturnOrder
🔒 Update return order 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: return:update.
Update a return order.
patch/api/v3/returnOrders/{id}
Path parameters
idstring required
Request body
Example request
{
"documentDate": "2025-07-15",
"documentAddress": {
"type": "company",
"name": "John Doe",
"title": "Dr.",
"contactPerson": "Jane Smith",
"department": "Sales",
"subDepartment": "International",
"addressSupplement": "Building A",
"street": "123 Main St",
"zipCode": "12456",
"city": "Springfield",
"state": "Illinois",
"country": "US",
"gln": "1234567890123",
"salutation": "Dear John,",
"email": "john@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"project": {
"id": "13"
},
"internalDesignation": "FB-3860-L",
"bodyIntroduction": "Sehr geehrte Damen und Herren,",
"bodyOutroduction": "Mit freundlichen Grüßen",
"vatId": "DE123456789",
"deliveryTerms": "Lieferung frei Haus",
"internalComment": "This is an internal comment.",
"language": "en",
"editor": {
"id": "6"
},
"tags": [
{
"title": "important"
}
],
"sales": {
"id": "5"
},
"salesOrder": {
"id": "13"
},
"creditNote": {
"id": "66"
},
"deliveryNote": {
"id": "77"
},
"replacementSalesOrder": {
"id": "66"
},
"customerOrderNumber": "ORD-67890",
"useAlternativeDocumentTitle": true,
"progress": "announced"
}Response
Update a return 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",
"salesOrder": {
"id": "13"
},
"invoice": {
"id": "13"
},
"preferredWarehouse": {
"id": "15"
},
"sales": {
"id": "1"
},
"status": "released",
"customerOrderNumber": "CUST-54321",
"creditNote": {
"id": "13"
},
"deliveryNote": {
"id": "16"
},
"replacementSalesOrder": {
"id": "20"
},
"progress": "announced",
"supplierNumber": "SUP-98765",
"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,
"reimbursementQuantity": 5.1,
"receivedQuantity": 5.2,
"returnReason": {
"id": "2"
},
"parentLineItem": {
"id": "1"
},
"deliveryNoteLineItem": {
"id": "1"
},
"defaultStorageLocation": {
"id": "1"
}
}
],
"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"
},
"returnTo": {
"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"
}
}
}
}