GET v1/Products/{productIds}/RelatedProducts?sort={sort}
Retrieves the details for a single item in the product catalog.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
productIds | string |
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 RelatedProductsName | Description | Type | Additional information |
---|---|---|---|
id | integer |
None. |
|
name | string |
None. |
|
description | string |
None. |
|
imageURL | string |
None. |
|
promptText | string |
None. |
|
relationship | string |
None. |
|
productType | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "name": "sample string 2", "description": "sample string 3", "imageURL": "sample string 4", "promptText": "sample string 5", "relationship": "sample string 6", "productType": "sample string 7" }, { "id": 1, "name": "sample string 2", "description": "sample string 3", "imageURL": "sample string 4", "promptText": "sample string 5", "relationship": "sample string 6", "productType": "sample string 7" } ]
text/html
Sample:
[{"id":1,"name":"sample string 2","description":"sample string 3","imageURL":"sample string 4","promptText":"sample string 5","relationship":"sample string 6","productType":"sample string 7"},{"id":1,"name":"sample string 2","description":"sample string 3","imageURL":"sample string 4","promptText":"sample string 5","relationship":"sample string 6","productType":"sample string 7"}]
application/xml, text/xml
Sample:
<ArrayOfv1_Products_ProductEndpointController.RelatedProducts 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.RelatedProducts> <description>sample string 3</description> <id>1</id> <imageURL>sample string 4</imageURL> <name>sample string 2</name> <productType>sample string 7</productType> <promptText>sample string 5</promptText> <relationship>sample string 6</relationship> </v1_Products_ProductEndpointController.RelatedProducts> <v1_Products_ProductEndpointController.RelatedProducts> <description>sample string 3</description> <id>1</id> <imageURL>sample string 4</imageURL> <name>sample string 2</name> <productType>sample string 7</productType> <promptText>sample string 5</promptText> <relationship>sample string 6</relationship> </v1_Products_ProductEndpointController.RelatedProducts> </ArrayOfv1_Products_ProductEndpointController.RelatedProducts>