GET v1/ShoppingCarts/RelatedProducts?sort={sort}
Gets the related products of all items in the cart. A cart item may have additional detail depending on its product type. Those details can be retrieved through the URL specified by the additionalDetails output field.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 GetRelatedProductsOutput| Name | 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_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ShoppingCarts_ShoppingCartEndpoint">
<v1_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput>
<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_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput>
<v1_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput>
<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_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput>
</ArrayOfv1_ShoppingCarts_ShoppingCartEndpointController.GetRelatedProductsOutput>