List Inventory stats grouped by Lot and Building

Request

Path Params

businessUnitId

string

required

Query Params

sortField

string

optional

Field to sort by

Default:

timestamp

sortDirection

enum<string>

optional

Direction in which to sort the sortField

Allowed values:

ASCDESC

Default:

DESC

offset

integer

optional

This offsets the start of each page by the number specified.

Default:

0

limit

integer

optional

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.

Default:

100

skuId

string

optional

lotId

string

optional

expirationDate

string

optional

buildingId

string

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

data

array[object (InventoryBuildingLotStats) {5}]

optional

building

object (BuildingReference)

required

A Summary View of a Distribution Center/Building/Facility/Location

sku

object (SkuReference)

required

lot

object

optional

qoh

number

required

QOH of specific lot

holdQty

number

required

Quantity held on specific lot

Example

{
    "data": [
        {
            "building": {
                "buildingId": "strin",
                "shortName": "string",
                "name": "string"
            },
            "sku": {
                "skuId": "string",
                "name": "255",
                "description1": "string",
                "description2": "string"
            },
            "lot": {
                "lotId": "string",
                "expirationDate": "2019-08-24"
            },
            "qoh": 0,
            "holdQty": 0
        }
    ]
}