Create Shipment Exception
Create a Shipment Exception for a Shipment
Clients can create shipment exceptions of a single type currently:
requested_hold_to_collect
A shipment must have a
pending
orconfirmed
status to create arequested_hold_to_collect
shipment exception.hold_until
date cannot be greater than 30 days from the associated shipment'screated_at
timestamp.
Body
-
shipment_exception object
POST /shipment_exceptions
curl \
-X POST https://api.arta.io/shipment_exceptions \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"shipment_exception":{"type":"requested_hold_to_collect","hold_until":"2023-08-15","shipment_id":"5baff45a-281d-416e-9310-a4a7c637952e"}}'
Request example
{
"shipment_exception": {
"type": "requested_hold_to_collect",
"hold_until": "2023-08-15",
"shipment_id": "5baff45a-281d-416e-9310-a4a7c637952e"
}
}
Response examples (201)
{
"id": "f45a4526-53af-4c0a-8f1a-b6967dd87c01",
"type": "requested_hold_to_collect",
"source": "api",
"status": "new",
"created_at": "2023-08-01T17:45:58.515371",
"package_id": null,
"resolution": null,
"updated_at": "2023-08-01T17:45:58.515371",
"shipment_id": "1961490f-2020-4035-b48b-254ba9900bab",
"exception_type_label": null
}