GET v1/ShoppingCarts
Retrieves top level information about the cart contents.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ShoppingCartOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| numberOfItems |
The number of items in the cart. |
integer |
None. |
| couponId |
The id of the coupon applied to the order. |
integer |
None. |
| couponName |
The display name of the coupon code. |
string |
None. |
| totalSavings |
The total discount applied for all items in the cart |
decimal number |
None. |
| subTotal |
The sum of all items in the cart, after discounts, but prior to tax and shipping charges. |
decimal number |
None. |
| shipping |
The cost of shipping on the order. |
decimal number |
None. |
| handling |
The cost of handling on the order. |
decimal number |
None. |
| tax |
The cost of tax on the order. |
decimal number |
None. |
| grandTotalBeforeDiscount |
The final price the user should expect to pay,before discounts. |
decimal number |
None. |
| currencyTypeId |
The id of the currency being used on the order. |
integer |
None. |
| currencySymbol |
The currency symbol for the order. |
string |
None. |
| shippingAddressId |
The address id where the order will be shipped. |
integer |
None. |
| shipToLine1 |
The address details where the order will be shipped. |
string |
None. |
| shipToLine2 |
The address details where the order will be shipped. |
string |
None. |
| shipToCity |
City details where the order will be shipped. |
string |
None. |
| shipToState |
State details where the order will be shipped. |
string |
None. |
| shipToZipCode |
Zip Code details where the order will be shipped. |
string |
None. |
| shipToCountry |
Country name where the order will be shipped. |
string |
None. |
| billingAddressId |
The address id to charge the order to. |
integer |
None. |
| billToLine1 |
The address details to charge the order to. |
string |
None. |
| billToLine2 |
The address details to charge the order to. |
string |
None. |
| billToCity |
City details to charge the order to. |
string |
None. |
| billToState |
State details to charge the order to. |
string |
None. |
| billToZipCode |
Zip Code details to charge the order to. |
string |
None. |
| billToCountry |
Country details to charge the order to. |
string |
None. |
| shipmentTypeId |
Shipment type ID to charge the order to. |
integer |
None. |
| shipmentTypeName |
Shipment type Name to charge the order to. |
string |
None. |
Response Formats
application/json, text/json
{
"numberOfItems": 1,
"couponId": 2,
"couponName": "sample string 3",
"totalSavings": 4.0,
"subTotal": 5.0,
"shipping": 6.0,
"handling": 7.0,
"tax": 8.0,
"grandTotalBeforeDiscount": 9.0,
"currencyTypeId": 10,
"currencySymbol": "sample string 11",
"shippingAddressId": 12,
"shipToLine1": "sample string 13",
"shipToLine2": "sample string 14",
"shipToCity": "sample string 15",
"shipToState": "sample string 16",
"shipToZipCode": "sample string 17",
"shipToCountry": "sample string 18",
"billingAddressId": 19,
"billToLine1": "sample string 20",
"billToLine2": "sample string 21",
"billToCity": "sample string 22",
"billToState": "sample string 23",
"billToZipCode": "sample string 24",
"billToCountry": "sample string 25",
"shipmentTypeId": 26,
"shipmentTypeName": "sample string 27"
}
text/html
{"numberOfItems":1,"couponId":2,"couponName":"sample string 3","totalSavings":4.0,"subTotal":5.0,"shipping":6.0,"handling":7.0,"tax":8.0,"grandTotalBeforeDiscount":9.0,"currencyTypeId":10,"currencySymbol":"sample string 11","shippingAddressId":12,"shipToLine1":"sample string 13","shipToLine2":"sample string 14","shipToCity":"sample string 15","shipToState":"sample string 16","shipToZipCode":"sample string 17","shipToCountry":"sample string 18","billingAddressId":19,"billToLine1":"sample string 20","billToLine2":"sample string 21","billToCity":"sample string 22","billToState":"sample string 23","billToZipCode":"sample string 24","billToCountry":"sample string 25","shipmentTypeId":26,"shipmentTypeName":"sample string 27"}
application/xml, text/xml
<v1_ShoppingCarts_ShoppingCartEndpointController.ShoppingCartOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ShoppingCarts_ShoppingCartEndpoint"> <billToCity>sample string 22</billToCity> <billToCountry>sample string 25</billToCountry> <billToLine1>sample string 20</billToLine1> <billToLine2>sample string 21</billToLine2> <billToState>sample string 23</billToState> <billToZipCode>sample string 24</billToZipCode> <billingAddressId>19</billingAddressId> <couponId>2</couponId> <couponName>sample string 3</couponName> <currencySymbol>sample string 11</currencySymbol> <currencyTypeId>10</currencyTypeId> <grandTotalBeforeDiscount>9</grandTotalBeforeDiscount> <handling>7</handling> <numberOfItems>1</numberOfItems> <shipToCity>sample string 15</shipToCity> <shipToCountry>sample string 18</shipToCountry> <shipToLine1>sample string 13</shipToLine1> <shipToLine2>sample string 14</shipToLine2> <shipToState>sample string 16</shipToState> <shipToZipCode>sample string 17</shipToZipCode> <shipmentTypeId>26</shipmentTypeId> <shipmentTypeName>sample string 27</shipmentTypeName> <shipping>6</shipping> <shippingAddressId>12</shippingAddressId> <subTotal>5</subTotal> <tax>8</tax> <totalSavings>4</totalSavings> </v1_ShoppingCarts_ShoppingCartEndpointController.ShoppingCartOutput>