Assign Shipment to Customer Care
If the shipment must be reassigned to Customer Care (CCUI), either by customer request or due to a reason such as the customer not picking up their order, this API will do so with a simple request. This can not be used to reassign to another location, backorder, or cancel items like the standard Assign Shipment API.
The .json address above can be used to access the schema within Postman. An example use of the Assign Shipment API follows below, or view the schema or the sample Postman Collection.
The example case will assign a shipment with the following properties to the CCUI:
- Shipment ID – 090909
- Disposition – “Customer has problem with undeliverable shipment”
Only one parameter needs to known to move the shipment into the CCUI:
|shipmentID||integer||A unique identifier for the shipment. The minimum value is “1”.|
The following parameters are optional:
|dispositionReason||enum||The reason for the cancellation (CUSTOMER_FAILED_TO_PICKUP, OTHER, etc.). See the schema for the full list of possible values.|
|dispositionOtherReason||string||If dispositionReason is ’other’, provide an explanation here. Minimum length is 1 and maximum length is 255.|
The Full Request
This is the entire request that will assign a shipment.
"dispositionOtherReason": "Customer has problem with undeliverable shipment"
The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was assigned.