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": "47fc576d-d0d8-4d95-9e93-5d8b32f4f050",
"AccountId": "0242f83f-c829-4a0e-938e-53ab7ba98d87",
"ShoppingCartItems": [
{
"Id": "92f3b1ab-5d36-4c95-8d26-2e20eeb64c67",
"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": "615474b6-21bb-49bd-8202-3fc235e5e649",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "46cd772a-5092-4ff9-9de8-4f066fcf9a92",
"WebProductName": "sample string 2"
},
{
"WebProductId": "46cd772a-5092-4ff9-9de8-4f066fcf9a92",
"WebProductName": "sample string 2"
}
]
},
{
"Id": "92f3b1ab-5d36-4c95-8d26-2e20eeb64c67",
"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": "615474b6-21bb-49bd-8202-3fc235e5e649",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "46cd772a-5092-4ff9-9de8-4f066fcf9a92",
"WebProductName": "sample string 2"
},
{
"WebProductId": "46cd772a-5092-4ff9-9de8-4f066fcf9a92",
"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>0242f83f-c829-4a0e-938e-53ab7ba98d87</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>47fc576d-d0d8-4d95-9e93-5d8b32f4f050</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>615474b6-21bb-49bd-8202-3fc235e5e649</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>92f3b1ab-5d36-4c95-8d26-2e20eeb64c67</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>46cd772a-5092-4ff9-9de8-4f066fcf9a92</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>46cd772a-5092-4ff9-9de8-4f066fcf9a92</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>615474b6-21bb-49bd-8202-3fc235e5e649</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>92f3b1ab-5d36-4c95-8d26-2e20eeb64c67</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>46cd772a-5092-4ff9-9de8-4f066fcf9a92</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>46cd772a-5092-4ff9-9de8-4f066fcf9a92</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": "f750dde5-508b-4987-9e9b-9627a017e542",
"AccountId": "d21a429a-68d3-45a1-9c49-8a3d2c6c4218",
"ShoppingCartItems": [
{
"Id": "c9242c44-8374-4d1a-8fa3-1b30f8fe7d5f",
"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": "c495e602-4daf-464d-a35f-1cc290a8f987",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "75f5c3a1-bc1d-44de-bdec-c0ac061e187b",
"WebProductName": "sample string 2"
},
{
"WebProductId": "75f5c3a1-bc1d-44de-bdec-c0ac061e187b",
"WebProductName": "sample string 2"
}
]
},
{
"Id": "c9242c44-8374-4d1a-8fa3-1b30f8fe7d5f",
"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": "c495e602-4daf-464d-a35f-1cc290a8f987",
"Name": "sample string 2"
},
"IsHiddenProduct": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsPresetBundle": true,
"PresetBundleProducts": [
{
"WebProductId": "75f5c3a1-bc1d-44de-bdec-c0ac061e187b",
"WebProductName": "sample string 2"
},
{
"WebProductId": "75f5c3a1-bc1d-44de-bdec-c0ac061e187b",
"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>d21a429a-68d3-45a1-9c49-8a3d2c6c4218</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>f750dde5-508b-4987-9e9b-9627a017e542</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>c495e602-4daf-464d-a35f-1cc290a8f987</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>c9242c44-8374-4d1a-8fa3-1b30f8fe7d5f</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>75f5c3a1-bc1d-44de-bdec-c0ac061e187b</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>75f5c3a1-bc1d-44de-bdec-c0ac061e187b</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>c495e602-4daf-464d-a35f-1cc290a8f987</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>c9242c44-8374-4d1a-8fa3-1b30f8fe7d5f</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>75f5c3a1-bc1d-44de-bdec-c0ac061e187b</WebProductId>
<WebProductName>sample string 2</WebProductName>
</PresetBundleProduct>
<PresetBundleProduct>
<WebProductId>75f5c3a1-bc1d-44de-bdec-c0ac061e187b</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>