Cancel Order Item
The Cancel Order Item API allows an item associated with an order to be canceled after its generation with an order.
The .json address above can be used to access the schema within Postman. An example use of the Order Item API follows here — or go directly to the schema or the sample Postman Collection.
This example case creates a call that 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.
The parameters required to cancel an order item are:
|orderItemID||integer||A unique identifier for the order item. The minimum value is "0".|
|dispositionReason||enum||The 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).|
These are the other details that can be provided when canceling an order item:
|dispositionOtherReason||string||Custom reason if ’other’ was used for the dispositionReason. The minimum length is "1" and the maximum length is "255".|
|rectifyOrder||boolean||Should order payment be rectified?|
|sendCancellationEmails||boolean||Should 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.