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

Add Order Item

Items are added to an existing order with the Add Order Item action. This action is actually part of the Order API, as reflected in the URL of the endpoint.

Version2.0
Callhttps://integration.shopatron.com/api/v2/order/action/addItem/
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/order/action/addItem.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

The example case creates an API call to add an item that has the following properties:

  • Five t-shirts added to Order 40000000
  • Price override 19.99

This guide will demonstrate how to put together each section of the request to add an item.

Required Parameters

The required parameters to add an order item are:

ParameterTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is “1”.
partNumberstringThe item’s part number or similar unique identifier.
quantitynumberThe number of items to add. The minimum value is “1”.
priceOverridenumberThe item price. The minimum value is “0”.
namestringThe product’s name or title. The minimum length is 1 and the maximum length is 600.
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

Other possible parameters can be provided to specify other details about the order item. These variables are:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.
taxOverridenumberThe item tax to be applied. The minimum value is “0”.
taxRateOverridenumberThe item tax rate to be applied. The minimum value is “0”.
optionsarraySpecified options for the product. For each option in the array, it includes a groupID, optionID, and optionText. See the schema for more details about these parameters.
upcCodestringThe Universal Product Code for this product. The maximum length is 50.
skustringThe Stock Keeping Unit code for this product. The maximum length is 50.
imageURLstringA URL to an image of the item.

The Full Request

This is the entire request that will add an order item to an order.

{
 "orderID": 40000000,
 "priceOverride": 19.99,
 "name": "t-shirt",
 "quantity": 5,
 "partNumber": "12345-abab-54321"
}

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