GET v1/Products/{productId}/AssemblyParts?sort={sort}
Retrieves the list of sub products underneath the current product. Typically, it is used to get the sub products of a Kit or a Group product.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
productId | integer |
Required |
|
sort |
A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of SubProductsOutputName | Description | Type | Additional information |
---|---|---|---|
id | integer |
None. |
|
name | string |
None. |
|
quantity |
Quantity of this product. |
decimal number |
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. |
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. |
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. |
|
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
[ { "id": 1, "name": "sample string 2", "quantity": 3.0, "description": "sample string 4", "webDescription": "sample string 5", "webLongDescription": "sample string 6", "productCategory": "sample string 7", "productType": "sample string 8", "hasComplexPricing": true, "defaultPrice": 10.0, "defaultMemberPrice": 11.0, "nonMemberPrice": 12.0, "retailPrice": 13.0, "currencyId": 14, "currencySymbol": "sample string 15", "ISBN": "sample string 16", "datepublished": "2024-10-30T13:54:35.1989494+00:00", "assemblyType": "sample string 18" }, { "id": 1, "name": "sample string 2", "quantity": 3.0, "description": "sample string 4", "webDescription": "sample string 5", "webLongDescription": "sample string 6", "productCategory": "sample string 7", "productType": "sample string 8", "hasComplexPricing": true, "defaultPrice": 10.0, "defaultMemberPrice": 11.0, "nonMemberPrice": 12.0, "retailPrice": 13.0, "currencyId": 14, "currencySymbol": "sample string 15", "ISBN": "sample string 16", "datepublished": "2024-10-30T13:54:35.1989494+00:00", "assemblyType": "sample string 18" } ]
text/html
[{"id":1,"name":"sample string 2","quantity":3.0,"description":"sample string 4","webDescription":"sample string 5","webLongDescription":"sample string 6","productCategory":"sample string 7","productType":"sample string 8","hasComplexPricing":true,"defaultPrice":10.0,"defaultMemberPrice":11.0,"nonMemberPrice":12.0,"retailPrice":13.0,"currencyId":14,"currencySymbol":"sample string 15","ISBN":"sample string 16","datepublished":"2024-10-30T13:54:35.1989494+00:00","assemblyType":"sample string 18"},{"id":1,"name":"sample string 2","quantity":3.0,"description":"sample string 4","webDescription":"sample string 5","webLongDescription":"sample string 6","productCategory":"sample string 7","productType":"sample string 8","hasComplexPricing":true,"defaultPrice":10.0,"defaultMemberPrice":11.0,"nonMemberPrice":12.0,"retailPrice":13.0,"currencyId":14,"currencySymbol":"sample string 15","ISBN":"sample string 16","datepublished":"2024-10-30T13:54:35.1989494+00:00","assemblyType":"sample string 18"}]
application/xml, text/xml
<ArrayOfv1_Products_ProductEndpointController.SubProductsOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Products_ProductEndpoint"> <v1_Products_ProductEndpointController.SubProductsOutput> <ISBN>sample string 16</ISBN> <assemblyType>sample string 18</assemblyType> <currencyId>14</currencyId> <currencySymbol>sample string 15</currencySymbol> <datepublished>2024-10-30T13:54:35.1989494+00:00</datepublished> <defaultMemberPrice>11</defaultMemberPrice> <defaultPrice>10</defaultPrice> <description>sample string 4</description> <hasComplexPricing>true</hasComplexPricing> <id>1</id> <name>sample string 2</name> <nonMemberPrice>12</nonMemberPrice> <productCategory>sample string 7</productCategory> <productType>sample string 8</productType> <quantity>3</quantity> <retailPrice>13</retailPrice> <webDescription>sample string 5</webDescription> <webLongDescription>sample string 6</webLongDescription> </v1_Products_ProductEndpointController.SubProductsOutput> <v1_Products_ProductEndpointController.SubProductsOutput> <ISBN>sample string 16</ISBN> <assemblyType>sample string 18</assemblyType> <currencyId>14</currencyId> <currencySymbol>sample string 15</currencySymbol> <datepublished>2024-10-30T13:54:35.1989494+00:00</datepublished> <defaultMemberPrice>11</defaultMemberPrice> <defaultPrice>10</defaultPrice> <description>sample string 4</description> <hasComplexPricing>true</hasComplexPricing> <id>1</id> <name>sample string 2</name> <nonMemberPrice>12</nonMemberPrice> <productCategory>sample string 7</productCategory> <productType>sample string 8</productType> <quantity>3</quantity> <retailPrice>13</retailPrice> <webDescription>sample string 5</webDescription> <webLongDescription>sample string 6</webLongDescription> </v1_Products_ProductEndpointController.SubProductsOutput> </ArrayOfv1_Products_ProductEndpointController.SubProductsOutput>