Skip to main content
POST
/
commerce
/
inventory
/
v5
/
inventory
/
getOrderItemInformation
Error
A valid request URL is required to generate request examples
[
  {
    "orderID": 123,
    "orderItemID": 123,
    "locationID": 123,
    "locationActive": true,
    "locationCode": 123,
    "locationName": "<string>",
    "binID": 123,
    "partNumber": "<string>",
    "upc": "<string>",
    "sku": "<string>",
    "ltd": "<string>",
    "floor": 123,
    "safetyStock": 123,
    "onHand": 123,
    "available": 123,
    "allocated": 123,
    "allocates": 123,
    "deallocates": 123,
    "fulfills": 123,
    "picks": 123,
    "pendingQuantity": 123,
    "events": [
      {
        "date": "<string>",
        "eventType": "ALLOCATED",
        "quantity": 123,
        "success": true,
        "messages": [
          "<string>"
        ],
        "numResults": 123
      }
    ],
    "success": true,
    "messages": [
      "<string>"
    ],
    "numResults": 123
  }
]

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to retrieve order item information

Request for getting order item information

orderID
integer

Order Identifier

items
Item · object[]

List of Items to search on

locationCode
string

Location Code

userID
integer

user id

pageSize
integer

how many results to show per page

pageNum
integer

which page to show

sortBy
string

index to sort results by

Response

Success

orderID
integer

Order Identifier

orderItemID
integer

Order Item Identifier

locationID
integer

Location Identifier

locationActive
boolean

Flag for whether the location is active

locationCode
integer

External Store Identifier

locationName
string

Location Name

binID
integer

Bin Identifier

partNumber
string

Part/Product Number

upc
string

Universal Product Code

sku
string

Stock Keeping Unit

ltd
string

Custom field used for store prioritization

floor
integer

Absolute minimum quantity of this item that should be in stock at any time

safetyStock
integer

Quantity of this item the location wants to keep in stock to ensure stock isn't completely depleted

onHand
integer

The quantity the location has in its possession

available
integer

The quantity the location has that are available for purchase

allocated
integer

The quantity the location has that are allocated

allocates
integer

Total number of allocations

deallocates
integer

Total number of deallocations

fulfills
integer

Total number of fulfillments. Should never be greater than 1.

picks
integer

Total number of picks (WMS only)

pendingQuantity
integer

Pending quantity (WMS only)

events
Order Item Information Event · object[]

Order Identifier

success
boolean

Flag for success

messages
string[]

List of messages

numResults
integer

Number of results