KIBO OMS DOCUMENTATION

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.

Version2.0
Callhttps://integration.shopatron.com/api/v2/shipment/action/customerCare/
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/shipment/action/customerCare.json

The .json address above can be used to access the schema within Postman. An example use of the Assign Shipment API follows here — or go directly to the schema or the sample Postman Collection.

Example

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:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".

Optional Parameters

The following parameters are optional:

ParameterTypeDescription
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.


Megan MayfieldOMS Dev: Assign Shipment to Customer Care