GET products/{productid}

Get a single product by ID. All data is included.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productid The product ID to retrieve. integer Required

Body Parameters

None.

Response Information

Resource Description

Get a single product by ID. All data is included.

ProductModel
NameDescriptionTypeAdditional information
ProductID The ID of the Product integer None.
SKU The Sku of the Product. string None.
Name The name that was given to the product. string None.
ProductGUID The Guid of the product. globally unique identifier None.
ParentProduct The Parent product of the product. ProductBaseModel None.
ProductType The product type. For instance: Kit, Simple, Parent. ProductType None.
Suppliers The suppliers specified for the product. Collection of ProductSupplierModel None.
GlobalTradeIdentifiers This container contains items like EAN, UPC and additional barcodes ProductGlobalTradeIdentifiers None.
WarehouseInformation This contains warehouse information like Pickbin, WarehouseZone etc. ProductWarehouseInformationModel None.
PricingInformation Product pricing info for instance: Price, RRP, Includes VAT. TaxClass ProductPricingInfoModel None.
InventoryInformation A container to hold all of the inventory information for the product. ProductInventoryInfoModel None.
Categories The categories that the product is a part of. Collection of CategoryBaseModel None.
Brand The brand of the product string None.
Description The products Description string None.
IsAkit Whether the product is a kit or not. boolean None.
ProductImages Collection of ProductImageModel None.
ManufacturerPartNumber The products Manufacturer Part number. string None.
CreatedOnDate The created date of the product. date None.
LastModifiedDate The last modified Date of the product. date None.
Children The child products associated to the parent. Collection of ProductChildModel None.
CustomAttributes The custom Attributes for the product. Collection of ProductCustomAttributeModel None.
ProductAdditions Collection of ProductAdditionsModel None.

Response Formats

application/json, text/json

Sample:
{
  "ProductID": 1,
  "SKU": "Shoes",
  "Name": "Shoes",
  "ProductGUID": "976009bb-9152-4e34-aaa8-8d6b78f18c74",
  "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": "fe8d6cdc-8813-48ec-9b5e-08406c03abe4",
      "WarehouseID": 1
    },
    "StockLocations": [
      {
        "StockLocation": {
          "StockLocationID": 1234,
          "StockLocationReference": "pb-1",
          "LocationOrder": 1,
          "Warehouse": {
            "WarehouseName": "My Warehouse",
            "WarehouseGuid": "53a2ca99-4326-4923-841d-1055b9e2b4c0",
            "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-08-16T18:27:21.4984366Z"
  },
  "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-07-19T18:27:21.4984366Z",
  "LastModifiedDate": "2017-08-03T18:27:21.4984366Z",
  "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.