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



Edit Order Item

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

Supported FormatsJSON

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.


This example case creates a call that will edit an existing order item. The important properties and new edits are:

  • Order Item 12345678
  • Sets quantity to 5 and price to 50

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

Required Parameters

The orderItemID is required for all instances of this call:

orderItemIDintegerA unique identifier for the order item. The minimum value is “0”.
rectifyOrderboolean Should the order 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 used to edit an order item:

quantitynumberThe new quantity of the order item. The minimum value is “1”.
pricenumberThe new price of the order item. The minim value is “0”.
orderItemUnitsarrayInformation to store about the individual units within an item. The minimum length is 0.

Order Item Units

These are the parameters used to build the elements of the orderItemUnits array, if provided:

orderItemUnitIDintegerA unique identifier for order item units.
serialNumberstringA serial number for an individual unit within an item. The maximum length is 255.
removeNullValuesbooleanIf true, null values will erase existing values. If false, existing values are left alone. The default is false.

The Full Request

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

 "orderItemID": 12345678,
 "quantity": 5,
 "price": 50,
 "rectifyOrder": true 

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