GET v1/Products/{productId}

Retrieves the details for a single item in the product catalog.

Request Information

URI Parameters

Name	Description	Type	Additional information
productId		integer	Required

Body Parameters

None.

Response Information

Resource Description

SingleProduct

Name	Description	Type	Additional information
id		integer	None.
parentProductId	If a product is part of a group this will be the id of the top level group product.	integer	None.
name		string	None.
description	A plain text description of the product.	string	None.
webDescription	A short rich text description of the product with html encoding.	string	None.
webLongDescription	A long rich text description of the product with html encoding.	string	None.
availableUntil		date	None.
productCategory		string	None.
productType	A type of product this is. This informs the client which end point should be used when adding the product to the cart.	string	None.
allowBackorders		boolean	None.
quantityAvailable	How many of the current product are available.	decimal number	None.
requireInventory		boolean	None.
dateAvailable		date	None.
hasComplexPricing	If true, this indicates you must add the product to the cart in order to get an accurate price.	boolean	None.
defaultPrice		decimal number	None.
defaultMemberPrice		decimal number	None.
nonMemberPrice		decimal number	None.
retailPrice		decimal number	None.
currencyId	The currency the prices are in.	integer	None.
currencySymbol		string	None.
isSubscription	Indicates if the product is subscription product. When adding subscription product to the cart, the quantity must be 1	boolean	None.
ISBN	If a product is type of publication then this field represent unique number for that product.	string	None.
datepublished	If a product is type of publication then this field represent the date when the product is being published.	date	None.
assemblyType	This field represents the AssemblyType/KitType of the product. Products that have a value here include sub products that are automatically added to the order. An assemblyType of 'Group' means the sub products are added as individual line items to the cart, and those line items can be removed independently of one another. Group products do not have a top level line item added to the cart that represents the product groupings. An assemblyType of 'Kit' means a line item is added to the cart for the top level product, and the sub product line items are tied directly to that top level product. Sub products in a kit can only be removed by removing that top level line item.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "parentProductId": 2,
  "name": "sample string 3",
  "description": "sample string 4",
  "webDescription": "sample string 5",
  "webLongDescription": "sample string 6",
  "availableUntil": "2024-10-30T18:04:36.3752096+00:00",
  "productCategory": "sample string 8",
  "productType": "sample string 9",
  "allowBackorders": true,
  "quantityAvailable": 11.0,
  "requireInventory": true,
  "dateAvailable": "2024-10-30T18:04:36.3752096+00:00",
  "hasComplexPricing": true,
  "defaultPrice": 15.0,
  "defaultMemberPrice": 16.0,
  "nonMemberPrice": 17.0,
  "retailPrice": 18.0,
  "currencyId": 19,
  "currencySymbol": "sample string 20",
  "isSubscription": true,
  "ISBN": "sample string 22",
  "datepublished": "2024-10-30T18:04:36.3752096+00:00",
  "assemblyType": "sample string 24"
}

text/html

Sample:

{"id":1,"parentProductId":2,"name":"sample string 3","description":"sample string 4","webDescription":"sample string 5","webLongDescription":"sample string 6","availableUntil":"2024-10-30T18:04:36.3752096+00:00","productCategory":"sample string 8","productType":"sample string 9","allowBackorders":true,"quantityAvailable":11.0,"requireInventory":true,"dateAvailable":"2024-10-30T18:04:36.3752096+00:00","hasComplexPricing":true,"defaultPrice":15.0,"defaultMemberPrice":16.0,"nonMemberPrice":17.0,"retailPrice":18.0,"currencyId":19,"currencySymbol":"sample string 20","isSubscription":true,"ISBN":"sample string 22","datepublished":"2024-10-30T18:04:36.3752096+00:00","assemblyType":"sample string 24"}

application/xml, text/xml

Sample:

<v1_Products_ProductEndpointController.SingleProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Products_ProductEndpoint">
  <ISBN>sample string 22</ISBN>
  <allowBackorders>true</allowBackorders>
  <assemblyType>sample string 24</assemblyType>
  <availableUntil>2024-10-30T18:04:36.3752096+00:00</availableUntil>
  <currencyId>19</currencyId>
  <currencySymbol>sample string 20</currencySymbol>
  <dateAvailable>2024-10-30T18:04:36.3752096+00:00</dateAvailable>
  <datepublished>2024-10-30T18:04:36.3752096+00:00</datepublished>
  <defaultMemberPrice>16</defaultMemberPrice>
  <defaultPrice>15</defaultPrice>
  <description>sample string 4</description>
  <hasComplexPricing>true</hasComplexPricing>
  <id>1</id>
  <isSubscription>true</isSubscription>
  <name>sample string 3</name>
  <nonMemberPrice>17</nonMemberPrice>
  <parentProductId>2</parentProductId>
  <productCategory>sample string 8</productCategory>
  <productType>sample string 9</productType>
  <quantityAvailable>11</quantityAvailable>
  <requireInventory>true</requireInventory>
  <retailPrice>18</retailPrice>
  <webDescription>sample string 5</webDescription>
  <webLongDescription>sample string 6</webLongDescription>
</v1_Products_ProductEndpointController.SingleProduct>