GET products/{productid}
Get a single product by ID. All data is included.
Request Information
URI Parameters
Name | Description | Type | Additional 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.
ProductModelName | Description | Type | Additional 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. |
Archived | The products archived status | boolean | 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. | |
ProductSpecialAttribute | The Products Special Attribute. | string | None. |
Response Formats
application/json, text/json
Sample:
{ "ProductID": 1, "SKU": "Shoes", "Name": "Shoes", "ProductGUID": "2fede3b8-3360-4780-a5a9-fb826f8c8b6b", "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": "aecf9249-2a2b-4f5a-b76c-127489554821", "WarehouseID": 1 }, "StockLocations": [ { "StockLocation": { "StockLocationID": 1234, "StockLocationReference": "pb-1", "LocationOrder": 1, "Warehouse": { "WarehouseName": "My Warehouse", "WarehouseGuid": "91d57f41-d985-4dd4-a677-d2711817bc88", "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-09T12:00:59.2275591Z" }, "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-11T12:00:59.2275591Z", "LastModifiedDate": "2023-11-26T12:00:59.2275591Z", "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.