Skip to main content

DeviationPostRequest

Request to register a deviation on an order

deviationMomentExternalDeviationMoment (string)

Enum for deviation moments that can be registered by external systems.

Possible values: [PickUp, Deliver]

descriptionstringrequired

Description of the deviation

Possible values: non-empty and <= 1000 characters

Example: Pallet 3 was damaged on arrival
documentData object

A document encoded in Base64 for upload

fileNamestringnullable

Name of the file including extension

Example: delivery_note.pdf
fileContentTypestringnullable

MIME content type of the file. If omitted, it will be inferred from the file extension.

Example: application/pdf
fileContentBase64stringnullable

File content encoded as a Base64 string. Do not include the Data URI prefix (e.g. "data:image/png;base64,").

Example: JVBERi0xLjQKJcOkw7zDtsOf...
documentURLstringnullable

URL to a single externally hosted document supporting the deviation (Optional)

Example: https://example.com/documents/damage_12345.jpg
DeviationPostRequest
{
  "deviationMoment": "PickUp",
  "description": "Pallet 3 was damaged on arrival",
  "documentData": {
    "fileName": "delivery_note.pdf",
    "fileContentType": "application/pdf",
    "fileContentBase64": "JVBERi0xLjQKJcOkw7zDtsOf..."
  },
  "documentURL": "https://example.com/documents/damage_12345.jpg"
}