POST api/shoppingcart?contactId={contactId}&clearCart={clearCart}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactId | globally unique identifier |
Required |
|
clearCart | boolean |
Default value is False |
Body Parameters
ShoppingCartName | 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": "0850f2a7-e862-4bb8-9fb7-debff5c71cb7", "AccountId": "4548cb09-45fd-436e-ad55-5711dab104b7", "ShoppingCartItems": [ { "Id": "4e08ea53-774a-4dd4-a616-39579da6abc7", "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": "e73c3526-ea45-4689-a601-f6e9692f6924", "Name": "sample string 2" }, "IsHiddenProduct": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ], "IsPresetBundle": true, "PresetBundleProducts": [ { "WebProductId": "ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29", "WebProductName": "sample string 2" }, { "WebProductId": "ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29", "WebProductName": "sample string 2" } ] }, { "Id": "4e08ea53-774a-4dd4-a616-39579da6abc7", "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": "e73c3526-ea45-4689-a601-f6e9692f6924", "Name": "sample string 2" }, "IsHiddenProduct": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ], "IsPresetBundle": true, "PresetBundleProducts": [ { "WebProductId": "ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29", "WebProductName": "sample string 2" }, { "WebProductId": "ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29", "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>4548cb09-45fd-436e-ad55-5711dab104b7</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>0850f2a7-e862-4bb8-9fb7-debff5c71cb7</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>e73c3526-ea45-4689-a601-f6e9692f6924</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>4e08ea53-774a-4dd4-a616-39579da6abc7</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>ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29</WebProductId> <WebProductName>sample string 2</WebProductName> </PresetBundleProduct> <PresetBundleProduct> <WebProductId>ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29</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>e73c3526-ea45-4689-a601-f6e9692f6924</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>4e08ea53-774a-4dd4-a616-39579da6abc7</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>ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29</WebProductId> <WebProductName>sample string 2</WebProductName> </PresetBundleProduct> <PresetBundleProduct> <WebProductId>ecb1dd6f-86ed-42d1-9051-ddfaa1dc8a29</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
ShoppingCartName | 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": "20491b48-aadc-40ca-8b54-0114a28e2bab", "AccountId": "d633bf36-f6bf-4bd9-8a6d-c51c1e9b8458", "ShoppingCartItems": [ { "Id": "9354c047-c561-456a-8b4a-89f05b8a5759", "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": "1994f261-75cd-4200-9ec0-b4cde23bcd6c", "Name": "sample string 2" }, "IsHiddenProduct": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ], "IsPresetBundle": true, "PresetBundleProducts": [ { "WebProductId": "a3b3d3eb-a000-49b1-82f0-0a604edec42a", "WebProductName": "sample string 2" }, { "WebProductId": "a3b3d3eb-a000-49b1-82f0-0a604edec42a", "WebProductName": "sample string 2" } ] }, { "Id": "9354c047-c561-456a-8b4a-89f05b8a5759", "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": "1994f261-75cd-4200-9ec0-b4cde23bcd6c", "Name": "sample string 2" }, "IsHiddenProduct": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ], "IsPresetBundle": true, "PresetBundleProducts": [ { "WebProductId": "a3b3d3eb-a000-49b1-82f0-0a604edec42a", "WebProductName": "sample string 2" }, { "WebProductId": "a3b3d3eb-a000-49b1-82f0-0a604edec42a", "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>d633bf36-f6bf-4bd9-8a6d-c51c1e9b8458</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>20491b48-aadc-40ca-8b54-0114a28e2bab</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>1994f261-75cd-4200-9ec0-b4cde23bcd6c</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>9354c047-c561-456a-8b4a-89f05b8a5759</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>a3b3d3eb-a000-49b1-82f0-0a604edec42a</WebProductId> <WebProductName>sample string 2</WebProductName> </PresetBundleProduct> <PresetBundleProduct> <WebProductId>a3b3d3eb-a000-49b1-82f0-0a604edec42a</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>1994f261-75cd-4200-9ec0-b4cde23bcd6c</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>9354c047-c561-456a-8b4a-89f05b8a5759</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>a3b3d3eb-a000-49b1-82f0-0a604edec42a</WebProductId> <WebProductName>sample string 2</WebProductName> </PresetBundleProduct> <PresetBundleProduct> <WebProductId>a3b3d3eb-a000-49b1-82f0-0a604edec42a</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>