GET /service/api/ecom/shop/carts/{vendorOrderCode}
Gets a cart by its vendorOrderCode. The response will also include the cart’s items and customers, if present.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| vendorOrderCode |
Identifier of the cart. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/ecom/shop/carts/PSV0051871636
|
Body Parameters
None.
Response Information
Resource Description
Cart associated to 'vendorOrderCode'.
GetCartResponseServiceModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| VendorOrderCode |
An identifier of the order. |
string |
None. |
| CartOrderStatusId |
The status identifier of the cart order (1,2,3). |
integer |
None. |
| TypeOfOrder |
The type of cart order placed ("RESELLER", "MSP"). |
string |
None. |
| TotalAmount |
The total amount of the cart order. |
decimal number |
None. |
| TotalAmountFmt |
The format of the TotalAmount field (e.g. "$0.00"). |
string |
None. |
| SubTotalAmount |
The sub total amount of the cart order. |
decimal number |
None. |
| SubTotalAmountFmt |
The format of the SubTotalAmount field (e.g. "$0.00"). |
string |
None. |
| TaxAmount |
The tax amount of the cart order. |
decimal number |
None. |
| TaxAmountFmt |
The format of the TaxAmount field (e.g. "$0.00"). |
string |
None. |
| Locale |
The language and territory used as the locale setting for the order (e.g. "en_US"). |
string |
None. |
| SalesOrderDate |
The date when the sale was processed. |
date |
None. |
| CurrencyCode |
The ISO three-letter currency code of the order (e.g. "USD"). |
string |
None. |
| Items |
The items contained in this cart. |
Collection of Collection of CartResponseServiceModel_CartItem |
None. |
| Customers |
The customers associated to this cart. |
CartResponseServiceModel_CartCustomers |
None. |
Sample Response
{
"VendorOrderCode": "MSP0046543056",
"CartOrderStatusId": 1,
"TypeOfOrder": "MSP",
"TotalAmount": 39.99,
"TotalAmountFmt": "$39.99",
"SubTotalAmount": 39.99,
"SubTotalAmountFmt": "$39.99",
"TaxAmount": 0.0,
"TaxAmountFmt": "$0.00",
"Locale": "en_US",
"SalesOrderDate": "2024-04-23T11:40:23",
"CurrencyCode": "USD",
"Items": [
[
{
"CartOrderItemId": 11223344,
"LineItem": 1,
"Quantity": 150,
"Years": "1",
"ListPrice": 4.99,
"ListPriceFmt": "$4.99",
"UnitPrice": 4.99,
"UnitPriceFmt": "$4.99 Today",
"SubTotalAmount": 748.5,
"SubTotalAmountFmt": "$748.50 Today",
"SubTotalListAmount": 748.5,
"SubTotalListAmountFmt": "$748.50",
"ProductId": 152200101,
"ProductDescription": "Webroot Business Endpoint Protection 1 Year Parent",
"ProductTypeId": 1,
"ProductTypeDescription": "New",
"LicenseKeycodeTypeId": 3,
"LicenseCategoryName": "SAEP",
"LicenseCategoryDescription": "Webroot Endpoint Protection",
"ProductFamilyDescription": "Webroot Secure Anywhere Business",
"StartDate": "2024-04-23T00:00:00Z",
"ExpirationDate": "2025-04-23T00:00:00Z",
"CartItemBundleId": 1,
"ItemHierarchyId": 1,
"DependentCartOrderItemId": null,
"Keycode": null,
"LicenseAttributeValue": 110,
"LicenseAttributeValueDescription": "Monthly Sold",
"UsagePricingModelId": null,
"UsagePricingModelName": null,
"VendorOrderItemCode": null,
"OrderItemUpdateTypeId": null,
"LicenseProfile": {},
"LicenseSeats": 1,
"VaultId": null,
"VaultName": null,
"ProductPlatformId": null,
"ProductPlatformName": null,
"RetentionModelId": null,
"RetentionModelName": null,
"ProductPricingLevelId": 1,
"ProductPricingLevelDescription": "Standard"
},
{
"CartOrderItemId": 11223345,
"LineItem": 2,
"Quantity": 150,
"Years": "1",
"ListPrice": 5.99,
"ListPriceFmt": "$5.99",
"UnitPrice": 5.99,
"UnitPriceFmt": "$5.99 Today",
"SubTotalAmount": 898.5,
"SubTotalAmountFmt": "$898.50 Today",
"SubTotalListAmount": 898.5,
"SubTotalListAmountFmt": "$898.50",
"ProductId": 152300101,
"ProductDescription": "Webroot DNS Protection 1 Year Parent",
"ProductTypeId": 1,
"ProductTypeDescription": "New",
"LicenseKeycodeTypeId": 3,
"LicenseCategoryName": "SDNS",
"LicenseCategoryDescription": "Webroot DNS Protection",
"ProductFamilyDescription": "Webroot Secure Anywhere Business",
"StartDate": "2024-04-23T00:00:00Z",
"ExpirationDate": "2025-04-23T00:00:00Z",
"CartItemBundleId": 1,
"ItemHierarchyId": 2,
"DependentCartOrderItemId": null,
"Keycode": null,
"LicenseAttributeValue": 110,
"LicenseAttributeValueDescription": "Monthly Sold",
"UsagePricingModelId": null,
"UsagePricingModelName": null,
"VendorOrderItemCode": null,
"OrderItemUpdateTypeId": null,
"LicenseProfile": {},
"LicenseSeats": 1,
"VaultId": null,
"VaultName": null,
"ProductPlatformId": null,
"ProductPlatformName": null,
"RetentionModelId": null,
"RetentionModelName": null,
"ProductPricingLevelId": 1,
"ProductPricingLevelDescription": "Standard"
}
]
],
"Customers": {
"Billing": {
"FirstName": "John",
"LastName": "Doe",
"Address1": "Webroot Way 21",
"Address2": null,
"City": "Broomfield",
"PostalCode": "80021",
"State": "CO",
"Country": "US",
"CustomerEmail": "jdoe@webroot.com",
"CompanyName": "ACME, Inc.",
"ExternalCustomerKey": "E000330442",
"VatId": "A123456",
"CustomerTypeId": 1,
"CustomerTypeDescription": "Billing"
},
"Shipping": {
"FirstName": "John",
"LastName": "Doe",
"Address1": "Webroot Way 21",
"Address2": null,
"City": "Broomfield",
"PostalCode": "80021",
"State": "CO",
"Country": "US",
"CustomerEmail": "jdoe@webroot.com",
"CompanyName": "ACME, Inc.",
"ExternalCustomerKey": "E000449514",
"VatId": "A123456",
"CustomerTypeId": 2,
"CustomerTypeDescription": "Shipping"
},
"Reseller": null
}
}
<GetCartResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
<CartOrderStatusId>1</CartOrderStatusId>
<CurrencyCode>USD</CurrencyCode>
<Customers>
<Billing>
<Address1>Webroot Way 21</Address1>
<Address2 i:nil="true" />
<City>Broomfield</City>
<CompanyName>ACME, Inc.</CompanyName>
<Country>US</Country>
<CustomerEmail>jdoe@webroot.com</CustomerEmail>
<CustomerTypeDescription>Billing</CustomerTypeDescription>
<CustomerTypeId>1</CustomerTypeId>
<ExternalCustomerKey>E000330442</ExternalCustomerKey>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<PostalCode>80021</PostalCode>
<State>CO</State>
<VatId>A123456</VatId>
</Billing>
<Reseller i:nil="true" />
<Shipping>
<Address1>Webroot Way 21</Address1>
<Address2 i:nil="true" />
<City>Broomfield</City>
<CompanyName>ACME, Inc.</CompanyName>
<Country>US</Country>
<CustomerEmail>jdoe@webroot.com</CustomerEmail>
<CustomerTypeDescription>Shipping</CustomerTypeDescription>
<CustomerTypeId>2</CustomerTypeId>
<ExternalCustomerKey>E000449514</ExternalCustomerKey>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<PostalCode>80021</PostalCode>
<State>CO</State>
<VatId>A123456</VatId>
</Shipping>
</Customers>
<Items>
<ArrayOfCartResponseServiceModel_CartItem>
<CartResponseServiceModel_CartItem>
<CartItemBundleId>1</CartItemBundleId>
<CartOrderItemId>11223344</CartOrderItemId>
<DependentCartOrderItemId i:nil="true" />
<ExpirationDate>2025-04-23T00:00:00Z</ExpirationDate>
<ItemHierarchyId>1</ItemHierarchyId>
<Keycode i:nil="true" />
<LicenseAttributeValue>110</LicenseAttributeValue>
<LicenseAttributeValueDescription>Monthly Sold</LicenseAttributeValueDescription>
<LicenseCategoryDescription>Webroot Endpoint Protection</LicenseCategoryDescription>
<LicenseCategoryName>SAEP</LicenseCategoryName>
<LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
<LicenseProfile xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<LicenseSeats>1</LicenseSeats>
<LineItem>1</LineItem>
<ListPrice>4.99</ListPrice>
<ListPriceFmt>$4.99</ListPriceFmt>
<OrderItemUpdateTypeId i:nil="true" />
<ProductDescription>Webroot Business Endpoint Protection 1 Year Parent</ProductDescription>
<ProductFamilyDescription>Webroot Secure Anywhere Business</ProductFamilyDescription>
<ProductId>152200101</ProductId>
<ProductPlatformId i:nil="true" />
<ProductPlatformName i:nil="true" />
<ProductPricingLevelDescription>Standard</ProductPricingLevelDescription>
<ProductPricingLevelId>1</ProductPricingLevelId>
<ProductTypeDescription>New</ProductTypeDescription>
<ProductTypeId>1</ProductTypeId>
<Quantity>150</Quantity>
<RetentionModelId i:nil="true" />
<RetentionModelName i:nil="true" />
<StartDate>2024-04-23T00:00:00Z</StartDate>
<SubTotalAmount>748.5</SubTotalAmount>
<SubTotalAmountFmt>$748.50 Today</SubTotalAmountFmt>
<SubTotalListAmount>748.5</SubTotalListAmount>
<SubTotalListAmountFmt>$748.50</SubTotalListAmountFmt>
<UnitPrice>4.99</UnitPrice>
<UnitPriceFmt>$4.99 Today</UnitPriceFmt>
<UsagePricingModelId i:nil="true" />
<UsagePricingModelName i:nil="true" />
<VaultId i:nil="true" />
<VaultName i:nil="true" />
<VendorOrderItemCode i:nil="true" />
<Years>1</Years>
</CartResponseServiceModel_CartItem>
<CartResponseServiceModel_CartItem>
<CartItemBundleId>1</CartItemBundleId>
<CartOrderItemId>11223345</CartOrderItemId>
<DependentCartOrderItemId i:nil="true" />
<ExpirationDate>2025-04-23T00:00:00Z</ExpirationDate>
<ItemHierarchyId>2</ItemHierarchyId>
<Keycode i:nil="true" />
<LicenseAttributeValue>110</LicenseAttributeValue>
<LicenseAttributeValueDescription>Monthly Sold</LicenseAttributeValueDescription>
<LicenseCategoryDescription>Webroot DNS Protection</LicenseCategoryDescription>
<LicenseCategoryName>SDNS</LicenseCategoryName>
<LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
<LicenseProfile xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<LicenseSeats>1</LicenseSeats>
<LineItem>2</LineItem>
<ListPrice>5.99</ListPrice>
<ListPriceFmt>$5.99</ListPriceFmt>
<OrderItemUpdateTypeId i:nil="true" />
<ProductDescription>Webroot DNS Protection 1 Year Parent</ProductDescription>
<ProductFamilyDescription>Webroot Secure Anywhere Business</ProductFamilyDescription>
<ProductId>152300101</ProductId>
<ProductPlatformId i:nil="true" />
<ProductPlatformName i:nil="true" />
<ProductPricingLevelDescription>Standard</ProductPricingLevelDescription>
<ProductPricingLevelId>1</ProductPricingLevelId>
<ProductTypeDescription>New</ProductTypeDescription>
<ProductTypeId>1</ProductTypeId>
<Quantity>150</Quantity>
<RetentionModelId i:nil="true" />
<RetentionModelName i:nil="true" />
<StartDate>2024-04-23T00:00:00Z</StartDate>
<SubTotalAmount>898.5</SubTotalAmount>
<SubTotalAmountFmt>$898.50 Today</SubTotalAmountFmt>
<SubTotalListAmount>898.5</SubTotalListAmount>
<SubTotalListAmountFmt>$898.50</SubTotalListAmountFmt>
<UnitPrice>5.99</UnitPrice>
<UnitPriceFmt>$5.99 Today</UnitPriceFmt>
<UsagePricingModelId i:nil="true" />
<UsagePricingModelName i:nil="true" />
<VaultId i:nil="true" />
<VaultName i:nil="true" />
<VendorOrderItemCode i:nil="true" />
<Years>1</Years>
</CartResponseServiceModel_CartItem>
</ArrayOfCartResponseServiceModel_CartItem>
</Items>
<Locale>en_US</Locale>
<SalesOrderDate>2024-04-23T11:40:23</SalesOrderDate>
<SubTotalAmount>39.99</SubTotalAmount>
<SubTotalAmountFmt>$39.99</SubTotalAmountFmt>
<TaxAmount>0</TaxAmount>
<TaxAmountFmt>$0.00</TaxAmountFmt>
<TotalAmount>39.99</TotalAmount>
<TotalAmountFmt>$39.99</TotalAmountFmt>
<TypeOfOrder>MSP</TypeOfOrder>
<VendorOrderCode>MSP0046543056</VendorOrderCode>
</GetCartResponseServiceModel>