Get Order Item Information

The Get Order Item API retrieves information about an existing order item.

The data returned by this request is 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.

Example

The Get Order Item API call requires only one additional piece of data: the Order Item ID that was generated when the order item was initialized with the Add Order Item API, Create Order API, or other action that defined an item. The ID can be retrieved from either the response of these actions or by looking up the order that the item belongs to. This could be done with a Get Order call or a Search Order Item call with an Order ID as the search parameter.

Otherwise, Get Order Item is a standard GET request as defined with the above table. In this example, the item included these particular properties:

• Order Item 9000000000 in Order 888888
• Item is one winter coat at a price of 319.00 in the order’s currency

This guide will demonstrate how to put together each section of the request to get this information.

General Information

The response returns just one block of general information. It includes the following details:

• Associated identifiers and unique numbers such as Universal Product Codes
• Item state
• Description, quantity, and price values of the item
• Any custom data added to the item

This information is followed by a list of the available capabilities that can be performed and a list of restrictions.

The Full Request

Using the URL format as outlined above, the entire call is simple to put together. This will return all of the information for the order item with the above example ID.

https://{tenantId}-translation.mozu.com/api/v2/orderItem/9000000000

The Full Response

This is the full response returned by the API.

{
 "orderItemID": 9000000000,
 "itemState": "NORMAL",
 "orderID": 888888,
 "shipmentID": 12121212,
 "externalItemID": "aaaaa333aaaaa222aa",
 "manufacturerID": 4300,
 "partNumber": "X123454321",
 "upc": "808080808",
 "description": "Winter Coat",
 "quantity": 1,
 "subtotal": 319.99,
 "retailPrice": 319.99,
 "mfgOfferPrice": 319.99,
 "lineDiscount": 0,
 "shipping": 15,
 "actualPrice": 319.99,
 "customData": {},
 "capabilities": [
   "DUPLICATE_ORDER",
   "CANCEL_ORDER",
   "CANCEL_SHIPMENT",
   "BACKORDER_SHIPMENT",
   "BACKORDER_ITEM",
   "CANCEL_ITEM",
   "ADD_PROMOTION",
   "EDIT_CONSUMER_NAME",
   "EDIT_CONSUMER_EMAIL",
   "EDIT_CONSUMER_PHONE_NUMBER",
   "EDIT_CONSUMER_SHIPPING_ADDRESS",
   "EDIT_CONSUMER_BILLING_ADDRESS",
   "ADD_PAYMENT_METHOD_CREDIT_CARD",
   "ADD_PAYMENT_METHOD_GIFT_CARD",
   "ADD_NOTE",
   "VIEW_RESTRICTED_NOTE",
   "ORDER_ROUTING_LOGS",
   "ORDER_SNAPSHOTS"
 ],
 "restrictions": [
   "UNCANCEL_ORDER",
   "AUTO_ASSIGN_ORDER",
   "REASSIGN_ORDER",
   "UNCANCEL_SHIPMENT",
   "AUTO_ASSIGN_SHIPMENT",
   "REASSIGN_SHIPMENT",
   "INCREASE_SHIPPING_AND_HANDLING",
   "DECREASE_SHIPPING_AND_HANDLING",
   "VIEW_TRACKING_INFORMATION",
   "ADD_TRACKING_TO_SHIPMENT",
   "EDIT_TRACKING_NUMBER",
   "DELETE_TRACKING_NUMBER",
   "UNFULFILL_SHIPMENT",
   "AUTO_ASSIGN_ITEM",
   "REASSIGN_ITEM",
   "UNCANCEL_ITEM",
   "ADD_ITEM",
   "INCREASE_ITEM_QUANTITY",
   "DECREASE_ITEM_QUANTITY",
   "INCREASE_ITEM_PRICE",
   "DECREASE_ITEM_PRICE",
   "INCREASE_ITEM_TAX",
   "DECREASE_ITEM_TAX",
   "RETURN_ITEM",
   "PROCESS_RETURN",
   "OFFER_APPEASEMENT"
 ],
 "discounts": []
}