Update a Shipment Exception
For client-created requested_hold_to_collect
Shipment Exception resources with a new
status, you may update the resource to change the hold_until
or release the hold by changing the status
to resolved.
This endpoint supports two different request body formats: one request body includes a hold_until
parameter where the value is in the YYYY-MM-DD
format; the other accepted body format includes a status
where the value may be resolved
.
hold_until
date cannot be greater than 30 days from the associated shipmentscreated_at
timestamp.Clients can only update shipment exceptions created by the client -- not shipment exceptions created by Arta.
Path parameters
-
shipment_exception_id parameter
Body
-
shipment_exception object
PATCH /shipment_exceptions/{shipment_exception_id}
curl \
-X PATCH https://api.arta.io/shipment_exceptions/{shipment_exception_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"shipment_exception":{"hold_until":"2023-08-15"}}'
Request examples
Update hold until
{
"shipment_exception": {
"hold_until": "2023-08-15"
}
}
{
"shipment_exception": {
"status": "resolved"
}
}
Response examples (200)
With hold until updated
{
"id": "f45a4526-53af-4c0a-8f1a-b6967dd87c01",
"type": "requested_hold_to_collect",
"source": "api",
"status": "new",
"created_at": "2023-08-01T17:45:58.515371",
"hold_until": "2023-08-15",
"package_id": null,
"resolution": null,
"updated_at": "2023-08-01T17:45:58.515371",
"shipment_id": "1961490f-2020-4035-b48b-254ba9900bab",
"exception_type_label": null
}
{
"id": "f45a4526-53af-4c0a-8f1a-b6967dd87c01",
"type": "requested_hold_to_collect",
"source": "api",
"status": "resolved",
"created_at": "2023-08-01T17:45:58.515371",
"hold_until": null,
"package_id": null,
"resolution": null,
"updated_at": "2023-08-01T17:45:58.515371",
"shipment_id": "1961490f-2020-4035-b48b-254ba9900bab",
"exception_type_label": null
}