Order-X API

Order-X Tool Demnächst verfügbar

Automated generation of hybrid orders

Similar to the E‑Invoice API, the Order‑X API provides endpoints for automatically generating, validating, and processing standard‑compliant hybrid orders across all Order‑X profiles (Basic, Comfort, Extended). Orders can be dispatched immediately after creation — either via connected partner data or entirely without any master data. Optional audit‑safe archiving ensures each order is stored cleanly and consistently. The API returns structured payloads, clear error reports, and stable endpoints that integrate seamlessly into existing systems. A solid foundation for future‑ready, fully standardized ordering workflows.

Token

Generate Token

Sample Data

{
  "options": {
    "archive": false,
    "format": "ORDER_X_EXTENDED_V1_0",
    "fileFormat": "HYBRID",
    "language": "DE"
  },
  "additionalData": {
    "regulatoryInformation": {
      "companyManagements": [
        {
          "firstName": "Max",
          "lastName": "Mustermann"
        },
        {
          "firstName": "Thomas",
          "lastName": "Mustermann"
        }
      ],
      "companyManagementLabel": "Geschäftsführer",
      "mainOffice": "Bielefeld",
      "registrarOfCompany": "Amtsgericht Bielefeld",
      "commercialRegisterNumber": "HRB123456"
    }
  },
  "order": {
    "document": {
      "orderType": "ORDER",
      "documentNumber": "2025-0014",
      "issueDate": "2025-09-26",
      "effectivePeriod": {
        "startDateTime": "2025-09-26 00:00",
        "endDateTime": "2025-10-02 18:00"
      },
      "purposeCode": "9",
      "headerNote": {
        "content": "Sehr geehrte Damen und Herren,\ngerne möchten wir folgende Bestellung abgeben:"
      },
      "footerNote": {
        "content": "Bei Fragen stehen wir Ihnen jederzeit gerne zur Verfügung.\n\nMit freundlichen Grüßen,\nMax Mustermann"
      }
    },
    "transaction": {
      "documentLines": [
        {
          "lineId": "1",
          "product": {
            "id": "PN000002",
            "name": "Teebeutel Mango",
            "description": "1 Kilogramm Teebeutel Mango Geschmacksrichtung"
          },
          "agreement": {
            "netPrice": {
              "amount": 64.99
            }
          },
          "delivery": {
            "requestedQuantity": {
              "quantity": 3,
              "unitCode": "KGM"
            }
          },
          "settlement": {
            "tradeTax": {
              "categoryCode": "S",
              "ratePercent": 19
            },
            "summation": {
              "lineTotalAmount": 194.97
            }
          }
        },
        {
          "lineId": "2",
          "product": {
            "id": "PN000004",
            "name": "Tasse mit personalisierten Logo",
            "description": "Tee Tasse für jeden Anlass + personalisiertes Logo",
            "characteristics": [
              {
                "description": "Schriftzug",
                "value": "obwyse Developerportal"
              }
            ]
          },
          "agreement": {
            "netPrice": {
              "amount": 14.99
            }
          },
          "delivery": {
            "requestedQuantity": {
              "quantity": 1,
              "unitCode": "H87"
            }
          },
          "settlement": {
            "allowanceCharges": [
              {
                "chargeIndicator": false,
                "actualAmount": 2.00,
                "reason": "Sonderangebot"
              }
            ],
            "tradeTax": {
              "categoryCode": "S",
              "ratePercent": 19
            },
            "summation": {
              "lineTotalAmount": 12.99,
              "allowanceTotalAmount": 2.00
            }
          }
        }
      ],
      "agreement": {
        "buyer": {
          "name": "Besteller GmbH",
          "contacts": [
            {
              "personName": "Max Mustermann",
              "emailAddress": "test@demo-email.de",
              "phoneNumber": "+49 123 4567890"
            }
          ],
          "vatRegistrations": [
            "DE123456788"
          ],
          "postalAddress": {
            "addressLineOne": "Hauptstraße 16",
            "postalCode": "33611",
            "area": "Bielefeld",
            "country": "DE"
          }
        },
        "seller": {
          "id": "Lieferant-0001",
          "name": "Tee Prinzessin GmbH",
          "contacts": [
            {
              "personName": "Laura Tiedemann",
              "emailAddress": "l.tiedemann@tee-prinzessin.de",
              "phoneNumber": "+49 0521 112223-44"
            }
          ],
          "taxRegistrations": [
            "5133081508159"
          ],
          "postalAddress": {
            "addressLineOne": "Hibiskusallee 17",
            "postalCode": "33611",
            "area": "Bielefeld",
            "country": "DE"
          }
        }
      },
      "delivery": {
        "shipTo": {
          "name": "Warenempfänger GmbH",
          "contacts": [
            {
              "personName": "Tim Mustermann",
              "emailAddress": "t.mustermann@warenempfaenger.de",
              "phoneNumber": "+49 0521 556667-99"
            }
          ],
          "postalAddress": {
            "addressLineOne": "Apfelstraße 7",
            "postalCode": "33611",
            "area": "Bielefeld",
            "country": "DE"
          }
        },
        "deliveryEvents": [
          {
            "date": "2025-10-06"
          }
        ]
      },
      "settlement": {
        "currency": "EUR",
        "taxBreakdown": [
          {
            "basisAmount": 207.96,
            "calculatedAmount": 56.61,
            "ratePercent": 19,
            "typeCode": "VAT",
            "categoryCode": "S"
          }
        ],
        "summation": {
          "lineTotalAmount": 207.96,
          "taxBasisTotalAmount": 207.96,
          "taxTotalAmount": 56.61,
          "grandTotalAmount": 264.57
        }
      }
    }
  }
}