GET v1/store/products/{productID}?retrieveTypeSpecificData={retrieveTypeSpecificData}

Gets the product by its unique ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
productID	The unique ID of the product.	globally unique identifier	Required
retrieveTypeSpecificData	Indicates if the model should be basic, or with specific data. For instance, kitting has the Items property, which is unique to this product type.	boolean	Optional. Default value is True

Body Parameters

None.

Response Information

Resource Description

Returns the requested product.

ProductDetailsModel

Name	Description	Type	Additional information
SeoConfiguration	The SEO configuration.	SeoConfigurationModel	None.
ID	The unique ID of the product.	globally unique identifier	None.
FriendlyID	The friendly ID of the product.	integer	None.
Name	The name of the product.	string	None.
ShortDescription	The short description of the product.	string	None.
Description	The full description of the product.	string	None.
ExternalID	The ID of the product in an external application.	string	None.
CatalogNumber	The catalog number of the product. The value is undefined (equals null) if the user does not have permission to view the catalog number.	string	None.
HasPricing	Indicates whether a price was defined for the product.	boolean	None.
ImageUrl	The URL of the product image.	string	None.
Thumbnails	The product thumbnails.	Collection of string	None.
Inventory	The inventory of the product. The value is undefined (equals null) if the user does not have permission to view the product inventory.	ProductInventoryModel	None.
Unit	The unit of the product.	ProductUnitModel	None.
MinimumQuantity	The minimum number of units that can be purchased.	integer	None.
MinimumPrice	The minimum price of the product. The value is undefined (equals null) if the user does not have permission to view the product price.	ProductPriceModel	None.
Type	The type of the product.	ProductType	None.
Configuration	The configuration of the product.	ProductConfigurationModel	None.

Response Formats

application/json, text/json

Sample:

{
  "SeoConfiguration": {
    "Title": "sample string 1",
    "Description": "sample string 2"
  },
  "ID": "39db18c8-6d17-4557-b7de-a711078c2437",
  "FriendlyID": 2,
  "Name": "sample string 3",
  "ShortDescription": "sample string 4",
  "Description": "sample string 5",
  "ExternalID": "sample string 6",
  "CatalogNumber": "sample string 7",
  "HasPricing": true,
  "ImageUrl": "sample string 9",
  "Thumbnails": [
    "sample string 1",
    "sample string 2"
  ],
  "Inventory": {
    "Quantity": 1,
    "AllowOutOfStockPurchase": true
  },
  "Unit": {
    "ItemQuantity": 1,
    "ItemType": {
      "Name": "sample string 1",
      "PluralName": "sample string 2"
    },
    "PackType": {
      "Name": "sample string 1",
      "PluralName": "sample string 2"
    }
  },
  "MinimumQuantity": 10,
  "MinimumPrice": {
    "Price": 1.0,
    "Tax": 2.0
  },
  "Attributes": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Type": 1,
  "Configuration": {
    "AllowQuickAddToCart": true,
    "Quantity": {
      "Minimum": 1,
      "Maximum": 1,
      "Changeable": true,
      "Options": [
        {
          "Name": "sample string 1",
          "Value": 2
        },
        {
          "Name": "sample string 1",
          "Value": 2
        }
      ]
    },
    "Properties": [
      {
        "Name": "sample string 1",
        "ID": "88dbc806-4660-4222-8c26-b13d61342dbf"
      },
      {
        "Name": "sample string 1",
        "ID": "88dbc806-4660-4222-8c26-b13d61342dbf"
      }
    ]
  }
}