List Inventory stats grouped by SKU and Building

This returns inventory stats grouped by sku and building. By aggregating at the building level, you can also quantify stats specific to the building such as back orders, due-in, hold, and potential allocation. This will most likely be used to filter results to a specific SKU in order to view one SKU's inventory break down by 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:

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

buildingId

string

optional

Responses

🟢200OK

application/json

Body

data

array[object (InventoryBuildingSkuStats) {8}]

optional

backOrderQty

number

optional

dueInQty

number

optional

holdQty

number

optional

qoh

number

optional

atp

number

optional

sku

object (SkuReference)

optional

building

object (BuildingReference)

optional

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

potentialAllocation

number

optional

What does this mean vs ATP?

Example

{
    "data": [
        {
            "backOrderQty": 0,
            "dueInQty": 0,
            "holdQty": 0,
            "qoh": 0,
            "atp": 0,
            "sku": {
                "skuId": "string",
                "name": "255",
                "description1": "string",
                "description2": "string"
            },
            "building": {
                "buildingId": "strin",
                "shortName": "string",
                "name": "string"
            },
            "potentialAllocation": 0
        }
    ]
}

List Inventory stats grouped by SKU and Building

Request

Request samples

Responses