GET products?SKU={SKU}&WarehouseID={WarehouseID}&SupplierID={SupplierID}&EAN={EAN}&CategoryID={CategoryID}&ModifiedFrom={ModifiedFrom}&IncludeSuppliers={IncludeSuppliers}&IncludeVariants={IncludeVariants}&IncludeAdditionsAndSwaps={IncludeAdditionsAndSwaps}&IncludeBarcodes={IncludeBarcodes}&IncludeCustomAttributes={IncludeCustomAttributes}&IncludeCategories={IncludeCategories}&IncludeImages={IncludeImages}&IncludeStockLocations={IncludeStockLocations}&ExcludeKits={ExcludeKits}&ExcludeParents={ExcludeParents}&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

NameDescriptionTypeAdditional 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.
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.
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.

PagedResponseModelOfProductModel
NameDescriptionTypeAdditional 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": "a456246b-5d5e-48c9-82ea-b008757f52b2",
      "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
        }
      ],
      "GlobalTradeIdentifiers": {
        "EAN": "12345678910",
        "UPC": "123456789123",
        "AdditionalBarcodes": [
          "barcode1",
          "barcode2"
        ]
      },
      "WarehouseInformation": {
        "Warehouse": {
          "WarehouseName": "My Warehouse",
          "WarehouseGuid": "b18a100a-18dc-48f7-9873-e93a925c690c",
          "WarehouseID": 1
        },
        "StockLocations": [
          {
            "StockLocation": {
              "StockLocationID": 1234,
              "StockLocationReference": "pb-1",
              "LocationOrder": 1,
              "Warehouse": {
                "WarehouseName": "My Warehouse",
                "WarehouseGuid": "588250a7-1024-47a1-823c-204135cc8308",
                "WarehouseID": 1
              },
              "WarehouseZone": {
                "WarehouseZoneID": 3343,
                "Name": "Wz-1"
              },
              "StockLocationType": "Pickbin"
            },
            "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": ""
      },
      "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,
        "PriceIncludesVat": true
      },
      "InventoryInformation": {
        "Inventory": 100,
        "Allocated": 1,
        "OnBackOrder": 0,
        "OnPurchaseOrder": 10,
        "ManualReorderLevel": 10,
        "CalculatedReorderLevel": 5,
        "SoldLast30Days": 20,
        "SoldLast90Days": 50,
        "SoldLast120Days": 100,
        "LastOrderedDate": "2017-11-20T04:32:45.0266839Z"
      },
      "Categories": [
        {
          "CategoryID": 1,
          "CategoryName": "Shoes"
        },
        {
          "CategoryID": 2,
          "CategoryName": "Trainers"
        }
      ],
      "Brand": "Brand 1",
      "Description": "A pair of shoes.",
      "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": "2017-10-23T04:32:45.0266839Z",
      "LastModifiedDate": "2017-11-07T04:32:45.0266839Z",
      "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"
        }
      ]
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: There was an error generating the XML document.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: There was an error generating the XML document.