Get Products List
Request Parameters:
This method is used to List/Search Products
URL for nopCommerce 4.20 :
Api/Admin/GetProductsList
Headers :
Content-Type : application/json
Parameter:
{
"ApiSecretKey" :"k104r106p102g98k116q107x114x118",
"RestAPIAdminAccessKey" :"4fbdf629-be68-4371-a81d-4b191c98a52e",
"PageNumber":1,
"pageSize":2
}
Response :
{
"Data": [
{
"PictureThumbnailUrl": "http://localhost:15536/images/thumbs/0000020_build-your-own-computer_75.jpeg",
"ProductTypeId": 5,
"ProductTypeName": "Simple",
"AssociatedToProductId": 0,
"AssociatedToProductName": null,
"VisibleIndividually": true,
"ProductTemplateId": 1,
"AvailableProductTemplates": [],
"ProductsTypesSupportedByProductTemplates": {},
"Name": "Build your own computer",
"ShortDescription": "Build it",
"FullDescription": "",
"AdminComment": null,
"ShowOnHomepage": true,
"MetaKeywords": null,
"MetaDescription": null,
"MetaTitle": null,
"SeName": "build-your-own-computer",
"AllowCustomerReviews": true,
"ProductTags": null,
"Sku": "COMP_CUST",
"ManufacturerPartNumber": null,
"Gtin": null,
"IsGiftCard": false,
"GiftCardTypeId": 0,
"OverriddenGiftCardAmount": null,
"RequireOtherProducts": false,
"RequiredProductIds": null,
"AutomaticallyAddRequiredProducts": false,
"IsDownload": false,
"DownloadId": 0,
"UnlimitedDownloads": false,
"MaxNumberOfDownloads": 0,
"DownloadExpirationDays": null,
"DownloadActivationTypeId": 0,
"HasSampleDownload": false,
"SampleDownloadId": 0,
"HasUserAgreement": false,
"UserAgreementText": null,
"IsRecurring": false,
"RecurringCycleLength": 0,
"RecurringCyclePeriodId": 0,
"RecurringTotalCycles": 0,
"IsRental": false,
"RentalPriceLength": 0,
"RentalPricePeriodId": 0,
"IsShipEnabled": true,
"IsFreeShipping": true,
"ShipSeparately": false,
"AdditionalShippingCharge": 0.0000,
"DeliveryDateId": 0,
"AvailableDeliveryDates": [],
"IsTaxExempt": false,
"TaxCategoryId": 2,
"AvailableTaxCategories": [],
"IsTelecommunicationsOrBroadcastingOrElectronicServices": false,
"ManageInventoryMethodId": 2,
"ProductAvailabilityRangeId": 0,
"AvailableProductAvailabilityRanges": [],
"UseMultipleWarehouses": false,
"WarehouseId": 0,
"AvailableWarehouses": [],
"StockQuantity": 10000,
"LastStockQuantity": 0,
"StockQuantityStr": null,
"DisplayStockAvailability": true,
"DisplayStockQuantity": false,
"MinStockQuantity": 0,
"LowStockActivityId": 1,
"NotifyAdminForQuantityBelow": 1,
"BackorderModeId": 0,
"AllowBackInStockSubscriptions": false,
"OrderMinimumQuantity": 1,
"OrderMaximumQuantity": 10000,
"AllowedQuantities": null,
"AllowAddingOnlyExistingAttributeCombinations": false,
"NotReturnable": false,
"DisableBuyButton": false,
"DisableWishlistButton": false,
"AvailableForPreOrder": false,
"PreOrderAvailabilityStartDateTimeUtc": null,
"CallForPrice": false,
"Price": 1200.0000,
"OldPrice": 0.0000,
"ProductCost": 0.0000,
"CustomerEntersPrice": false,
"MinimumCustomerEnteredPrice": 0.0000,
"MaximumCustomerEnteredPrice": 0.0000,
"BasepriceEnabled": false,
"BasepriceAmount": 0.0000,
"BasepriceUnitId": 1,
"AvailableBasepriceUnits": [],
"BasepriceBaseAmount": 0.0000,
"BasepriceBaseUnitId": 1,
"AvailableBasepriceBaseUnits": [],
"MarkAsNew": true,
"MarkAsNewStartDateTimeUtc": null,
"MarkAsNewEndDateTimeUtc": null,
"Weight": 2.0000,
"Length": 2.0000,
"Width": 2.0000,
"Height": 2.0000,
"AvailableStartDateTimeUtc": null,
"AvailableEndDateTimeUtc": null,
"DisplayOrder": 0,
"Published": true,
"PrimaryStoreCurrencyCode": null,
"BaseDimensionIn": null,
"BaseWeightIn": null,
"Locales": [],
"SelectedCustomerRoleIds": [],
"AvailableCustomerRoles": [],
"SelectedStoreIds": [],
"AvailableStores": [],
"SelectedCategoryIds": [],
"AvailableCategories": [],
"SelectedManufacturerIds": [],
"AvailableManufacturers": [],
"VendorId": 0,
"AvailableVendors": [],
"SelectedDiscountIds": [],
"AvailableDiscounts": [],
"IsLoggedInAsVendor": false,
"AddPictureModel": {
"ProductId": 0,
"PictureId": 0,
"PictureUrl": null,
"DisplayOrder": 0,
"OverrideAltAttribute": null,
"OverrideTitleAttribute": null,
"Id": 0,
"CustomProperties": {}
},
"ProductPictureModels": [],
"ProductAttributesExist": false,
"ProductWarehouseInventoryModels": [],
"HasAvailableSpecificationAttributes": false,
"CopyProductModel": {
"Name": null,
"CopyImages": false,
"Published": false,
"Id": 0,
"CustomProperties": {}
},
"ProductEditorSettingsModel": {
"ActiveStoreScopeConfiguration": 0,
"ProductType": false,
"VisibleIndividually": false,
"ProductTemplate": false,
"AdminComment": false,
"Vendor": false,
"Stores": false,
"ACL": false,
"ShowOnHomepage": false,
"DisplayOrder": false,
"AllowCustomerReviews": false,
"ProductTags": false,
"ManufacturerPartNumber": false,
"GTIN": false,
"ProductCost": false,
"TierPrices": false,
"Discounts": false,
"DisableBuyButton": false,
"DisableWishlistButton": false,
"AvailableForPreOrder": false,
"CallForPrice": false,
"OldPrice": false,
"CustomerEntersPrice": false,
"PAngV": false,
"RequireOtherProductsAddedToTheCart": false,
"IsGiftCard": false,
"DownloadableProduct": false,
"RecurringProduct": false,
"IsRental": false,
"FreeShipping": false,
"ShipSeparately": false,
"AdditionalShippingCharge": false,
"DeliveryDate": false,
"TelecommunicationsBroadcastingElectronicServices": false,
"ProductAvailabilityRange": false,
"UseMultipleWarehouses": false,
"Warehouse": false,
"DisplayStockAvailability": false,
"DisplayStockQuantity": false,
"MinimumStockQuantity": false,
"LowStockActivity": false,
"NotifyAdminForQuantityBelow": false,
"Backorders": false,
"AllowBackInStockSubscriptions": false,
"MinimumCartQuantity": false,
"MaximumCartQuantity": false,
"AllowedQuantities": false,
"AllowAddingOnlyExistingAttributeCombinations": false,
"NotReturnable": false,
"Weight": false,
"Dimensions": false,
"AvailableStartDate": false,
"AvailableEndDate": false,
"MarkAsNew": false,
"MarkAsNewStartDate": false,
"MarkAsNewEndDate": false,
"Published": false,
"RelatedProducts": false,
"CrossSellsProducts": false,
"Seo": false,
"PurchasedWithOrders": false,
"ProductAttributes": false,
"SpecificationAttributes": false,
"Manufacturers": false,
"StockQuantityHistory": false,
"CustomProperties": {}
},
"StockQuantityHistory": {
"WarehouseName": null,
"AttributeCombination": null,
"QuantityAdjustment": 0,
"StockQuantity": 0,
"Message": null,
"CreatedOn": "0001-01-01T00:00:00",
"Id": 0,
"CustomProperties": {}
},
"RelatedProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"CrossSellProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"AssociatedProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductPictureSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductSpecificationAttributeSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductOrderSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"TierPriceSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"StockQuantityHistorySearchModel": {
"ProductId": 0,
"WarehouseId": 0,
"AvailableWarehouses": [],
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductAttributeMappingSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductAttributeCombinationSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"Id": 1,
"CustomProperties": {}
},
{
"PictureThumbnailUrl": "http://localhost:15536/images/thumbs/0000022_digital-storm-vanquish-3-custom-performance-pc_75.jpeg",
"ProductTypeId": 5,
"ProductTypeName": "Simple",
"AssociatedToProductId": 0,
"AssociatedToProductName": null,
"VisibleIndividually": true,
"ProductTemplateId": 1,
"AvailableProductTemplates": [],
"ProductsTypesSupportedByProductTemplates": {},
"Name": "Digital Storm VANQUISH 3 Custom Performance PC",
"ShortDescription": "Digital Storm Vanquish 3 Desktop PC",
"FullDescription": "",
"AdminComment": null,
"ShowOnHomepage": false,
"MetaKeywords": null,
"MetaDescription": null,
"MetaTitle": null,
"SeName": "digital-storm-vanquish-3-custom-performance-pc",
"AllowCustomerReviews": true,
"ProductTags": null,
"Sku": "DS_VA3_PC",
"ManufacturerPartNumber": null,
"Gtin": null,
"IsGiftCard": false,
"GiftCardTypeId": 0,
"OverriddenGiftCardAmount": null,
"RequireOtherProducts": false,
"RequiredProductIds": null,
"AutomaticallyAddRequiredProducts": false,
"IsDownload": false,
"DownloadId": 0,
"UnlimitedDownloads": false,
"MaxNumberOfDownloads": 0,
"DownloadExpirationDays": null,
"DownloadActivationTypeId": 0,
"HasSampleDownload": false,
"SampleDownloadId": 0,
"HasUserAgreement": false,
"UserAgreementText": null,
"IsRecurring": false,
"RecurringCycleLength": 0,
"RecurringCyclePeriodId": 0,
"RecurringTotalCycles": 0,
"IsRental": false,
"RentalPriceLength": 0,
"RentalPricePeriodId": 0,
"IsShipEnabled": true,
"IsFreeShipping": false,
"ShipSeparately": false,
"AdditionalShippingCharge": 0.0000,
"DeliveryDateId": 0,
"AvailableDeliveryDates": [],
"IsTaxExempt": false,
"TaxCategoryId": 2,
"AvailableTaxCategories": [],
"IsTelecommunicationsOrBroadcastingOrElectronicServices": false,
"ManageInventoryMethodId": 1,
"ProductAvailabilityRangeId": 0,
"AvailableProductAvailabilityRanges": [],
"UseMultipleWarehouses": false,
"WarehouseId": 0,
"AvailableWarehouses": [],
"StockQuantity": 10000,
"LastStockQuantity": 0,
"StockQuantityStr": "10000",
"DisplayStockAvailability": true,
"DisplayStockQuantity": false,
"MinStockQuantity": 0,
"LowStockActivityId": 1,
"NotifyAdminForQuantityBelow": 1,
"BackorderModeId": 0,
"AllowBackInStockSubscriptions": false,
"OrderMinimumQuantity": 1,
"OrderMaximumQuantity": 10000,
"AllowedQuantities": null,
"AllowAddingOnlyExistingAttributeCombinations": false,
"NotReturnable": false,
"DisableBuyButton": false,
"DisableWishlistButton": false,
"AvailableForPreOrder": false,
"PreOrderAvailabilityStartDateTimeUtc": null,
"CallForPrice": false,
"Price": 1259.0000,
"OldPrice": 0.0000,
"ProductCost": 0.0000,
"CustomerEntersPrice": false,
"MinimumCustomerEnteredPrice": 0.0000,
"MaximumCustomerEnteredPrice": 0.0000,
"BasepriceEnabled": false,
"BasepriceAmount": 0.0000,
"BasepriceUnitId": 0,
"AvailableBasepriceUnits": [],
"BasepriceBaseAmount": 0.0000,
"BasepriceBaseUnitId": 0,
"AvailableBasepriceBaseUnits": [],
"MarkAsNew": false,
"MarkAsNewStartDateTimeUtc": null,
"MarkAsNewEndDateTimeUtc": null,
"Weight": 7.0000,
"Length": 7.0000,
"Width": 7.0000,
"Height": 7.0000,
"AvailableStartDateTimeUtc": null,
"AvailableEndDateTimeUtc": null,
"DisplayOrder": 0,
"Published": true,
"PrimaryStoreCurrencyCode": null,
"BaseDimensionIn": null,
"BaseWeightIn": null,
"Locales": [],
"SelectedCustomerRoleIds": [],
"AvailableCustomerRoles": [],
"SelectedStoreIds": [],
"AvailableStores": [],
"SelectedCategoryIds": [],
"AvailableCategories": [],
"SelectedManufacturerIds": [],
"AvailableManufacturers": [],
"VendorId": 0,
"AvailableVendors": [],
"SelectedDiscountIds": [],
"AvailableDiscounts": [],
"IsLoggedInAsVendor": false,
"AddPictureModel": {
"ProductId": 0,
"PictureId": 0,
"PictureUrl": null,
"DisplayOrder": 0,
"OverrideAltAttribute": null,
"OverrideTitleAttribute": null,
"Id": 0,
"CustomProperties": {}
},
"ProductPictureModels": [],
"ProductAttributesExist": false,
"ProductWarehouseInventoryModels": [],
"HasAvailableSpecificationAttributes": false,
"CopyProductModel": {
"Name": null,
"CopyImages": false,
"Published": false,
"Id": 0,
"CustomProperties": {}
},
"ProductEditorSettingsModel": {
"ActiveStoreScopeConfiguration": 0,
"ProductType": false,
"VisibleIndividually": false,
"ProductTemplate": false,
"AdminComment": false,
"Vendor": false,
"Stores": false,
"ACL": false,
"ShowOnHomepage": false,
"DisplayOrder": false,
"AllowCustomerReviews": false,
"ProductTags": false,
"ManufacturerPartNumber": false,
"GTIN": false,
"ProductCost": false,
"TierPrices": false,
"Discounts": false,
"DisableBuyButton": false,
"DisableWishlistButton": false,
"AvailableForPreOrder": false,
"CallForPrice": false,
"OldPrice": false,
"CustomerEntersPrice": false,
"PAngV": false,
"RequireOtherProductsAddedToTheCart": false,
"IsGiftCard": false,
"DownloadableProduct": false,
"RecurringProduct": false,
"IsRental": false,
"FreeShipping": false,
"ShipSeparately": false,
"AdditionalShippingCharge": false,
"DeliveryDate": false,
"TelecommunicationsBroadcastingElectronicServices": false,
"ProductAvailabilityRange": false,
"UseMultipleWarehouses": false,
"Warehouse": false,
"DisplayStockAvailability": false,
"DisplayStockQuantity": false,
"MinimumStockQuantity": false,
"LowStockActivity": false,
"NotifyAdminForQuantityBelow": false,
"Backorders": false,
"AllowBackInStockSubscriptions": false,
"MinimumCartQuantity": false,
"MaximumCartQuantity": false,
"AllowedQuantities": false,
"AllowAddingOnlyExistingAttributeCombinations": false,
"NotReturnable": false,
"Weight": false,
"Dimensions": false,
"AvailableStartDate": false,
"AvailableEndDate": false,
"MarkAsNew": false,
"MarkAsNewStartDate": false,
"MarkAsNewEndDate": false,
"Published": false,
"RelatedProducts": false,
"CrossSellsProducts": false,
"Seo": false,
"PurchasedWithOrders": false,
"ProductAttributes": false,
"SpecificationAttributes": false,
"Manufacturers": false,
"StockQuantityHistory": false,
"CustomProperties": {}
},
"StockQuantityHistory": {
"WarehouseName": null,
"AttributeCombination": null,
"QuantityAdjustment": 0,
"StockQuantity": 0,
"Message": null,
"CreatedOn": "0001-01-01T00:00:00",
"Id": 0,
"CustomProperties": {}
},
"RelatedProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"CrossSellProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"AssociatedProductSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductPictureSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductSpecificationAttributeSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductOrderSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"TierPriceSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"StockQuantityHistorySearchModel": {
"ProductId": 0,
"WarehouseId": 0,
"AvailableWarehouses": [],
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductAttributeMappingSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"ProductAttributeCombinationSearchModel": {
"ProductId": 0,
"Page": 1,
"PageSize": 10,
"AvailablePageSizes": null,
"Draw": null,
"Start": 0,
"Length": 10,
"CustomProperties": {}
},
"Id": 2,
"CustomProperties": {}
}
],
"Draw": null,
"RecordsFiltered": 3,
"RecordsTotal": 3,
"Total": 0,
"CustomProperties": {}
}