Cancel Order Item


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.

The Cancel Order Item API allows an item associated with an order to be canceled after its generation with an order.

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


This example case will cancel an existing order item. The important properties:

  • Order Item 12345678
  • Canceled due to lack of quantity

This guide will demonstrate how to put together each section of the request to cancel this item.

Required Parameters

The parameters required to cancel an order item are:

orderItemIDintegerA unique identifier for the order item. The minimum value is “0”.
dispositionReasonenumThe reason for the cancellation (can_not_find_item, not_enough_quantity, not_web_sellable, on_mannequin_or_display, item_on_reserve, no_inventory, or other).
rectifyOrderbooleanShould order payment be rectified? The default is “TRUE” so that even if this is not provided in the request, the parameter will be automatically set to the suggested best practice of rectification.

Optional Parameters

These are the other details that can be provided when canceling an order item:

cancelChildItemsbooleanIn the case of an item on a transfer order being canceled, should the associated child items be canceled too? The default is “false.”
dispositionOtherReasonstringCustom reason if ’other’ was used for the dispositionReason. The minimum length is “1” and the maximum length is “255”.
sendCancellationEmailsbooleanShould cancellation emails be sent?

The Full Request

This is the entire request that will cancel an order item.


The returned response follows the same structure as the Get Order Item API, providing information about the order item that was edited.