GET api/shoppingcart?contactId={contactId}&accountId={accountId}&clearCart={clearCart}&ignoreCartType={ignoreCartType}

Retrieves existing Shopping Cart or creates an empty Shopping Cart

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

globally unique identifier

Required

accountId

globally unique identifier

None.

clearCart

boolean

Default value is False

ignoreCartType

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ShoppingCart
NameDescriptionTypeAdditional 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": "31bdcfb7-f6aa-4bd5-855b-7444b9294e13",
  "AccountId": "8c7e4f02-1125-4704-89ad-f3a563fca476",
  "ShoppingCartItems": [
    {
      "Id": "3ad87b17-c329-412a-a1d2-6632ac36a8f1",
      "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": "f6a4db73-26e9-413a-b730-97b7e99cefe2",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ]
    },
    {
      "Id": "3ad87b17-c329-412a-a1d2-6632ac36a8f1",
      "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": "f6a4db73-26e9-413a-b730-97b7e99cefe2",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ]
    }
  ],
  "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>8c7e4f02-1125-4704-89ad-f3a563fca476</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>31bdcfb7-f6aa-4bd5-855b-7444b9294e13</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>f6a4db73-26e9-413a-b730-97b7e99cefe2</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>3ad87b17-c329-412a-a1d2-6632ac36a8f1</Id>
      <IsHiddenProduct>true</IsHiddenProduct>
      <IsShippable>true</IsShippable>
      <Name>sample string 8</Name>
      <NotSoldSeparately>true</NotSoldSeparately>
      <ParentWebProductId>sample string 4</ParentWebProductId>
      <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>f6a4db73-26e9-413a-b730-97b7e99cefe2</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>3ad87b17-c329-412a-a1d2-6632ac36a8f1</Id>
      <IsHiddenProduct>true</IsHiddenProduct>
      <IsShippable>true</IsShippable>
      <Name>sample string 8</Name>
      <NotSoldSeparately>true</NotSoldSeparately>
      <ParentWebProductId>sample string 4</ParentWebProductId>
      <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>