POST v1/ShoppingCarts/Items/GeneralProduct
Adds a general product to the cart.
Request Information
URI Parameters
None.
Body Parameters
AddGeneralProductInputName | Description | Type | Additional information |
---|---|---|---|
productId | integer |
Required |
|
quantity | integer |
Required |
Request Formats
application/json, text/json
{ "productId": 1, "quantity": 2 }
text/html
{"productId":1,"quantity":2}
application/xml, text/xml
<v1_ShoppingCarts_ShoppingCartEndpointController.AddGeneralProductInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ShoppingCarts_ShoppingCartEndpoint"> <productId>1</productId> <quantity>2</quantity> </v1_ShoppingCarts_ShoppingCartEndpointController.AddGeneralProductInput>
application/x-www-form-urlencoded
Response Information
Resource Description
Collection of AddGeneralProductOutputName | 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 }, { "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},{"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
<ArrayOfv1_ShoppingCarts_ShoppingCartEndpointController.AddGeneralProductOutput 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.AddGeneralProductOutput> <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.AddGeneralProductOutput> <v1_ShoppingCarts_ShoppingCartEndpointController.AddGeneralProductOutput> <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.AddGeneralProductOutput> </ArrayOfv1_ShoppingCarts_ShoppingCartEndpointController.AddGeneralProductOutput>