Overview
In order to retrieve metadata for existing inventory, you must:
- Be authenticated user
Information on how you can authenticate: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed on the call for getting inventory.
- User can provide page number and page size, filtering or sorting information
Endpoint
Example for such endpoint for XX server: https://xx.api.sellercloud.com/rest/api/inventory?pageNumber=1&pageSize=1
Request
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters:
| Parameters | Data Type | Description | Is Required |
| pageNumber | integer | Page number that will be retrieved. If page number is not set in the request, then only 1st page will be pulled. | no |
| pageSize | integer | Number of products per page.If not set in the request, then the top 10 products will be pulled.
The maximum number of products that can be pulled with a single call is 50. |
no |
| inventoryID | List | List of IDs of inventory | no |
| poID | List | List of IDs of purchase orders | no |
| companyID | List | List of IDs of different companies | no |
| vendorID | List | List of IDs of vendors | no |
| defaultVendorID | List | List of IDs of default vendors | no |
| vendorSKU | List | List of SKUs of vendors | no |
| warehouse | List | List of IDs of warehouses | no |
| upc | integer | Universal Product Code number | no |
| physicalQtyFrom | integer | Minimum physical qty | no |
| physicalQtyTo | integer | Maximum physical qty | no |
| kitType | integer | Independant=0, MainComponent=1, AllComponents=2 | no |
| LastUpdatedFrom | datetime | Datetime indicating from when was last modified. . | no |
| LastUpdatedTo | datetime | Datetime indicating to when was last modified. | no |
| LastAggregateFrom | datetime | From last aggregation date. | no |
| LastAggregateTo | datetime | To last aggregation date. | no |
| Keyword | string | A search term for performing a global search. | no |
Response
- If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and inventory metadata in JSON format
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error
Response Body
{
"Items": [
{
"ImageUrl": "string",
"Weight": "string",
"ShippingWeight": "string",
"WeightOz": 0,
"PackageWeightLbs": 0,
"PackageWeightOz": 0,
"LocationNotes": "string",
"CompanyID": 0,
"ShadowOf": "string",
"AverageCost": 0,
"Priority": 0,
"Rating": 0,
"ProductName": "string",
"QtySold15": 0,
"QtySold30": 0,
"QtySold60": 0,
"QtySold90": 0,
"QtySold180": 0,
"QtySold365": 0,
"QtySoldYTD": 0,
"IsEndOfLife": true,
"ShippingCost": 0,
"AggregateQty": 0,
"ASIN": "string",
"AggregatePhysicalQtyFBA": 0,
"ASINInActiveListing": "string",
"ShippingWidth": 0,
"ShippingHeight": 0,
"ShippingLength": 0,
"LocationRegion": 0,
"WeightLbs": 0,
"ProductType": "string",
"DefaultVendor": "string",
"UnitOfMeasure": "Imperial",
"HomeCountryCode": 0,
"Country": "string",
"AmazonMarketPlaceID": "string",
"CompanyName": "string",
"CompanyNameAbbreviation": "string",
"IsKit": "string",
"WarehouseBasedPhysicalAndReservedQty": true,
"WarehousePhysicalQty": 0,
"WarehousePhysicalQtyValue": 0,
"WarehouseReservedQtyValue": 0,
"AggregatedQty": 0,
"AggregatePhysicalSellableQtyIncludingPhysicalValue": 0,
"PhysicalQty": 0,
"ReservedQty": 0,
"ReserveQtyTotalValue": 0,
"AggregateNonSellableQty": 0,
"StorePrice": 0,
"ListPrice": 0,
"ManufacturerSKU": "string",
"UPC": "string",
"EAN": "string",
"AmazonFBASKU": "string",
"FulfilledBy": "string",
"SalesRank": 0,
"ProductConditionName": "string",
"NotesCount": 0,
"FirstKitChild": "string",
"WarehouseName": "string",
"IsSellAble": true,
"WarehouseCount": 0,
"OrderReserveTotal": 0,
"InventoryDependantOption": 0,
"OnOrder": 0,
"AmazonPrice": 0,
"VendorID": 0,
"LastAggregateDate": "2020-08-17T10:13:39.137Z",
"LastModifiedDate": "2020-08-17T10:13:39.137Z",
"AmazonMarketplace": "string",
"OnBackOrder": 0,
"BackOrderVisible": true,
"WholeSalePrice": 0,
"WholeSalePriceVisible": true,
"SitePrice": 0,
"SiteCost": 0,
"SiteCostVisible": true,
"LastCost": 0,
"LastCostVisible": true,
"InventoryAvailableQty": 0,
"ChildProducts": [
{
"ProductId": "string",
"ChildProductId": "string",
"PerKitQty": 0,
"ProductName": "string"
}
],
"CustomColumns": [
{
"ID": 0,
"DataType": "String",
"DataLength": 0,
"IsDropDownColumn": true,
"IsDropDownCustomTextAllowed": true,
"ClientID": 0,
"NewValue": {},
"DataSourceContainer": [
{
"Key": "string",
"Value": "string",
"Additional": {}
}
],
"ColumnName": "string",
"DisplayName": "string",
"Value": {}
}
],
"ID": "string"
}
],
"TotalResults": 0
}