List Inventory stats grouped by SKU

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

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 (InventoryNetworkSkuStats) {8}]

optional

sku

object (SkuReference)

optional

upc

string

optional

Move into sku field?

atp

number

optional

qoh

number

optional

holdQty

number

optional

Can this be inferred at network level?

dueInQty

number

optional

Can this be inferred at network level?

backOrderQty

number

optional

Can this be inferred at network level?

potentialAllocation

number

optional

Can this be inferred at network level?

Example

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