KIBO OMS DOCUMENTATION

Edit Order Item

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

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

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.

Example

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:

ParameterTypeDescription
orderItemIDintegerA unique identifier for the order item. The minimum value is "0".

Optional Parameters

These are the other details that can be used to edit an order item:

ParameterTypeDescription
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.
rectifyOrderbooleanShould the order be rectified?

Order Item Units

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

ParameterTypeDescription
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,
 "shipping":10,
 "rectifyOrder": true 
}

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


Megan MayfieldOMS Dev: Edit Order Item