Assign Shipment to Customer Care


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

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.

Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URLhttps://{tenantId}
Sandbox URLhttps://{tenantId}
Supported FormatsJSON


The example case will assign a shipment with the following properties to the CCUI:

  • Shipment ID – 090909
  • Disposition – “Customer has problem with undeliverable shipment”

Required Parameters

Only one parameter needs to known to move the shipment into the CCUI:

shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.

Optional Parameters

The following parameters are optional:

dispositionReasonenumThe reason for the cancellation (CUSTOMER_FAILED_TO_PICKUP, OTHER, etc.). See the schema for the full list of possible values.
dispositionOtherReasonstringIf 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.

    "shipmentID": 090909,
    "dispositionReason": "OTHER",
    "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.