GET v1/ProductInventory/GetProductsByWarehouse?warehouseCode={warehouseCode}&pageNumber={pageNumber}&pageSize={pageSize}&productCode={productCode}

This method gets a paged list of top level products located in a particular warehouse - this is useful if you model your warehouse bins on Tradevine warehouses

Request Information

URI Parameters

Name Description Type Additional information
warehouseCode

The code for the warehouse you're querying for e.g. WH1

string

Optional

pageNumber

The page number for the list you wish to retrieve

integer

Optional

Must be greater than 1

Default value is 1 if not specified

pageSize

The page size for the list you wish to retrieve

integer

Optional

Must be greater than 1 and less than 500

Default value is 500 if not specified

productCode

Filter the list on a particular product code

string

Optional

Body Parameters

None.

Response Information

Resource Description

A list of product data from the Tradevine database

IPagedCollection (of PerWarehouseInventory)

Name Description Type
TotalCount

The total number of records in the resultset including those returned on this page

integer
PageNumber

The page number of the current resultset

integer
PageSize

The page size of the current resultset

integer
List

The list of records in this page of the resultset

Collection of PerWarehouseInventory

Response Formats

application/json

Sample:

Sample not available.