The Edit Order Item API allows an item associated with an order to be edited after its generation with an order.
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 URL | https://{tenantId}-translation.mozu.com/api/v2/orderItem/action/edit |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/orderItem/action/edit |
| Supported Formats | JSON |
| HTTP Method | POST |
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:
| Parameter | Type | Description |
| orderItemID | integer | A unique identifier for the order item. The minimum value is “0”. |
| rectifyOrder | boolean | 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:
| Parameter | Type | Description |
| quantity | number | The new quantity of the order item. The minimum value is “1”. |
| price | number | The new price of the order item. The minim value is “0”. |
| orderItemUnits | array | Information 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:
| Parameter | Type | Description |
| orderItemUnitID | integer | A unique identifier for order item units. |
| serialNumber | string | A serial number for an individual unit within an item. The maximum length is 255. |
| removeNullValues | boolean | If 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.