ConnectCloud Developers

Create a delivery note from an order (tenant:trade:sales:write)

POST /api/trade/v1/sales/order-confirmations/{id}/delivery-notes

Module: Trade · operationId: deliverOrder · Tag: Transactions · Auth: access token (Authorization: Bearer <accessToken>)

Creates a DELIVERY_NOTE in status DELIVERED for the newest revision of the order (any revision id may be given), numbered gaplessly per tenant and year (<prefix of the type>-<year>-<nnnnn>, default LS, year of the delivery date in Europe/Berlin). Partial deliveries are allowed; an empty body or empty lines delivers everything still open. Each line copies article, unit, price and tax rate of its order line and points to it (sourceLineId); the title a line stands under is copied with quantity 0. Partner, address snapshot and the customer's order reference are taken from the order (sourceTransactionId). Deliveries of one order run one at a time, so a line is never delivered beyond its ordered quantity. The stock of the lines' articles is booked out in the same transaction (not for drop shipments). Publishes trade.deliverynote.created.

Parameters

Name In Type Required Description
id path string (uuid) yes

Request body

application/json

  • deliveryDate (string (date-time)): Delivery and document date (default: today for both); its year selects the number counter.
  • lines (array of object): Quantities to deliver; empty or missing delivers everything still open.
    • orderLineId (string (uuid), required): Line of the newest revision of the order.
    • quantity (number, required): Quantity to deliver.
    • serialNumbers (array of string): Stored in lineData.serialNumbers and booked with the stock movement.
  • note (string): Header text of the delivery note.

Example:

{
  "deliveryDate": "2026-11-17T00:00:00Z",
  "lines": [
    {
      "orderLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e01",
      "quantity": 6,
      "serialNumbers": [
        "AP6-24K0113",
        "AP6-24K0114",
        "AP6-24K0115",
        "AP6-24K0116",
        "AP6-24K0117",
        "AP6-24K0118"
      ]
    },
    {
      "orderLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e02",
      "quantity": 1,
      "serialNumbers": [
        "SW24-9K2207"
      ]
    },
    {
      "orderLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e03",
      "quantity": 20
    }
  ],
  "note": "WLAN-Hardware für den Gästebereich"
}

Responses

  • 201 The transaction (application/json)
  • 400 Error (application/json)
  • 401 No valid session or bearer token (no body).
  • 404 Not found in the tenant. (application/json)
  • 409 A line exceeds its open quantity (lineId, open, requested), nothing is left to deliver, the order is not confirmed yet (DRAFT), or it is revoked or cancelled. (application/json)
  • 422 The document is no order, a line id is no deliverable line of the newest revision, or a quantity is negative. (application/json)
  • 423 An active workflow locks the transaction. (application/json)

