Add Order Item


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

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.

Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URLhttps://{tenantId}
Sandbox URLhttps://{tenantId}
Supported FormatsJSON


The example 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:

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.
rectifyOrderbooleanShould 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:

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.