Overview
In order to retrieve metadata for existing catalog, you must:
- Be authenticated user
Information on how you can authenticate: Authentication
Once you authenticate and receive a valid token, it needs to be passed on the call.
- Users 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/catalog?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 | Number of pages | no |
| pageSize | integer | Number of products per page | no |
| SKU | List | List of IDs of catalog | no |
| poID | List | List of IDs of purchase orders | no |
| companyID | List | List of IDs of 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. Optional. | no |
| LastUpdatedTo | datetime | Datetime indicating to when was last modified. Optional | no |
| LastAggregateFrom | datetime | From last aggregation date. Optional | no |
| LastAggregateTo | datetime | To last aggregation date. Optional | no |
| Keyword | string | A search term for performing a global search. No | no |
Response
- If the user is authenticated and provides a valid page number and page size, then the response will be Status Code 200 => OK and catalog metadata in JSON format
- If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error
Response Body
{
"Items": [
{
"ImageUrl": "string",
"Weight": 0,
"ShippingWeight": 0,
"WeightOz": 0,
"PackageWeightLbs": 0,
"PackageWeightOz": 0,
"LocationNotes": "string",
"eBayCategory": "string",
"eBayStoreCategory": "string",
"eBayItemCondition": "string",
"MAPPrice": 0,
"ShadowOf": "string",
"AverageCost": 0,
"Priority": 0,
"Rating": 0,
"ProductName": "string",
"ShortDescription": "string",
"LongDescription": "string",
"Buyer": "string",
"ASIN": "string",
"GTIN": "string",
"QtySold15": 0,
"QtySold30": 0,
"QtySold60": 0,
"QtySold90": 0,
"QtySold180": 0,
"QtySold365": 0,
"QtySoldYTD": 0,
"IsEndOfLife": true,
"ShippingCost": 0,
"AggregatePhysicalQtyFBA": 0,
"AggregatePhysicalQty": 0,
"AggregateQty": 0,
"ProductType": "string",
"DefaultVendor": "string",
"DefaultVendorSKU": "string",
"HomeCountryCode": 0,
"Country": "string",
"AmazonMarketPlaceID": "string",
"OverstockGeneratedProductID": "string",
"OverStockOptionSKU": "string",
"ReverbListingID": 0,
"WalmartProductID": "string",
"WPID": "string",
"ItemPageURL": "string",
"CompanyName": "string",
"CompanyNameAbbreviation": "string",
"FirstKitChild": "string",
"WarehousePhysicalQty": 0,
"WarehousePhysicalQtyValue": 0,
"WarehouseReservedQtyValue": 0,
"AggregatedQty": 0,
"AggregatePhysicalSellableQtyIncludingPhysicalValue": 0,
"ReservedQty": 0,
"ReserveQtyTotalValue": 0,
"PhysicalQty": 0,
"AggregateNonSellableQty": 0,
"StorePrice": 0,
"ManufacturerSKU": "string",
"ManufacturerID": 0,
"BrandID": 0,
"ASINInActiveListing": "string",
"WeightLbs": 0,
"UPC": "string",
"AmazonFBASKU": "string",
"NELiveInventory": 0,
"NEBizInventory": 0,
"WebsiteViewURL": "string",
"WishProductID": "string",
"FulfilledBy": 0,
"SalesRank": 0,
"AmazonProductCondition": 0,
"AmazonCondition": "string",
"MainProductID": "string",
"FixedPriceQuantity": 0,
"BuyItNowPrice": 0,
"ShippingTemplateID": "string",
"ListPrice": 0,
"SalePrice": 0,
"SalePriceStartDate": "2024-08-19T10:44:20.301Z",
"SalePriceEndDate": "2024-08-19T10:44:20.301Z",
"DropShipMode": 1,
"eBayCategory1ID": "string",
"eBayCategory1Name": "string",
"eBayTopTitle": "string",
"ProductTitleCount": 0,
"DescriptionTemplateID": "string",
"ebayItemID": "string",
"ebaySiteCode": 0,
"ProductConditionName": "string",
"NotesCount": 0,
"OrderReserveTotal": 0,
"VendorOfProduct": "string",
"VendorPrice": 0,
"ReplacementQty": 0,
"WarehouseName": "string",
"IsSellAble": true,
"WarehouseCount": 0,
"CompanyID": 0,
"EnabledOnChannels": [
0
],
"WebEnabled": true,
"BuyDotComEnabled": true,
"MagentoEnabled": true,
"SearsEnabled": true,
"PriceGrabberEnabled": true,
"OverStockEnabled": true,
"PriceFallEnabled": true,
"UnbeatableSalesEnabled": true,
"eBayEnabled": true,
"AmazonEnabled": true,
"WayfairEnabled": true,
"VendorCentralEnabled": true,
"BonanzaEnabled": true,
"SmartBargainsEnabled": true,
"ATGStoresEnabled": true,
"BestBuyEnabled": true,
"BestBuyDsEnabled": true,
"KohlsEnabled": true,
"HomeDepotEnabled": true,
"StaplesEnabled": true,
"MeijerEnabled": true,
"OneStopPlusEnabled": true,
"SonsiEnabled": true,
"KMartEnabled": true,
"ElevenMainEnabled": true,
"GroupOnGoodsEnabled": true,
"GrouponMarketplaceEnabled": true,
"WalmartEnabled": true,
"WalmartAPIEnabled": true,
"WishEnabled": true,
"JETEnabled": true,
"EtsyEnabled": true,
"FingerHutEnabled": true,
"TopHatterEnabled": true,
"TangaEnabled": true,
"TargetEnabled": true,
"NewEggDotComEnabled": true,
"NewEggBizEnabled": true,
"YahooStoreEnabled": true,
"HayneedleEnabled": true,
"ReverbEnabled": true,
"DropShipCentralEnabled": true,
"DrugStoresEnabled": true,
"CdiscountEnabled": true,
"BedBathAndBeyondEnabled": true,
"ShopHQEnabled": true,
"GoogleShoppingEnabled": true,
"HouzzEnabled": true,
"BackmarketEnabled": true,
"IsMatrixParent": true,
"MerchantSKU": "string",
"AmazonMerchantSKU": "string",
"WayfairMerchantSKU": "string",
"WebsiteProductID": "string",
"ChannelPreviews": [
{
"Channel": 0,
"URL": "string"
}
],
"ActiveRebateID": 0,
"ActiveRebateValue": 0,
"ActiveRebateDeductFromItemCost": 0,
"DeductFromItemCostType": 0,
"BrandName": "string",
"DateCreated": "2024-08-19T10:44:20.301Z",
"ActiveStatus": "string",
"LightspeedPOSEnabled": true,
"ShowLargeProductImagesOnManageCatalog": true,
"Status": 0,
"InventoryDependantOption": 0,
"OnOrder": 0,
"AmazonPrice": 0,
"VendorID": 0,
"VendorVisible": true,
"LastAggregateDate": "2024-08-19T10:44:20.301Z",
"LastModifiedDate": "2024-08-19T10:44:20.301Z",
"AmazonMarketplace": "string",
"OnBackOrder": 0,
"BackOrderVisible": true,
"WholeSalePrice": 0,
"WholeSalePriceVisible": true,
"SitePrice": 0,
"SiteCost": 0,
"IsKit": true,
"SiteCostVisible": true,
"LastCost": 0,
"LastCostVisible": true,
"ShowPriorityAndRatingDelta": true,
"InventoryAvailableQty": 0,
"ChildProducts": [
{
"ProductId": "string",
"ChildProductId": "string",
"PerKitQty": 0,
"ProductName": "string"
}
],
"CustomColumns": [
{
"ID": 0,
"DataType": 0,
"DataLength": 0,
"IsDropDownColumn": true,
"IsDropDownCustomTextAllowed": true,
"IsDropDownAllowMultipleSelection": true,
"ClientID": 0,
"NewValue": {},
"AllowHTMLPopup": true,
"DataSourceContainer": [
{
"Key": "string",
"Value": "string",
"Additional": {}
}
],
"IsRequired": true,
"IsEnabledForClient": true,
"DataTypeName": "string",
"ColumnName": "string",
"DisplayName": "string",
"Value": {}
}
],
"AmazonStoreStatus": true,
"AmazonEnableBOPISProduct": true,
"ID": "string"
}
],
"TotalResults": 0
}