Fields of the 201 answer:

  • addressId (string (uuid)): Masterdata address of the partner.
  • createdAt (string (date-time), read-only): When the transaction was created.
  • currency (string): ISO 4217; EUR when empty.
  • customerNo (string, read-only): Customer number of the tenant.
  • deliveryDate (string (date-time)): Delivery date.
  • documentDate (string (date-time)): Today when empty on create.
  • documentRefId (string (uuid)): DMS document of the transaction.
  • dueDate (string (date-time)): Due date.
  • eInvoiceValidation (object, read-only): The newest e-invoice check of the document (details: getInvoiceValidation). Set only for invoices and credit notes, only on reads (listTransactions, getTransaction), and absent when no check ran.
  • error (string, read-only): Error of the last processing (e.g. of an inbound invoice).
  • exchangeRate (number): 1 when empty.
  • externalTransactionNumber (string): The other party's number: the supplier's invoice number (inbound invoices) or order confirmation number (purchase orders; only there it is written through this API).
  • footerText (string): Text printed below the lines.
  • frozenSnapshot (object, read-only): Evidence copy of an accepted offer; written once.
  • grossTotal (number, read-only): Gross total, computed from the lines.
  • headerText (string): Text printed above the lines.
  • id (string (uuid), read-only): Id of the transaction.
  • items (array of TransactionLine): Lines; on update they replace all lines when present.
    • name (string, required): Name of the article or line.
    • quantity (number, required): Quantity.
    • articleNumber (string): Article number in masterdata.
    • createdAt (string (date-time), read-only): When the line was created.
    • description (string): Description of the line.
    • discountPercent (number): Discount in percent.
    • ean (string): EAN (GTIN) of the article.
    • id (string (uuid), read-only): Id of the line.
    • isOptional (boolean): The line is optional (position type optional).
    • isSelected (boolean): Selected optional lines count in the totals.
    • lineData (object): Facts of the line by type (e.g. serial numbers, sources).
    • mpn (string): Manufacturer part number.
    • parentItemId (string (uuid)): Line this line belongs to (e.g. a component of a bundle).
    • positionNumber (integer, read-only): Set from the order of items.
    • positionType (PositionType): Empty is normal; the totals count normal lines and selected optional lines. (one of normal, optional, title, subtotal, text)
    • predecessorLineId (string (uuid), read-only): The line of the previous version.
    • productId (string (uuid)): Masterdata article (product) id.
    • sortOrder (integer): Sort order (ascending).
    • sourceLineId (string (uuid), read-only): Line this one was made from (order line of a delivery note or draft invoice, invoice line of a credit note). Set by the system; a value sent by a client is dropped.
    • taxRate (number): Percent.
    • totalPriceGross (number, read-only): Gross total of the line, computed.
    • totalPriceNet (number, read-only): Net total of the line, computed.
    • transactionId (string (uuid), read-only): Id of the transaction.
    • unit (string): Unit of measure.
    • unitPriceNet (number): Negative for a credit position.
    • updatedAt (string (date-time), read-only): When the line was last changed.
  • metadata (object): metadata.workflow is owned by the workflow module and kept on every write.
  • netDays (integer): Days until the net amount is due.
  • netTotal (number, read-only): Computed from the lines.
  • numberPending (boolean, read-only): A draft invoice or credit note another module made: transactionNumber is its id until releaseTransaction gives it the gapless number. Edits keep its number and status.
  • opportunityId (string (uuid)): The crm opportunity the document was made for. Only the format is checked (400 invalid, field opportunityId). A document made from another one (sourceTransactionId, e.g. the order of an accepted offer) inherits it; an update without it keeps the stored one. Carried in the events trade.transaction.* and trade.offer.accepted.
  • partnerReference (string): The partner's order reference (BT-13).
  • paymentMethodCode (string): Code of the payment method in masterdata.
  • paymentTermCode (string): Code of the payment terms: a snapshot taken when the document is made.
  • paymentTermsText (string): Payment terms as printed text.
  • predecessorId (string (uuid)): Previous version of the same document.
  • recipientAddress (object): Address snapshot of the partner.
  • recipientCompany (string): Company of the recipient.
  • recipientEmail (string): E-mail of the recipient.
  • recipientName (string): Name of the recipient.
  • skontoDays1 (integer): Days of the first cash discount.
  • skontoDays2 (integer): Days of the second cash discount.
  • skontoRate1 (number): Rate in percent of the first cash discount.
  • skontoRate2 (number): Rate in percent of the second cash discount.
  • sourceKind (string): Where it came from: MANUAL (default), PORTAL, or the e-invoice/OCR kind of inbound invoices.
  • sourceTransactionId (string (uuid)): Document this one was made from.
  • status (TransactionStatus): Sales statuses are DRAFT, SENT, ACCEPTED, EXPIRED, REVOKED, CONVERTED; delivery notes made from an order are DELIVERED or CANCELLED; issued invoices and credit notes are ISSUED (set only by issueInvoiceDraft); purchase orders, goods receipts, inbound invoices and documents of the snapshot API use their own statuses (e.g. open, posted, MATCHED, issued).
  • taxTotal (number, read-only): Tax total, computed from the lines.
  • tenantName (string, read-only): Name of the tenant.
  • transactionNumber (string): Assigned with the type's prefix when empty on create.
  • transactionType (string): Code of a type of the tenant's catalogue; required on create.
  • typeData (object): Facts of exactly one type (e.g. extraction of inbound invoices, acceptance of accepted offers, sources of a draft invoice, correctedInvoice and returnToStock of a credit note, einvoice of an issued invoice, dropShipDelivery of a drop-ship delivery note, issueRefusal {reason, problems, at, mspInvoiceId} of a draft invoice whose issue the MSP poster refused – issuing it with issueInvoiceDraft marks that MSP invoice posted).
  • updatedAt (string (date-time), read-only): When the transaction was last changed.
  • validUntil (string (date-time)): Offers only.
  • version (integer, read-only): Version of the document (createTransactionRevision adds one).

