GET products?SKU={SKU}&WarehouseID={WarehouseID}&SupplierID={SupplierID}&EAN={EAN}&Archived={Archived}&UPC={UPC}&CategoryID={CategoryID}&ModifiedFrom={ModifiedFrom}&IncludeSuppliers={IncludeSuppliers}&IncludeVariants={IncludeVariants}&IncludeAdditionsAndSwaps={IncludeAdditionsAndSwaps}&IncludeBarcodes={IncludeBarcodes}&IncludeCustomAttributes={IncludeCustomAttributes}&IncludeCategories={IncludeCategories}&IncludeImages={IncludeImages}&IncludeStockLocations={IncludeStockLocations}&ExcludeKits={ExcludeKits}&ExcludeParents={ExcludeParents}&ExcludeTaxRateCountries={ExcludeTaxRateCountries}&PageSize={PageSize}&Page={Page}
Get Products call. Allows multiple different filters and includes. All of the includes are set to false as default. This is because a very large amount of data can be returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SKU | This is an optional parameter. Set it to only get products of a particular sku. | string | None. |
WarehouseID | This is an optional parameter. Set it to only return products for a given Warehouse. You can get a list of Warehouse from the Warehouses endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
SupplierID | This is an optional parameter. Set it to only return products for a given Supplier. You can get a list of Suppliers from the Suppliers endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
EAN | This is an optional parameter. Set it to only get products with a particular EAN. | string | None. |
Archived | This is an optional parameter. Set it to only return archived products or non-archived products. | boolean | None. |
UPC | This is an optional parameter. Set it to only get products with a particular UPC. | string | None. |
CategoryID | This is an optional parameter. Set it to only return products for a given Category. You can get a list of Categories from the Categories endpoint. | integer | None. |
ModifiedFrom | This is an optional parameter. Set it to only return products from a given modified date. This is field is a UTC time field. Your request should be like 2016-06-01T00:00:00Z | date | None. |
IncludeSuppliers | This is an optional parameter. Set it if you wish to return Supplier information for a product. | boolean | None. |
IncludeVariants | This is an optional parameter. Set it if you wish to return Variant information for a product. | boolean | None. |
IncludeAdditionsAndSwaps | This is an optional parameter. Set it Wif you wish to return Additions and swaps information for a product. | boolean | None. |
IncludeBarcodes | This is an optional parameter. Set it if you wish to return Barcode information for a product. | boolean | None. |
IncludeCustomAttributes | This is an optional parameter. Set it if you wish to return Custom Attribute information for a product. | boolean | None. |
IncludeCategories | This is an optional parameter. Set it if you wish to return Category information for a product. | boolean | None. |
IncludeImages | This is an optional parameter. Set it if you wish to return Image information for a product. | boolean | None. |
IncludeStockLocations | This is an optional parameter. Set it if you wish to return Stock Location Information for a product i.e. Stock Location Reference, Warehouse Zone. | boolean | None. |
ExcludeKits | This is an optional parameter. Set it if you wish to exclude kit products from the results. | boolean | None. |
ExcludeParents | This is an optional parameter. Set it if you wish to exclude parent products from the results. | boolean | None. |
ExcludeTaxRateCountries | This is an optional parameter. Set it if you wish to exclude tax rate countries from the results. | boolean | None. |
PageSize | This is an optional parameter. This will default to 100. The max page size is 100 | integer | Range: inclusive between 1 and 100 |
Page | This is an optional parameter. It will default to page 1. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
Body Parameters
None.
Response Information
Resource Description
Get Products call. Allows multiple different filters and includes. All of the includes are set to false as default. This is because a very large amount of data can be returned.
PagedResponseModelOfProductModelName | Description | Type | Additional information |
---|---|---|---|
TotalItems | integer | None. | |
PagingInfo | PagingFilter | None. | |
TotalPages | integer | None. | |
Data | Collection of ProductModel | None. |
Response Formats
application/json, text/json
Sample:
{ "TotalItems": 10, "PagingInfo": { "PageSize": 1, "Page": 1 }, "TotalPages": 10, "Data": [ { "ProductID": 1, "SKU": "Shoes", "Name": "Shoes", "ProductGUID": "2418419c-c268-4b2d-8ed9-b75fb0114eb1", "ProductType": "Parent", "Suppliers": [ { "Supplier": { "Currency": { "CurrencyID": 44, "CurrencyCode": "GBP", "CurrencyName": "British Pounds", "Symbol": "£" }, "SupplierID": 1, "Name": "Supplier 1" }, "SupplierSKU": "sup1", "SupplierCosts": 4.5, "SupplierStockLevel": 12, "SupplierLeadTime": 2, "SupplierCartonQuantities": 1, "Priority": 0, "SupplierMinOrderAmount": 1 } ], "GlobalTradeIdentifiers": { "EAN": "12345678910", "UPC": "123456789123", "AdditionalBarcodes": [ "barcode1", "barcode2" ] }, "WarehouseInformation": { "Warehouse": { "WarehouseName": "My Warehouse", "WarehouseGuid": "19e70340-6d29-4055-b337-0832175ff4a1", "WarehouseID": 1 }, "StockLocations": [ { "StockLocation": { "StockLocationID": 1234, "StockLocationReference": "pb-1", "LocationOrder": 1, "Warehouse": { "WarehouseName": "My Warehouse", "WarehouseGuid": "f4ece6d4-4a2e-40cf-ba6d-15e41e25edc5", "WarehouseID": 1 }, "WarehouseZone": { "WarehouseZoneID": 3343, "Name": "Wz-1" }, "StockLocationType": "Pickbin", "IsQuarantined": false }, "Available": 100, "Allocated": 1, "PhysicalStock": 101, "PendingOut": 0 } ], "CartonQuantity": 1, "LeadTime": 3, "ContainsHazardousMaterials": false, "IsFragile": false, "UnitOfMeasure": "CM", "Weight": 1.0, "Packaging": { "PackagingID": 1, "PackagingName": "Parcel" }, "PackagingQuantity": 1, "ProductTypeDescription": "shoes", "DetailedProductTypeDescription": "Shoes and laces", "ProductComposition": "Leather", "ProductHarmonizedCode": "", "RecordSerialNumberOnBarcodeDespatch": false }, "PricingInformation": { "TaxClass": { "TaxClassID": 4, "TaxClassGuid": "00000000-0000-0000-0000-000000000000", "CreatedOn": "0001-01-01T00:00:00", "IsGlobal": false, "Name": "Standard UK", "TaxRate": 20.0 }, "Price": 15.99, "RRP": 10.0, "Margin": 1.5, "AverageCost": 10.5, "AverageCostExVat": 8.75, "PriceIncludesVat": true, "LastCostPrice": 0.0, "LastCostPriceExVat": 0.0 }, "InventoryInformation": { "Inventory": 100, "QuarantinedInventory": 5, "Allocated": 1, "OnBackOrder": 0, "OnPurchaseOrder": 10, "ManualReorderLevel": 10, "CalculatedReorderLevel": 5, "SoldLast30Days": 20, "SoldLast90Days": 50, "SoldLast120Days": 100, "LastOrderedDate": "2023-12-09T11:20:23.5700359Z" }, "Categories": [ { "CategoryID": 1, "CategoryName": "Shoes" }, { "CategoryID": 2, "CategoryName": "Trainers" } ], "Brand": "Brand 1", "Description": "A pair of shoes.", "Archived": true, "IsAkit": true, "ProductImages": [ { "ProductImageID": 1, "ImageURL": "http://storefeeder.com/images/1.jpg", "Order": 1, "Height": 1000, "Width": 1000 }, { "ProductImageID": 2, "ImageURL": "http://storefeeder.com/images/2.jpg", "Order": 1, "Height": 1000, "Width": 1000 } ], "ManufacturerPartNumber": "mfn1234", "CreatedOnDate": "2023-11-11T11:20:23.5700359Z", "LastModifiedDate": "2023-11-26T11:20:23.5700359Z", "Children": [ { "Product": { "ProductID": 2, "SKU": "shoe-1" }, "VariantAttributes": [ { "Name": "Colour", "Value": "Red" }, { "Name": "Size", "Value": "8" } ] }, { "Product": { "ProductID": 3, "SKU": "shoe-2" }, "VariantAttributes": [ { "Name": "Colour", "Value": "Red" }, { "Name": "Size", "Value": "9" } ] }, { "Product": { "ProductID": 4, "SKU": "shoe-3" }, "VariantAttributes": [ { "Name": "Colour", "Value": "Blue" }, { "Name": "Size", "Value": "8" } ] }, { "Product": { "ProductID": 5, "SKU": "shoe-4" }, "VariantAttributes": [ { "Name": "Colour", "Value": "Blue" }, { "Name": "Size", "Value": "9" } ] } ], "CustomAttributes": [ { "CustomAttribute": { "CustomAttributeID": 1, "CustomAttributeName": "Material" }, "Value": "Leather" }, { "CustomAttribute": { "CustomAttributeID": 2, "CustomAttributeName": "Includes Batteries" }, "Value": "false" } ], "ProductSpecialAttribute": "Sold by the pair" } ] }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.