Shipment Exception Types
Retrieve the list of shipment exception types
GET /metadata/shipment_exception_types
curl \
-X GET https://api.arta.io/metadata/shipment_exception_types \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
[
{
"id": "change_of_address_request",
"name": "Change of Address Request",
"category": "Alert",
"can_create": false,
"resolutions": [
"Updated without cost changes",
"Updated with additional costs",
"Address could not be changed",
"Returned to Sender"
]
},
{
"id": "customs_information_required",
"name": "Customs Information Required",
"category": "Action Required",
"can_create": false,
"resolutions": [
"EEI Form Submitted"
]
},
{
"id": "damaged_items",
"name": "Damaged Items",
"category": "Alert",
"can_create": false,
"resolutions": [
"Repair",
"Total Loss",
"Partial Loss"
]
},
{
"id": "direct_payment_required",
"name": "Direct Payment Required",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Balance Cleared"
]
},
{
"id": "held_at_customs",
"name": "Held at Customs",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Cleared Customs",
"Returned to Sender"
]
},
{
"id": "inaccurate_object_details",
"name": "Inaccurate Object Details",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Updated without cost changes",
"Updated with additional costs"
]
},
{
"id": "incorrect_address",
"name": "Incorrect Address",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Origin Location Updated w/o Cost Changes",
"Origin Location Updated w/ Additional Costs",
"Destination Location Updated w/o Cost Changes",
"Destination Location Updated w/ Additional Costs"
]
},
{
"id": "lost_in_transit",
"name": "Lost in Transit",
"category": "Alert",
"can_create": false,
"resolutions": [
"Found",
"Permanently Lost"
]
},
{
"id": "not_ready_for_delivery",
"name": "Not Ready for Delivery",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Delivery Rescheduled",
"Returned to Sender"
]
},
{
"id": "not_ready_for_release",
"name": "Not Ready for Release",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Collection Rescheduled"
]
},
{
"id": "other",
"name": "Other",
"category": "Alert",
"can_create": false,
"resolutions": []
},
{
"id": "prepayment_required",
"name": "Prepayment Required",
"category": "Action Required",
"can_create": false,
"resolutions": [
"Balance Cleared"
]
},
{
"id": "requested_hold_to_collect",
"name": "Requested Hold to Collect",
"category": "Shipment Hold",
"can_create": true,
"resolutions": [
"Collection Rescheduled"
]
},
{
"id": "requested_hold_to_deliver",
"name": "Requested Hold to Deliver",
"category": "Shipment Hold",
"can_create": false,
"resolutions": [
"Delivery Rescheduled",
"Returned to Sender"
]
},
{
"id": "wrong_item",
"name": "Wrong Item",
"category": "Alert",
"can_create": false,
"resolutions": [
"Correct Items Delivered"
]
}
]