Example 201 answer:

{
  "addressId": "3c5e7a91-2b4d-4f6a-8c1e-5d7f9a0b1c01",
  "createdAt": "2026-11-17T07:45:00Z",
  "currency": "EUR",
  "customerNo": "99999",
  "deliveryDate": "2026-11-17T00:00:00Z",
  "documentDate": "2026-11-17T00:00:00Z",
  "exchangeRate": 1,
  "grossTotal": 2464.49,
  "headerText": "WLAN-Hardware für den Gästebereich",
  "id": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e03",
  "items": [
    {
      "articleNumber": "NW-2002",
      "id": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f01",
      "lineData": {
        "serialNumbers": [
          "AP6-24K0113",
          "AP6-24K0114",
          "AP6-24K0115",
          "AP6-24K0116",
          "AP6-24K0117",
          "AP6-24K0118"
        ]
      },
      "name": "WLAN Access Point Wi-Fi 6, Deckenmontage",
      "positionNumber": 1,
      "positionType": "normal",
      "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c02",
      "quantity": 6,
      "sortOrder": 1,
      "sourceLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e01",
      "taxRate": 19,
      "totalPriceGross": 1635.06,
      "totalPriceNet": 1374,
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e03",
      "unit": "STK",
      "unitPriceNet": 229
    },
    {
      "articleNumber": "NW-2001",
      "id": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f02",
      "lineData": {
        "serialNumbers": [
          "SW24-9K2207"
        ]
      },
      "name": "Switch 24 Port Gigabit PoE+, managed",
      "positionNumber": 2,
      "positionType": "normal",
      "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c01",
      "quantity": 1,
      "sortOrder": 2,
      "sourceLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e02",
      "taxRate": 19,
      "totalPriceGross": 712.81,
      "totalPriceNet": 599,
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e03",
      "unit": "STK",
      "unitPriceNet": 599
    },
    {
      "articleNumber": "NW-2003",
      "id": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f03",
      "name": "Patchkabel Cat.6a 2 m, grau",
      "positionNumber": 3,
      "positionType": "normal",
      "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c03",
      "quantity": 20,
      "sortOrder": 3,
      "sourceLineId": "9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e03",
      "taxRate": 19,
      "totalPriceGross": 116.62,
      "totalPriceNet": 98,
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e03",
      "unit": "STK",
      "unitPriceNet": 4.9
    }
  ],
  "netTotal": 2071,
  "opportunityId": "7d3c0d5e-2f4b-4c47-9c1e-2b8f5d1a6e90",
  "partnerReference": "Auftrag vom 06.11.2026, K. Stadler",
  "recipientAddress": {
    "city": "Schönau am Königssee",
    "country": "DE",
    "street": "Seestraße 4",
    "zip": "83471"
  },
  "recipientCompany": "Alpenhotel Seeblick GmbH \u0026 Co. KG",
  "recipientName": "Katrin Stadler",
  "sourceKind": "MANUAL",
  "sourceTransactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e02",
  "status": "DELIVERED",
  "taxTotal": 393.49,
  "tenantName": "DEMO",
  "transactionNumber": "LS-2026-0211",
  "transactionType": "DELIVERY_NOTE",
  "updatedAt": "2026-11-17T07:45:00Z",
  "version": 1
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/trade/v1/sales/order-confirmations/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/delivery-notes' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"deliveryDate":"2026-11-17T00:00:00Z","lines":[{"orderLineId":"9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e01","quantity":6,"serialNumbers":["AP6-24K0113","AP6-24K0114","AP6-24K0115","AP6-24K0116","AP6-24K0117","AP6-24K0118"]},{"orderLineId":"9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e02","quantity":1,"serialNumbers":["SW24-9K2207"]},{"orderLineId":"9c2d3e4f-5a6b-4c7d-8e8f-1a2b3c4d5e03","quantity":20}],"note":"WLAN-Hardware für den Gästebereich"}'

View as Markdown · Interactive reference · OpenAPI