Query Inventory Detail, V2.0

Get a list of your item inventory data by query parameters, version 2.0. This is an updated version of Query Inventory Detail with additional query filters are available.

• URL: {API root URL}/inventory/v2?{query}
• Method: GET

Request

URL Parameters

Parameter Name	Required	Data Type	Description
pageSize	Y	Integer	Specify how many records to return in single call, up to 200.
pageNumber	Y	Integer	Specify which page you are querying, starts from 1.
customerCode	Y	String	Your unique customer code assigned by Best system.
warehouseCode		String	Specify the warehouse you want to query the inventory data, value could be “USCA01” or “USNJ01”, empty means querying all applicable warehouses.
condition		String	Indicate the item condition. Available values: Good or Damaged. Default value is for all conditions.
consolidateConditions		Boolean	Indicates the result should group inventory by SKU and warehouse regardless condition. Default value is false.
content.value		String	The keyword you want to match the item for the inventory query, it will match with item’s SKU number, Description and UPC.
content.exactMatch		Boolean	Indicates the result should match the exact words you’ve included in content.value.
includeOutOfStock		Boolean	Indicates if the items with zero inventory should be returned or not, default value is false.

Response

Attribute List

Element Name	Data Type	Description
totalCount	Integer	The count of returned records.
pageNumber	Integer	Same value as requested
pageSize	Integer	Same value as requested
result	Array<Object>	The inventory data list.
result/id	String	The internal ID
result/itemId	String	The internal ID of the SKU.
result/customerCode	String	Your unique customer code assigned by BEST system.
result/warehouseCode	String	The warehouse for the invenory data.
result/sku	String	The number of the SKU.
result/description	String	The title of your SKU
result/condition	String	Indicate the item condition of inventory.
result/orderBehavior	String	Indicate if current SKU is set for pre-order. The default value is Normal for regular items.
result/totalQty	Integer	The total inventory quantity of current SKU.
result/availableQty	Integer	The available quantity of the SKU in current warehouse.
result/allocatedQty	Integer	The quantity of the SKU that is allocated by all open orders in current warehouse.
result/quarantinedQty	Integer	The quantity of the SKU that is quarantined in current warehouse.
result/holdQty	Integer	The quantity of the SKU that is on hold in current warehouse.
result/duePutAwayQty	Integer	The quantity of the SKU in the ASN which is received by Best Inc. warehouse and waiting for putaway.
result/dueInQty	Integer	The quantity of the SKU that was created into an open ASN but not received into Best Warehouse.
result/extraQty	Integer	The quantity of the inventory difference or excess of current item.
result/MissingQty	Integer	The quantity of the inventory difference or shortage of current item.

Response Example

{
    "totalCount": 2,
    "pageNumber": 1,
    "pageSize": 15,
    "pageCount": 1,
    "result": [
        {
            "id": 181,
            "itemId": 46452,
            "customerCode": "USQA",
            "warehouseCode": "USCA01",
            "sku": "SKU3",
            "description": "USQA SKU3",
            "condition": "Good",
            "orderBehavior": "Normal",
            "totalQty": 100164,
            "availableQty": 99905,
            "allocatedQty": 177,
            "quarantinedQty": 0,
            "holdQty": 0,
            "dueInQty": 1050,
            "duePutAwayQty": 82,
            "extraQty": 0,
            "missingQty": 0
        },
        {
            "id": 537,
            "itemId": 46452,
            "customerCode": "USQA",
            "warehouseCode": "USCA01",
            "sku": "SKU3",
            "description": "USQA SKU3",
            "condition": "Damaged",
            "orderBehavior": "Normal",
            "totalQty": 0,
            "availableQty": 0,
            "allocatedQty": 0,
            "quarantinedQty": 0,
            "holdQty": 0,
            "dueInQty": 0,
            "duePutAwayQty": 0,
            "extraQty": 0,
            "missingQty": 0
        }
    ]
}