inventory

List Inventory

Get a list of items' inventory levels.

get/inventory

Request

  • Base URL: https://app.allocadence.com/rest
  • URL: https://app.allocadence.com/rest/inventory
  • Auth: none declared

Query parameters

searchForstring

Searchs items' SKU, UPC, and description for exact or partial matches.

clientIdinteger

Filter for items belonging to the client matching this id.

clientNamestring

Filter for items belonging to the client with this name. Ignored if clientId is provided and is nonzero.

warehouseIdinteger

Id of the warehouse to filter by.

warehouseNamestring

Name of the warehouse to filter by. Ignored if warehouseId is provided.

locationIdinteger

Id of the location to filter by.

locationNamestring

Name of the location to filter by. Ignored if locationId is provided.

categorystring

Item category to filter by.

inStockboolean

True to include only items that are in stock.

lowStockboolean

True to include only items whose inventory level is less than its reorder level.

userField1string

Filter for items by this user defined field.

userField2string

Filter for items by this user defined field.

userField3string

Filter for items by this user defined field.

userField4string

Filter for items by this user defined field.

userField5string

Filter for items by this user defined field.

userField6string date-time

Filter for items by this user defined field.

orderBy'' | 'id' | 'sku' | 'upc' | 'category' | 'userField1' | 'userField2' | 'userField3' | 'userField4' | 'userField5' | 'userField6' | 'inStock' | 'allocated'

Field to order results by.

orderDir'asc' | 'desc'

Direction to order the results by. Only used if orderBy is not an empty string.

pageinteger

Page number of the results to get.

perPageinteger

Page number of the results to get.

Response

Success

Example response

{
  "inventory": [
    {
      "item": {
        "id": 2306,
        "sku": "FumoFumo-002",
        "upc": "",
        "description": "Marisa Kirisame",
        "category": "Fumo"
      },
      "client": null,
      "inStock": 8226,
      "allocated": 43,
      "sellable": 8176,
      "underPar": 0,
      "inbound": 65
    },
    {
      "item": {
        "id": 2330,
        "sku": "FumoFumo-006",
        "upc": "",
        "description": "Alice Margatroid",
        "category": "Fumo"
      },
      "client": null,
      "inStock": 9974,
      "allocated": 72,
      "sellable": 9895,
      "underPar": 0,
      "inbound": 10
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.