Skip to main content
POST
/
commerce
/
inventory
/
v1
/
bin
/
searchInventory
Error
A valid request URL is required to generate request examples
{
  "binQuantities": [
    {
      "binName": "<string>",
      "products": [
        {
          "allocated": 123,
          "auditID": 123,
          "auditProductID": 123,
          "available": 123,
          "binID": 123,
          "binStatusID": 123,
          "binTypeID": 123,
          "floor": 123,
          "inventoryID": 123,
          "locationCode": "<string>",
          "ltd": 123,
          "name": "<string>",
          "onHand": 123,
          "partNumber": "<string>",
          "pending": 123,
          "quantity": 123,
          "safetystock": 123,
          "sku": "<string>",
          "tags": [
            {
              "allocated": 123,
              "available": 123,
              "futureInventory": [
                {
                  "allocated": 123,
                  "available": 123,
                  "createDate": "2023-11-07T05:31:56Z",
                  "deliveryDate": "2023-11-07T05:31:56Z",
                  "futureInventoryID": 123,
                  "onhand": 123,
                  "pending": 123,
                  "type": "<string>"
                }
              ],
              "onHand": 123,
              "pending": 123,
              "tags": {}
            }
          ],
          "tenantLocProductID": 123,
          "upc": "<string>"
        }
      ]
    }
  ],
  "messages": [
    "<string>"
  ],
  "numResults": 123,
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to allocate inventory

Request needed for searching for bins

binName
string

Partial match of bin name

locationCode
string

Location Code

pageNum
integer

which page to show

pageSize
integer

how many results to show per page

product
Product · object

Product within a bin

showNegativeInventory
boolean

Flag for showing negative inventory

sortAscending
boolean

Flag for sorting ascending

sortBy
string

index to sort results by

tags
object

Associative Map of <String, String> for tagCategoryName => tagName

userID
integer

user id

Response

Success

Bin Search Response Object

binQuantities
Bin Product Response Quantities · object[]

List of BinProductQuantities - bins with associated products and quantities

messages
string[]

List of messages

numResults
integer

Number of results

success
boolean

Flag for success