PATCH v1/ShoppingCarts/Items/{id}/GeneralProduct
Updates the properties of a single general product item in the cart. If the item specified is not a general product this call will error.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
updateSingleGeneralProductItemInput| Name | Description | Type | Additional information |
|---|---|---|---|
| quantity | integer |
Required |
Request Formats
application/json, text/json
{
"quantity": 1
}
text/html
{"quantity":1}
application/xml, text/xml
<v1_ShoppingCarts_ShoppingCartEndpointController.updateSingleGeneralProductItemInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ShoppingCarts_ShoppingCartEndpoint"> <quantity>1</quantity> </v1_ShoppingCarts_ShoppingCartEndpointController.updateSingleGeneralProductItemInput>
application/x-www-form-urlencoded
Response Information
Resource Description
UpdateSingleGeneralProductItemOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID for this item in the cart. |
integer |
None. |
| parentproductId |
The ParentID of the product for this item in the cart. |
integer |
None. |
| parentId |
If this item is part of a kit or a group, this is the parent item it belongs to. |
integer |
None. |
| productId |
The ID of the product for this item in the cart. |
integer |
None. |
| isSubscription |
Indicates if the product is a subscription product. |
boolean |
None. |
| productCategory |
The category of the product for this item in the cart. |
string |
None. |
| quantity |
Quantity will be only have a non-zero fractional part for subscription items. This depends on how the subscription product is processed. In most circumstances the fractional part will be zero. |
decimal number |
None. |
| price |
The unit price for this line item in the cart. |
decimal number |
None. |
| discount |
The percentage discount that should be taken off the order line price for each item. |
decimal number |
None. |
| productName |
The name of the product. |
string |
None. |
| webName |
The web name of the product. |
string |
None. |
| description |
The product description. |
string |
None. |
| productType |
The type of product this is. |
string |
None. |
| additionalDetails |
The URL to retrieve or update additional details about this product in the cart. |
URI |
None. |
| totalDiscount |
The total discount applied for this product in the cart. |
decimal number |
None. |
| totalFinalPrice |
The final price user pays for this product in the cart. |
decimal number |
None. |
Response Formats
application/json, text/json
{
"id": 1,
"parentproductId": 2,
"parentId": 3,
"productId": 4,
"isSubscription": true,
"productCategory": "sample string 6",
"quantity": 7.0,
"price": 8.0,
"discount": 9.0,
"productName": "sample string 10",
"webName": "sample string 11",
"description": "sample string 12",
"productType": "sample string 13",
"additionalDetails": "http://webapihelppage14.com",
"totalDiscount": 15.0,
"totalFinalPrice": 16.0
}
text/html
{"id":1,"parentproductId":2,"parentId":3,"productId":4,"isSubscription":true,"productCategory":"sample string 6","quantity":7.0,"price":8.0,"discount":9.0,"productName":"sample string 10","webName":"sample string 11","description":"sample string 12","productType":"sample string 13","additionalDetails":"http://webapihelppage14.com","totalDiscount":15.0,"totalFinalPrice":16.0}
application/xml, text/xml
<v1_ShoppingCarts_ShoppingCartEndpointController.UpdateSingleGeneralProductItemOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ShoppingCarts_ShoppingCartEndpoint"> <additionalDetails>http://webapihelppage14.com/</additionalDetails> <description>sample string 12</description> <discount>9</discount> <id>1</id> <isSubscription>true</isSubscription> <parentId>3</parentId> <parentproductId>2</parentproductId> <price>8</price> <productCategory>sample string 6</productCategory> <productId>4</productId> <productName>sample string 10</productName> <productType>sample string 13</productType> <quantity>7</quantity> <totalDiscount>15</totalDiscount> <totalFinalPrice>16</totalFinalPrice> <webName>sample string 11</webName> </v1_ShoppingCarts_ShoppingCartEndpointController.UpdateSingleGeneralProductItemOutput>