OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Cancel Order Item

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

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

The .json address above can be used to access the schema within Postman. An example use of the Order Item API follows below, or view the schema or the sample Postman Collection.

Example

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.

Required Parameters

The parameters required to cancel an order item are:

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

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

{ 
 "orderItemID":12345678,
 "dispositionReason":"not_enough_quantity",
 "rectifyOrder":true,
 "sendCancellationEmails":false,
 "cancelChildItems":false
}

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