Inventory Inquiry

GET

/ups/inventory/inventoryinquiry

Request

Query Params

sortField

string

optional

Example:

timestamp

sortDirection

string

optional

Example:

DESC

offset

string

optional

Example:

limit

string

optional

Example:

100

skuId

string

optional

buildingId

string

optional

Header Params

Token

string

required

Bearer Token

Example:

Bearer eyJ0eXBlIjoiU0lHTkVELUpXVCIsIndoc2VfaWQiOiJVUFMiLCJibGRnX2lkIjoiIiwiY29tcGFueV9ubyI6IkRZU09OIiwiYWxsb3dlZF9wYXRoIjoiIiwiYWxnIjoiUlM1MTIifQ.eyJpc3MiOiJzb2Z0ZW9uLmNvbSIsInN1YiI6InNvZnRlb24vYXV0aC9qd3QiLCJleHAiOjIyNTY4ODE2NjIsIm5hbWUiOiJzb2Z0ZW9uIiwic2NvcGUiOiJBUEkifQ.hrAhfR_YlUmPYalGA7XKdkdC6wpjup1IRTY2sNwVltM9N1zA0pvv4s5b8MoW__c2cxZ41tQbF-0cUfb-oH604Grz3VBlKMa76I0vttPBxhd9MAU64h6Qt4rVtQB4Okt-Z4wUp2y8ZE0a2sLIt1r3x_cWV2LvYgUQPUzY9PrGdA--jNyRB51lj7s9W8Ug5CTwgYHxC3oKf6ENGC5SPP9PSggvD_Ccj1RK1GEdZw2ueT3JUXNG4OLKTtOGw4gCWCTqBHc6WhzijBXu3WN3FHwEmQVTlrEqiADLqOUeGVrgkozhmYCUVzeuEr62bcw5eDk_LReye2YOmqohJwjH7yDjTw

WhseId

string

required

Warehouse Id of Client DOMS

Example:

UPS

BldgId

string

optional

Business Unit Code of the Client in DOMS

Example:

POCSPORTS

BusinessUnit

string

required

Building Id of the Client in DOMS

Example:

NVRN1

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/ups/inventory/inventoryinquiry?sortField=timestamp&sortDirection=DESC&offset=0&limit=100&skuId=&buildingId=' \
--header 'Token: Bearer eyJ0eXBlIjoiU0lHTkVELUpXVCIsIndoc2VfaWQiOiJVUFMiLCJibGRnX2lkIjoiIiwiY29tcGFueV9ubyI6IkRZU09OIiwiYWxsb3dlZF9wYXRoIjoiIiwiYWxnIjoiUlM1MTIifQ.eyJpc3MiOiJzb2Z0ZW9uLmNvbSIsInN1YiI6InNvZnRlb24vYXV0aC9qd3QiLCJleHAiOjIyNTY4ODE2NjIsIm5hbWUiOiJzb2Z0ZW9uIiwic2NvcGUiOiJBUEkifQ.hrAhfR_YlUmPYalGA7XKdkdC6wpjup1IRTY2sNwVltM9N1zA0pvv4s5b8MoW__c2cxZ41tQbF-0cUfb-oH604Grz3VBlKMa76I0vttPBxhd9MAU64h6Qt4rVtQB4Okt-Z4wUp2y8ZE0a2sLIt1r3x_cWV2LvYgUQPUzY9PrGdA--jNyRB51lj7s9W8Ug5CTwgYHxC3oKf6ENGC5SPP9PSggvD_Ccj1RK1GEdZw2ueT3JUXNG4OLKTtOGw4gCWCTqBHc6WhzijBXu3WN3FHwEmQVTlrEqiADLqOUeGVrgkozhmYCUVzeuEr62bcw5eDk_LReye2YOmqohJwjH7yDjTw' \
--header 'WhseId: UPS' \
--header 'BldgId: POCSPORTS' \
--header 'BusinessUnit: NVRN1'

Responses

🟢200Success

application/json

Body

data

array [object {12}]

required

buildingId

string

optional

buildingName

string

optional

sku

string

optional

skuDesc

string

optional

qoh

integer

optional

dueInQty

integer

optional

inTransitQty

integer

optional

holdQty

integer

optional

dockQty

integer

optional

backOrderQty

integer

optional

atp

integer

optional

potentialAllocation

integer

optional

Example

{
    "data": [
        {
            "buildingId": "string",
            "buildingName": "string",
            "sku": "string",
            "skuDesc": "string",
            "qoh": 0,
            "dueInQty": 0,
            "inTransitQty": 0,
            "holdQty": 0,
            "dockQty": 0,
            "backOrderQty": 0,
            "atp": 0,
            "potentialAllocation": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2024-06-06 06:02:22

ASN Inquiry