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

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

items
Item · object[]

List of Items to search on

locationCode
string

Location Code

orderID
integer

Order Identifier

pageNum
integer

which page to show

pageSize
integer

how many results to show per page

sortBy
string

index to sort results by

userID
integer

user id

Response

Success

allocated
integer

The quantity the location has that are allocated

allocates
integer

Total number of allocations

available
integer

The quantity the location has that are available for purchase

binID
integer

Bin Identifier

deallocates
integer

Total number of deallocations

events
Order Item Information Event · object[]

Order Identifier

floor
integer

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

fulfills
integer

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

locationActive
boolean

Flag for whether the location is active

locationCode
integer

External Store Identifier

locationID
integer

Location Identifier

locationName
string

Location Name

ltd
string

Custom field used for store prioritization

messages
string[]

List of messages

numResults
integer

Number of results

onHand
integer

The quantity the location has in its possession

orderID
integer

Order Identifier

orderItemID
integer

Order Item Identifier

partNumber
string

Part/Product Number

pendingQuantity
integer

Pending quantity (WMS only)

picks
integer

Total number of picks (WMS only)

safetyStock
integer

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

sku
string

Stock Keeping Unit

success
boolean

Flag for success

upc
string

Universal Product Code