GET api/inventory?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}
Get inventory details for items found within the specified parameters.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
pageNumber | Page number to get (Optional. Default value is 1.) |
Define this parameter in the request URI. |
pageSize | Page size to get (Optional. Default value is 100. Maximum is 1000) |
Define this parameter in the request URI. |
modifiedAfter | Filter results to only include items modified after the specified date. (Optional) |
Define this parameter in the request URI. |
Response Information
Inventory details for all items found.
Response body formats
application/json, text/json
Sample:
{ "PageNumber": 1, "PageSize": 2, "TotalItems": 3, "TotalPages": 4, "Inventories": [ { "Sku": "sample string 1", "Name": "sample string 2", "Upc": "sample string 3", "ManufacturerNumber": "sample string 4", "AvailableQuantity": 5, "QuantityOnHand": 6, "DateModified": "2024-04-25T18:08:18.6746114-04:00", "Sellable": true }, { "Sku": "sample string 1", "Name": "sample string 2", "Upc": "sample string 3", "ManufacturerNumber": "sample string 4", "AvailableQuantity": 5, "QuantityOnHand": 6, "DateModified": "2024-04-25T18:08:18.6746114-04:00", "Sellable": true }, { "Sku": "sample string 1", "Name": "sample string 2", "Upc": "sample string 3", "ManufacturerNumber": "sample string 4", "AvailableQuantity": 5, "QuantityOnHand": 6, "DateModified": "2024-04-25T18:08:18.6746114-04:00", "Sellable": true } ] }
application/xml, text/xml
Sample:
<Results xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <PageNumber>1</PageNumber> <PageSize>2</PageSize> <TotalItems>3</TotalItems> <TotalPages>4</TotalPages> <Inventories> <Inventory> <Sku>sample string 1</Sku> <Name>sample string 2</Name> <Upc>sample string 3</Upc> <ManufacturerNumber>sample string 4</ManufacturerNumber> <AvailableQuantity>5</AvailableQuantity> <QuantityOnHand>6</QuantityOnHand> <DateModified>2024-04-25T18:08:18.6746114-04:00</DateModified> <Sellable>true</Sellable> </Inventory> <Inventory> <Sku>sample string 1</Sku> <Name>sample string 2</Name> <Upc>sample string 3</Upc> <ManufacturerNumber>sample string 4</ManufacturerNumber> <AvailableQuantity>5</AvailableQuantity> <QuantityOnHand>6</QuantityOnHand> <DateModified>2024-04-25T18:08:18.6746114-04:00</DateModified> <Sellable>true</Sellable> </Inventory> <Inventory> <Sku>sample string 1</Sku> <Name>sample string 2</Name> <Upc>sample string 3</Upc> <ManufacturerNumber>sample string 4</ManufacturerNumber> <AvailableQuantity>5</AvailableQuantity> <QuantityOnHand>6</QuantityOnHand> <DateModified>2024-04-25T18:08:18.6746114-04:00</DateModified> <Sellable>true</Sellable> </Inventory> </Inventories> </Results>