Shipment Notes (Seller)

DRAFT, not yet in production. This endpoint is not available in any environment yet. The contract may change before release.

Overview

As a seller, you send a shipment note, also known as a despatch advice (DESADV), delivery note or ASN, when goods leave your site for orders you received on Consentio. Consentio matches each line to the order line it answers. When the shipment note is applied, each line's quantity is recorded as the despatched quantity of that order line, so the buyer sees what was shipped against what was ordered. Several shipment notes for the same order add up.

Endpoints

Dry run. Send the header X-Dry-Run: true to validate and match a shipment note without saving it: you get the response you would get, and nothing changes. Use it while building your integration.

Request fields

Shipment note

Lines (lines[])

See the API Reference for the full schema and examples.

Responses

On 2xx responses, each line comes back with a status (matched, unmatched, held) and its issues:

Order lines that no shipment note line covered are listed in order_lines_not_despatched[].

Response fields

Result (200 / 201 / 202):

Result

Lines (lines[])

Error (400 / 404 / 409 / 422):

Error

Errors (errors[])

Examples: which response, and when

All examples use the same order and shipment note. You received order KX9P4Q2M7T:

and you send shipment note BL260098812 for it.

Nothing is ever half-applied. Either the whole shipment note is applied (201 or 200), or nothing is (202, 400, 409, 422).

Response bodies

201, applied with issues (cases 2, 3 and 4 together). You send bananas short, an article that was not ordered, and no tomatoes:

{
  "number": "BL260098812",
  "despatched_at": "2026-10-21T03:30:00+02:00",
  "lines": [
    { "id": "1", "order_number": "KX9P4Q2M7T", "buyer_code": "10023456", "quantity": 18, "quantity_unit": "box" },
    { "id": "2", "order_number": "KX9P4Q2M7T", "buyer_code": "10034567", "quantity": 30, "quantity_unit": "box" },
    { "id": "3", "order_number": "KX9P4Q2M7T", "buyer_code": "10099999", "quantity": 5, "quantity_unit": "box" }
  ]
}

{
  "number": "BL260098812",
  "version": 1,
  "status": "applied",
  "lines": [
    { "id": "1", "status": "matched",
      "issues": [{ "code": "SHORT_SHIPPED", "message": "ordered 20 box, despatched 18 box" }] },
    { "id": "2", "status": "matched", "issues": [] },
    { "id": "3", "status": "unmatched",
      "issues": [{ "code": "NOT_ORDERED", "message": "10099999 is not on order KX9P4Q2M7T" }] }
  ],
  "order_lines_not_despatched": [
    { "order_number": "KX9P4Q2M7T", "order_line_number": "1", "buyer_code": "10012345",
      "ordered_quantity": 40, "quantity_unit": "box" }
  ]
}

400, invalid request (case 9):

{
  "error_code": "INVALID_REQUEST",
  "message": "lines[0].quantity_unit must be one of box, pallet, kg, piece",
  "errors": [
    { "index": 0, "id": "1", "field": "quantity_unit", "message": "must be one of box, pallet, kg, piece" }
  ]
}

409, duplicate number (case 6):

{
  "error_code": "DUPLICATE_DOCUMENT_NUMBER",
  "message": "BL260098812 was already received with different content; send function replace"
}

422, order not found (case 10):

{
  "error_code": "ORDER_NOT_FOUND",
  "message": "order KX9P4Q2M7 not found",
  "errors": [
    { "index": 0, "id": "1", "field": "order_number", "message": "order KX9P4Q2M7 not found" }
  ]
}