POST api/shoppingcart/save?contactId={contactId}&saveCart={saveCart}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | globally unique identifier |
Required |
|
| saveCart | boolean |
Default value is False |
Body Parameters
ShoppingCart| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| AccountId | globally unique identifier |
None. |
|
| ShoppingCartItems | Collection of ShoppingCartItem |
None. |
|
| Messages | Collection of string |
None. |
|
| CartType | OptionSetValueModel |
None. |
|
| IsVoucherMinimumQuantityMet | boolean |
None. |
|
| VoucherCartMinimumQuantity | integer |
None. |
|
| CartNumber | string |
None. |
|
| ContactMemberId | string |
None. |
|
| AccountMemberId | string |
None. |
|
| OrganizationName | string |
None. |
|
| ContactName | string |
None. |
|
| CouponValidation | CouponValidation |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "fda0cf0b-e8df-449b-8c25-7582d6d2cb23",
"AccountId": "ea8f2758-c714-4a4d-8eaa-a9885784afcf",
"ShoppingCartItems": [
{
"Id": "eb2cba21-11b6-4a48-b23e-a80471879e98",
"WebProductId": "sample string 2",
"WebProductName": "sample string 3",
"ParentWebProductId": "sample string 4",
"ProgramId": "sample string 5",
"ProgramName": "sample string 6",
"ProgramShortName": "sample string 7",
"Name": "sample string 8",
"Price": 9.0,
"TotalPrice": 10.0,
"RetailPrice": 11.0,
"Quantity": 12,
"RecurringBilling": true,
"CouponId": "sample string 14",
"IsShippable": true,
"NotSoldSeparately": true,
"Category": {
"Label": "sample string 1",
"Value": 2
},
"CourseDateSelected": {
"Id": "a3f96d90-f11b-4f32-b5ae-7c62e8d9a46d",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "0744ff66-71bf-4f96-83db-6bbcaf32dea7",
"WebProductName": "sample string 2"
},
{
"WebProductId": "0744ff66-71bf-4f96-83db-6bbcaf32dea7",
"WebProductName": "sample string 2"
}
]
},
{
"Id": "eb2cba21-11b6-4a48-b23e-a80471879e98",
"WebProductId": "sample string 2",
"WebProductName": "sample string 3",
"ParentWebProductId": "sample string 4",
"ProgramId": "sample string 5",
"ProgramName": "sample string 6",
"ProgramShortName": "sample string 7",
"Name": "sample string 8",
"Price": 9.0,
"TotalPrice": 10.0,
"RetailPrice": 11.0,
"Quantity": 12,
"RecurringBilling": true,
"CouponId": "sample string 14",
"IsShippable": true,
"NotSoldSeparately": true,
"Category": {
"Label": "sample string 1",
"Value": 2
},
"CourseDateSelected": {
"Id": "a3f96d90-f11b-4f32-b5ae-7c62e8d9a46d",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "0744ff66-71bf-4f96-83db-6bbcaf32dea7",
"WebProductName": "sample string 2"
},
{
"WebProductId": "0744ff66-71bf-4f96-83db-6bbcaf32dea7",
"WebProductName": "sample string 2"
}
]
}
],
"Messages": [
"sample string 1",
"sample string 2"
],
"CartType": {
"Label": "sample string 1",
"Value": 2
},
"IsVoucherMinimumQuantityMet": true,
"VoucherCartMinimumQuantity": 4,
"CartNumber": "sample string 5",
"ContactMemberId": "sample string 6",
"AccountMemberId": "sample string 7",
"OrganizationName": "sample string 8",
"ContactName": "sample string 9",
"CouponValidation": {
"EvaluateCoupon": true,
"MissingProducts": "sample string 2",
"RemovePresetBundle": true,
"RemovePresetBundleMessage": "sample string 4",
"CouponValidationMessage": {
"MessageCode": "sample string 1",
"MessageType": "sample string 2",
"MessageDescription": "sample string 3"
},
"CouponInCart": true,
"DiscountValue": "sample string 6"
}
}
application/xml, text/xml
Sample:
<ShoppingCart xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AccountId>ea8f2758-c714-4a4d-8eaa-a9885784afcf</AccountId>
<AccountMemberId>sample string 7</AccountMemberId>
<CartNumber>sample string 5</CartNumber>
<CartType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</CartType>
<ContactMemberId>sample string 6</ContactMemberId>
<ContactName>sample string 9</ContactName>
<CouponValidation>
<CouponInCart>true</CouponInCart>
<CouponValidationMessage>
<MessageCode>sample string 1</MessageCode>
<MessageDescription>sample string 3</MessageDescription>
<MessageType>sample string 2</MessageType>
</CouponValidationMessage>
<DiscountValue>sample string 6</DiscountValue>
<EvaluateCoupon>true</EvaluateCoupon>
<MissingProducts>sample string 2</MissingProducts>
<RemovePresetBundle>true</RemovePresetBundle>
<RemovePresetBundleMessage>sample string 4</RemovePresetBundleMessage>
</CouponValidation>
<Id>fda0cf0b-e8df-449b-8c25-7582d6d2cb23</Id>
<IsVoucherMinimumQuantityMet>true</IsVoucherMinimumQuantityMet>
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<OrganizationName>sample string 8</OrganizationName>
<ShoppingCartItems>
<ShoppingCartItem>
<Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</Category>
<CountryRestriction>true</CountryRestriction>
<CouponId>sample string 14</CouponId>
<CourseDateSelected xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>a3f96d90-f11b-4f32-b5ae-7c62e8d9a46d</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</CourseDateSelected>
<EligibleCountries>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
</EligibleCountries>
<Id>eb2cba21-11b6-4a48-b23e-a80471879e98</Id>
<IsHiddenProduct>true</IsHiddenProduct>
<IsPresetBundle>true</IsPresetBundle>
<IsShippable>true</IsShippable>
<Name>sample string 8</Name>
<NotSoldSeparately>true</NotSoldSeparately>
<ParentWebProductId>sample string 4</ParentWebProductId>
<PresetBundleProducts>
<PresetBundleProduct>
<WebProductId>0744ff66-71bf-4f96-83db-6bbcaf32dea7</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>0744ff66-71bf-4f96-83db-6bbcaf32dea7</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
</PresetBundleProducts>
<Price>9</Price>
<ProgramId>sample string 5</ProgramId>
<ProgramName>sample string 6</ProgramName>
<ProgramShortName>sample string 7</ProgramShortName>
<Quantity>12</Quantity>
<RecurringBilling>true</RecurringBilling>
<RetailPrice>11</RetailPrice>
<TotalPrice>10</TotalPrice>
<WebProductId>sample string 2</WebProductId>
<WebProductName>sample string 3</WebProductName>
</ShoppingCartItem>
<ShoppingCartItem>
<Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</Category>
<CountryRestriction>true</CountryRestriction>
<CouponId>sample string 14</CouponId>
<CourseDateSelected xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>a3f96d90-f11b-4f32-b5ae-7c62e8d9a46d</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</CourseDateSelected>
<EligibleCountries>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
</EligibleCountries>
<Id>eb2cba21-11b6-4a48-b23e-a80471879e98</Id>
<IsHiddenProduct>true</IsHiddenProduct>
<IsPresetBundle>true</IsPresetBundle>
<IsShippable>true</IsShippable>
<Name>sample string 8</Name>
<NotSoldSeparately>true</NotSoldSeparately>
<ParentWebProductId>sample string 4</ParentWebProductId>
<PresetBundleProducts>
<PresetBundleProduct>
<WebProductId>0744ff66-71bf-4f96-83db-6bbcaf32dea7</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>0744ff66-71bf-4f96-83db-6bbcaf32dea7</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
</PresetBundleProducts>
<Price>9</Price>
<ProgramId>sample string 5</ProgramId>
<ProgramName>sample string 6</ProgramName>
<ProgramShortName>sample string 7</ProgramShortName>
<Quantity>12</Quantity>
<RecurringBilling>true</RecurringBilling>
<RetailPrice>11</RetailPrice>
<TotalPrice>10</TotalPrice>
<WebProductId>sample string 2</WebProductId>
<WebProductName>sample string 3</WebProductName>
</ShoppingCartItem>
</ShoppingCartItems>
<VoucherCartMinimumQuantity>4</VoucherCartMinimumQuantity>
</ShoppingCart>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ShoppingCart| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| AccountId | globally unique identifier |
None. |
|
| ShoppingCartItems | Collection of ShoppingCartItem |
None. |
|
| Messages | Collection of string |
None. |
|
| CartType | OptionSetValueModel |
None. |
|
| IsVoucherMinimumQuantityMet | boolean |
None. |
|
| VoucherCartMinimumQuantity | integer |
None. |
|
| CartNumber | string |
None. |
|
| ContactMemberId | string |
None. |
|
| AccountMemberId | string |
None. |
|
| OrganizationName | string |
None. |
|
| ContactName | string |
None. |
|
| CouponValidation | CouponValidation |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "81e2a8f7-cd35-4106-a357-7c7c4abd8470",
"AccountId": "a7c7b9bf-e0f8-467c-be4d-22f8e59a4e65",
"ShoppingCartItems": [
{
"Id": "f31ce7c8-9b20-44b8-97a5-bd312ff72699",
"WebProductId": "sample string 2",
"WebProductName": "sample string 3",
"ParentWebProductId": "sample string 4",
"ProgramId": "sample string 5",
"ProgramName": "sample string 6",
"ProgramShortName": "sample string 7",
"Name": "sample string 8",
"Price": 9.0,
"TotalPrice": 10.0,
"RetailPrice": 11.0,
"Quantity": 12,
"RecurringBilling": true,
"CouponId": "sample string 14",
"IsShippable": true,
"NotSoldSeparately": true,
"Category": {
"Label": "sample string 1",
"Value": 2
},
"CourseDateSelected": {
"Id": "be0271d5-34d4-4c49-859b-8539877a8cb3",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "b9ad528b-36bd-48e1-b929-1ad82612036a",
"WebProductName": "sample string 2"
},
{
"WebProductId": "b9ad528b-36bd-48e1-b929-1ad82612036a",
"WebProductName": "sample string 2"
}
]
},
{
"Id": "f31ce7c8-9b20-44b8-97a5-bd312ff72699",
"WebProductId": "sample string 2",
"WebProductName": "sample string 3",
"ParentWebProductId": "sample string 4",
"ProgramId": "sample string 5",
"ProgramName": "sample string 6",
"ProgramShortName": "sample string 7",
"Name": "sample string 8",
"Price": 9.0,
"TotalPrice": 10.0,
"RetailPrice": 11.0,
"Quantity": 12,
"RecurringBilling": true,
"CouponId": "sample string 14",
"IsShippable": true,
"NotSoldSeparately": true,
"Category": {
"Label": "sample string 1",
"Value": 2
},
"CourseDateSelected": {
"Id": "be0271d5-34d4-4c49-859b-8539877a8cb3",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "b9ad528b-36bd-48e1-b929-1ad82612036a",
"WebProductName": "sample string 2"
},
{
"WebProductId": "b9ad528b-36bd-48e1-b929-1ad82612036a",
"WebProductName": "sample string 2"
}
]
}
],
"Messages": [
"sample string 1",
"sample string 2"
],
"CartType": {
"Label": "sample string 1",
"Value": 2
},
"IsVoucherMinimumQuantityMet": true,
"VoucherCartMinimumQuantity": 4,
"CartNumber": "sample string 5",
"ContactMemberId": "sample string 6",
"AccountMemberId": "sample string 7",
"OrganizationName": "sample string 8",
"ContactName": "sample string 9",
"CouponValidation": {
"EvaluateCoupon": true,
"MissingProducts": "sample string 2",
"RemovePresetBundle": true,
"RemovePresetBundleMessage": "sample string 4",
"CouponValidationMessage": {
"MessageCode": "sample string 1",
"MessageType": "sample string 2",
"MessageDescription": "sample string 3"
},
"CouponInCart": true,
"DiscountValue": "sample string 6"
}
}
application/xml, text/xml
Sample:
<ShoppingCart xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AccountId>a7c7b9bf-e0f8-467c-be4d-22f8e59a4e65</AccountId>
<AccountMemberId>sample string 7</AccountMemberId>
<CartNumber>sample string 5</CartNumber>
<CartType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</CartType>
<ContactMemberId>sample string 6</ContactMemberId>
<ContactName>sample string 9</ContactName>
<CouponValidation>
<CouponInCart>true</CouponInCart>
<CouponValidationMessage>
<MessageCode>sample string 1</MessageCode>
<MessageDescription>sample string 3</MessageDescription>
<MessageType>sample string 2</MessageType>
</CouponValidationMessage>
<DiscountValue>sample string 6</DiscountValue>
<EvaluateCoupon>true</EvaluateCoupon>
<MissingProducts>sample string 2</MissingProducts>
<RemovePresetBundle>true</RemovePresetBundle>
<RemovePresetBundleMessage>sample string 4</RemovePresetBundleMessage>
</CouponValidation>
<Id>81e2a8f7-cd35-4106-a357-7c7c4abd8470</Id>
<IsVoucherMinimumQuantityMet>true</IsVoucherMinimumQuantityMet>
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<OrganizationName>sample string 8</OrganizationName>
<ShoppingCartItems>
<ShoppingCartItem>
<Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</Category>
<CountryRestriction>true</CountryRestriction>
<CouponId>sample string 14</CouponId>
<CourseDateSelected xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>be0271d5-34d4-4c49-859b-8539877a8cb3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</CourseDateSelected>
<EligibleCountries>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
</EligibleCountries>
<Id>f31ce7c8-9b20-44b8-97a5-bd312ff72699</Id>
<IsHiddenProduct>true</IsHiddenProduct>
<IsPresetBundle>true</IsPresetBundle>
<IsShippable>true</IsShippable>
<Name>sample string 8</Name>
<NotSoldSeparately>true</NotSoldSeparately>
<ParentWebProductId>sample string 4</ParentWebProductId>
<PresetBundleProducts>
<PresetBundleProduct>
<WebProductId>b9ad528b-36bd-48e1-b929-1ad82612036a</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>b9ad528b-36bd-48e1-b929-1ad82612036a</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
</PresetBundleProducts>
<Price>9</Price>
<ProgramId>sample string 5</ProgramId>
<ProgramName>sample string 6</ProgramName>
<ProgramShortName>sample string 7</ProgramShortName>
<Quantity>12</Quantity>
<RecurringBilling>true</RecurringBilling>
<RetailPrice>11</RetailPrice>
<TotalPrice>10</TotalPrice>
<WebProductId>sample string 2</WebProductId>
<WebProductName>sample string 3</WebProductName>
</ShoppingCartItem>
<ShoppingCartItem>
<Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Label>sample string 1</d4p1:Label>
<d4p1:Value>2</d4p1:Value>
</Category>
<CountryRestriction>true</CountryRestriction>
<CouponId>sample string 14</CouponId>
<CourseDateSelected xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d4p1:Id>be0271d5-34d4-4c49-859b-8539877a8cb3</d4p1:Id>
<d4p1:Name>sample string 2</d4p1:Name>
</CourseDateSelected>
<EligibleCountries>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
</EligibleCountries>
<Id>f31ce7c8-9b20-44b8-97a5-bd312ff72699</Id>
<IsHiddenProduct>true</IsHiddenProduct>
<IsPresetBundle>true</IsPresetBundle>
<IsShippable>true</IsShippable>
<Name>sample string 8</Name>
<NotSoldSeparately>true</NotSoldSeparately>
<ParentWebProductId>sample string 4</ParentWebProductId>
<PresetBundleProducts>
<PresetBundleProduct>
<WebProductId>b9ad528b-36bd-48e1-b929-1ad82612036a</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>b9ad528b-36bd-48e1-b929-1ad82612036a</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
</PresetBundleProducts>
<Price>9</Price>
<ProgramId>sample string 5</ProgramId>
<ProgramName>sample string 6</ProgramName>
<ProgramShortName>sample string 7</ProgramShortName>
<Quantity>12</Quantity>
<RecurringBilling>true</RecurringBilling>
<RetailPrice>11</RetailPrice>
<TotalPrice>10</TotalPrice>
<WebProductId>sample string 2</WebProductId>
<WebProductName>sample string 3</WebProductName>
</ShoppingCartItem>
</ShoppingCartItems>
<VoucherCartMinimumQuantity>4</VoucherCartMinimumQuantity>
</ShoppingCart>