POST Subscriber/{subscriberId}/Location/{locationId}/Cart/{cartId}/Items/{catalogItemId}?quantity={quantity}

Adds an item to shopping cart via the catalog item id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
catalogItemId

integer

Required

quantity

Defaults to 1

integer

Default value is 1

subscriberId

string

None.

locationId

string

None.

cartId

string

None.

Body Parameters

None.

Response Information

Resource Description

HTTP status code 200 Ok


HTTP status code 400 BadRequest


HTTP status code 401 Unauthorized
HTTP status code 403 Forbidden

CartItem
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Item

CatalogItem

None.

Pricing

CartItemPricing

None.

RecipientConsumerId

integer

None.

Quantity

integer

None.

Created

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "ccaeac75-6b5f-4691-93bd-42216d9b07d1",
  "Item": {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Image": "http://webapihelppage4.com",
    "Type": "sample string 5",
    "Templates": [
      {
        "Name": "sample string 1",
        "TemplateType": "sample string 2",
        "Metadata": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2",
            "Type": "sample string 3",
            "Label": "sample string 4",
            "Rules": [
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2",
            "Type": "sample string 3",
            "Label": "sample string 4",
            "Rules": [
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      {
        "Name": "sample string 1",
        "TemplateType": "sample string 2",
        "Metadata": [
          {
            "Key": "sample string 1",
            "Value": "sample string 2",
            "Type": "sample string 3",
            "Label": "sample string 4",
            "Rules": [
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Key": "sample string 1",
            "Value": "sample string 2",
            "Type": "sample string 3",
            "Label": "sample string 4",
            "Rules": [
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Rule": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      }
    ],
    "Options": [
      {
        "MetadataType": "sample string 1",
        "Items": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "Properties": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "Properties": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          }
        ]
      },
      {
        "MetadataType": "sample string 1",
        "Items": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "Properties": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "Properties": {
              "sample string 1": "sample string 2",
              "sample string 3": "sample string 4"
            }
          }
        ]
      }
    ],
    "Rules": [
      {
        "Rule": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ],
        "Key": "sample string 2",
        "Operation": "sample string 3"
      },
      {
        "Rule": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ],
        "Key": "sample string 2",
        "Operation": "sample string 3"
      }
    ]
  },
  "Pricing": {
    "UnitPricing": {
      "AskingPrice": 1.0,
      "NetPrice": 2.0,
      "Taxes": [
        {
          "CartTaxItemId": "3e05ab85-b219-4bfb-827a-e63cac180d65",
          "Amount": 2.0
        },
        {
          "CartTaxItemId": "3e05ab85-b219-4bfb-827a-e63cac180d65",
          "Amount": 2.0
        }
      ],
      "Tax": 3.0,
      "Discounts": [
        {
          "CartDiscountItemId": "fed1c942-f533-4b94-a880-989943efa55a",
          "Amount": 2.0,
          "NetAmount": 3.0,
          "Percentage": 4.0
        },
        {
          "CartDiscountItemId": "fed1c942-f533-4b94-a880-989943efa55a",
          "Amount": 2.0,
          "NetAmount": 3.0,
          "Percentage": 4.0
        }
      ],
      "PaymentAmount": 4.0
    },
    "AskingPrice": 1.0,
    "NetPrice": 2.0,
    "Taxes": [
      {
        "CartTaxItemId": "3e05ab85-b219-4bfb-827a-e63cac180d65",
        "Amount": 2.0
      },
      {
        "CartTaxItemId": "3e05ab85-b219-4bfb-827a-e63cac180d65",
        "Amount": 2.0
      }
    ],
    "Tax": 3.0,
    "Discounts": [
      {
        "CartDiscountItemId": "fed1c942-f533-4b94-a880-989943efa55a",
        "Amount": 2.0,
        "NetAmount": 3.0,
        "Percentage": 4.0
      },
      {
        "CartDiscountItemId": "fed1c942-f533-4b94-a880-989943efa55a",
        "Amount": 2.0,
        "NetAmount": 3.0,
        "Percentage": 4.0
      }
    ],
    "PaymentAmount": 4.0
  },
  "RecipientConsumerId": 2,
  "Quantity": 3,
  "Created": "2024-11-23T01:52:59.7591032-08:00"
}

application/xml, text/xml

Sample:
<CartItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Carts">
  <Created>2024-11-23T01:52:59.7591032-08:00</Created>
  <Id>ccaeac75-6b5f-4691-93bd-42216d9b07d1</Id>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item">
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Image>http://webapihelppage4.com/</d2p1:Image>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Options>
      <d2p1:ItemOption>
        <d2p1:Items>
          <d2p1:ItemOptionItem>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 1</d7p1:Key>
                <d7p1:Value>sample string 2</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 3</d7p1:Key>
                <d7p1:Value>sample string 4</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d2p1:Properties>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ItemOptionItem>
          <d2p1:ItemOptionItem>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 1</d7p1:Key>
                <d7p1:Value>sample string 2</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 3</d7p1:Key>
                <d7p1:Value>sample string 4</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d2p1:Properties>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ItemOptionItem>
        </d2p1:Items>
        <d2p1:MetadataType>sample string 1</d2p1:MetadataType>
      </d2p1:ItemOption>
      <d2p1:ItemOption>
        <d2p1:Items>
          <d2p1:ItemOptionItem>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 1</d7p1:Key>
                <d7p1:Value>sample string 2</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 3</d7p1:Key>
                <d7p1:Value>sample string 4</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d2p1:Properties>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ItemOptionItem>
          <d2p1:ItemOptionItem>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 1</d7p1:Key>
                <d7p1:Value>sample string 2</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>sample string 3</d7p1:Key>
                <d7p1:Value>sample string 4</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d2p1:Properties>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ItemOptionItem>
        </d2p1:Items>
        <d2p1:MetadataType>sample string 1</d2p1:MetadataType>
      </d2p1:ItemOption>
    </d2p1:Options>
    <d2p1:Rules>
      <d2p1:ItemRule>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Operation>sample string 3</d2p1:Operation>
        <d2p1:Rule>sample string 1</d2p1:Rule>
        <d2p1:Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Values>
      </d2p1:ItemRule>
      <d2p1:ItemRule>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Operation>sample string 3</d2p1:Operation>
        <d2p1:Rule>sample string 1</d2p1:Rule>
        <d2p1:Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Values>
      </d2p1:ItemRule>
    </d2p1:Rules>
    <d2p1:Templates xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item.Metadata">
      <d3p1:ItemMetadataTemplate>
        <d3p1:Metadata>
          <d3p1:ItemMetadata>
            <d3p1:Key>sample string 1</d3p1:Key>
            <d3p1:Label>sample string 4</d3p1:Label>
            <d3p1:Rules>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
            </d3p1:Rules>
            <d3p1:Type>sample string 3</d3p1:Type>
            <d3p1:Value>sample string 2</d3p1:Value>
          </d3p1:ItemMetadata>
          <d3p1:ItemMetadata>
            <d3p1:Key>sample string 1</d3p1:Key>
            <d3p1:Label>sample string 4</d3p1:Label>
            <d3p1:Rules>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
            </d3p1:Rules>
            <d3p1:Type>sample string 3</d3p1:Type>
            <d3p1:Value>sample string 2</d3p1:Value>
          </d3p1:ItemMetadata>
        </d3p1:Metadata>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:TemplateType>sample string 2</d3p1:TemplateType>
      </d3p1:ItemMetadataTemplate>
      <d3p1:ItemMetadataTemplate>
        <d3p1:Metadata>
          <d3p1:ItemMetadata>
            <d3p1:Key>sample string 1</d3p1:Key>
            <d3p1:Label>sample string 4</d3p1:Label>
            <d3p1:Rules>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
            </d3p1:Rules>
            <d3p1:Type>sample string 3</d3p1:Type>
            <d3p1:Value>sample string 2</d3p1:Value>
          </d3p1:ItemMetadata>
          <d3p1:ItemMetadata>
            <d3p1:Key>sample string 1</d3p1:Key>
            <d3p1:Label>sample string 4</d3p1:Label>
            <d3p1:Rules>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
              <d3p1:ItemMetadataRule>
                <d3p1:Rule>sample string 1</d3p1:Rule>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ItemMetadataRule>
            </d3p1:Rules>
            <d3p1:Type>sample string 3</d3p1:Type>
            <d3p1:Value>sample string 2</d3p1:Value>
          </d3p1:ItemMetadata>
        </d3p1:Metadata>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:TemplateType>sample string 2</d3p1:TemplateType>
      </d3p1:ItemMetadataTemplate>
    </d2p1:Templates>
    <d2p1:Type>sample string 5</d2p1:Type>
  </Item>
  <Pricing>
    <AskingPrice>1</AskingPrice>
    <Discounts>
      <CartItemDiscount>
        <Amount>2</Amount>
        <CartDiscountItemId>fed1c942-f533-4b94-a880-989943efa55a</CartDiscountItemId>
        <NetAmount>3</NetAmount>
        <Percentage>4</Percentage>
      </CartItemDiscount>
      <CartItemDiscount>
        <Amount>2</Amount>
        <CartDiscountItemId>fed1c942-f533-4b94-a880-989943efa55a</CartDiscountItemId>
        <NetAmount>3</NetAmount>
        <Percentage>4</Percentage>
      </CartItemDiscount>
    </Discounts>
    <NetPrice>2</NetPrice>
    <PaymentAmount>4</PaymentAmount>
    <Tax>3</Tax>
    <Taxes>
      <CartItemTax>
        <Amount>2</Amount>
        <CartTaxItemId>3e05ab85-b219-4bfb-827a-e63cac180d65</CartTaxItemId>
      </CartItemTax>
      <CartItemTax>
        <Amount>2</Amount>
        <CartTaxItemId>3e05ab85-b219-4bfb-827a-e63cac180d65</CartTaxItemId>
      </CartItemTax>
    </Taxes>
    <UnitPricing>
      <AskingPrice>1</AskingPrice>
      <Discounts>
        <CartItemDiscount>
          <Amount>2</Amount>
          <CartDiscountItemId>fed1c942-f533-4b94-a880-989943efa55a</CartDiscountItemId>
          <NetAmount>3</NetAmount>
          <Percentage>4</Percentage>
        </CartItemDiscount>
        <CartItemDiscount>
          <Amount>2</Amount>
          <CartDiscountItemId>fed1c942-f533-4b94-a880-989943efa55a</CartDiscountItemId>
          <NetAmount>3</NetAmount>
          <Percentage>4</Percentage>
        </CartItemDiscount>
      </Discounts>
      <NetPrice>2</NetPrice>
      <PaymentAmount>4</PaymentAmount>
      <Tax>3</Tax>
      <Taxes>
        <CartItemTax>
          <Amount>2</Amount>
          <CartTaxItemId>3e05ab85-b219-4bfb-827a-e63cac180d65</CartTaxItemId>
        </CartItemTax>
        <CartItemTax>
          <Amount>2</Amount>
          <CartTaxItemId>3e05ab85-b219-4bfb-827a-e63cac180d65</CartTaxItemId>
        </CartItemTax>
      </Taxes>
    </UnitPricing>
  </Pricing>
  <Quantity>3</Quantity>
  <RecipientConsumerId>2</RecipientConsumerId>
</CartItem>