Load Inventory

Loads bin inventory for designated bins

POST /commerce/inventory/v1/bin/loadInventory

Error

A valid request URL is required to generate request examples

200

{
  "binQuantities": [
    {
      "binName": "<string>",
      "products": [
        {
          "allocated": 123,
          "auditID": 123,
          "auditProductID": 123,
          "available": 123,
          "binID": 123,
          "binStatusID": 123,
          "binTypeID": 123,
          "floor": 123,
          "inventoryID": 123,
          "locationID": 123,
          "ltd": 123,
          "name": "<string>",
          "onHand": 123,
          "partNumber": "<string>",
          "pending": 123,
          "quantity": 123,
          "safetystock": 123,
          "sku": "<string>",
          "tags": {},
          "tenantLocProductID": 123,
          "upc": "<string>"
        }
      ]
    }
  ],
  "binsCreated": [
    "<string>"
  ],
  "messages": [
    "<string>"
  ],
  "numResults": 123,
  "productsCreated": [
    {
      "partNumber": "<string>",
      "sku": "<string>",
      "upc": "<string>"
    }
  ],
  "success": true,
  "unitsAdded": 123,
  "unitsRemoved": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to load bin inventory

Request needed for loading bin inventory

bins · Bin Product Quantities · object[]

List of bins and their associated product quantities

Show child attributes

dryRun · boolean

Flag for dry runs

locationCode · string

Location Code

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

200

application/json

Success

Response object for loading bin inventory

binQuantities · Bin Product Quantities · object[]

List of new bin product quantities

Show child attributes

binsCreated · string[]

Names of created bins

messages · string[]

List of messages

numResults · integer

Number of results

productsCreated · Product · object[]

List of products created

Show child attributes

success · boolean

Flag for success

unitsAdded · integer

Number of units added

unitsRemoved · integer

Number of removed units