DeviationPostResponse
Response returned after registering a deviation on an order
referencestringrequired
The Swipref, a unique id in Swipload
Possible values: non-empty
Example:
COAZ481deviationMomentExternalDeviationMoment (string)required
Enum for deviation moments that can be registered by external systems.
Possible values: [PickUp, Deliver]
descriptionstringrequired
Description of the deviation
Possible values: non-empty
Example:
Pallet 3 was damaged on arrivalcreatedDatestring<date-time>required
Timestamp the deviation was registered
Example:
2024-08-22T13:00:00createdByEmailstringnullable
Email of the user the api-token resolved to
Example:
integrations@example.comdocumentUploadedbooleanrequired
Whether a document was stored with the deviation
Example:
truedocumentErrorstringnullable
Why no document was stored, when one was requested via DocumentURL but could not be downloaded. The deviation itself was still registered. Null when a document was stored, and when none was supplied.
Example:
Failed to download document from URL. Status code: NotFoundDeviationPostResponse
{
"reference": "COAZ481",
"deviationMoment": "PickUp",
"description": "Pallet 3 was damaged on arrival",
"createdDate": "2024-08-22T13:00:00",
"createdByEmail": "integrations@example.com",
"documentUploaded": true,
"documentError": "Failed to download document from URL. Status code: NotFound"
}