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

ShoppingCart

Name	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": "0be1dc8b-0eee-4b0d-abee-8f9425059954",
  "AccountId": "8d3cc019-6d2f-4945-961f-701fe51c2869",
  "ShoppingCartItems": [
    {
      "Id": "765da874-1c99-4c39-9259-387fc48d8122",
      "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": "3877b942-1630-4a36-a94d-e65e6dca3a39",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ],
      "IsPresetBundle": true,
      "PresetBundleProducts": [
        {
          "WebProductId": "3416748c-1ec5-47e4-b4fa-95a49be31694",
          "WebProductName": "sample string 2"
        },
        {
          "WebProductId": "3416748c-1ec5-47e4-b4fa-95a49be31694",
          "WebProductName": "sample string 2"
        }
      ]
    },
    {
      "Id": "765da874-1c99-4c39-9259-387fc48d8122",
      "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": "3877b942-1630-4a36-a94d-e65e6dca3a39",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ],
      "IsPresetBundle": true,
      "PresetBundleProducts": [
        {
          "WebProductId": "3416748c-1ec5-47e4-b4fa-95a49be31694",
          "WebProductName": "sample string 2"
        },
        {
          "WebProductId": "3416748c-1ec5-47e4-b4fa-95a49be31694",
          "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>8d3cc019-6d2f-4945-961f-701fe51c2869</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>0be1dc8b-0eee-4b0d-abee-8f9425059954</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>3877b942-1630-4a36-a94d-e65e6dca3a39</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>765da874-1c99-4c39-9259-387fc48d8122</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>3416748c-1ec5-47e4-b4fa-95a49be31694</WebProductId>
          <WebProductName>sample string 2</WebProductName>
        </PresetBundleProduct>
        <PresetBundleProduct>
          <WebProductId>3416748c-1ec5-47e4-b4fa-95a49be31694</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>3877b942-1630-4a36-a94d-e65e6dca3a39</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>765da874-1c99-4c39-9259-387fc48d8122</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>3416748c-1ec5-47e4-b4fa-95a49be31694</WebProductId>
          <WebProductName>sample string 2</WebProductName>
        </PresetBundleProduct>
        <PresetBundleProduct>
          <WebProductId>3416748c-1ec5-47e4-b4fa-95a49be31694</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	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": "9f5c5535-f5fa-419d-84a0-20c9027582a6",
  "AccountId": "2c4226fd-8955-4ddf-8cfa-478d9edfb05e",
  "ShoppingCartItems": [
    {
      "Id": "f6edd22e-df90-4c67-a773-bf7f01c80fdd",
      "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": "60435273-f086-4bc3-a0b1-98d8a7addae9",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ],
      "IsPresetBundle": true,
      "PresetBundleProducts": [
        {
          "WebProductId": "fac04dcd-9b7e-4bec-999b-b31260f1747c",
          "WebProductName": "sample string 2"
        },
        {
          "WebProductId": "fac04dcd-9b7e-4bec-999b-b31260f1747c",
          "WebProductName": "sample string 2"
        }
      ]
    },
    {
      "Id": "f6edd22e-df90-4c67-a773-bf7f01c80fdd",
      "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": "60435273-f086-4bc3-a0b1-98d8a7addae9",
        "Name": "sample string 2"
      },
      "IsHiddenProduct": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ],
      "IsPresetBundle": true,
      "PresetBundleProducts": [
        {
          "WebProductId": "fac04dcd-9b7e-4bec-999b-b31260f1747c",
          "WebProductName": "sample string 2"
        },
        {
          "WebProductId": "fac04dcd-9b7e-4bec-999b-b31260f1747c",
          "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>2c4226fd-8955-4ddf-8cfa-478d9edfb05e</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>9f5c5535-f5fa-419d-84a0-20c9027582a6</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>60435273-f086-4bc3-a0b1-98d8a7addae9</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>f6edd22e-df90-4c67-a773-bf7f01c80fdd</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>fac04dcd-9b7e-4bec-999b-b31260f1747c</WebProductId>
          <WebProductName>sample string 2</WebProductName>
        </PresetBundleProduct>
        <PresetBundleProduct>
          <WebProductId>fac04dcd-9b7e-4bec-999b-b31260f1747c</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>60435273-f086-4bc3-a0b1-98d8a7addae9</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>f6edd22e-df90-4c67-a773-bf7f01c80fdd</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>fac04dcd-9b7e-4bec-999b-b31260f1747c</WebProductId>
          <WebProductName>sample string 2</WebProductName>
        </PresetBundleProduct>
        <PresetBundleProduct>
          <WebProductId>fac04dcd-9b7e-4bec-999b-b31260f1747c</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>