Introduction

The ACME Shopping Cart is a collection of structured items that can be purchased, including Event Tickets, Add-ons, Memberships, and Donations.


The power of the ACME Shopping cart is that all items can be purchased in a unified cart. For example, if a guest purchases a Membership along with Event Tickets, the combination in a single shopping cart allows you to provide immediate membership benefits, such as discounts on the tickets.


All checkout calls require a Shopping Cart to complete. There are two options:

  1. Include the Shopping Cart Object with all of the items being purchased directly in the checkout call
  2. Create the Shopping Cart prior to checkout with the items being purchased, then include just the Shopping Cart ID in the checkout call. 


For more information see the Shopping Cart and Checkout documentation:

Shopping Cart Object


id  (Required)

If it's an existing shopping cart then the id of the cart.

Example:
2c4c51184a61494cbdd148a278844175
membershipCategoryId
The ID of the level. If you don't have the membership id but know the membership level then you can pass this in to give them membership discounts and access. If you pass in a membership id then this will not be used.		Example:
5db23799142c4af6d682187a
items [ ] (Required)

A list of items in the shopping cart.  See Shopping Cart Item Object for details.

comboItems [ ]
A list of combo items in the cart. This is for a combo event not combo ticket category. See Combo Item Object for details.
couponCodes[ ]
A list of coupon codes (strings) being applied to this cart.		Example:
["AAA5"]
customerId
The id of an existing customer. This is ignored when creating a cart outside of checkout. A new customer can be created during B2C Checkout		Example:
A012345678
membershipIds[ ]
A list of membership IDs that are being used on the order    		Example:

[5970603]

saleChannel: (Required for checkout)
The sales channel that this order was completed on.		Example:
  • online
  • pointOfSale
  • reseller
  • insideSalesIndividual
  • kiosk


Note: The Shopping Cart response includes tempVisitorId. This is for ACME Internal Use only. Use customerId instead.


Shopping Cart Item Object


itemId

A unique ID for this item

Example:
503a7ccbd8aa4b97ac88a37338207dc4
eventId (Required for Events)
ID of the Event Instance		Example:
f78b4a328bad11eda1eb0242
ticketingTypeId (Required for Events)

ID of the ticket type

Example:
55e0d26e8bae11eda1eb0242
eventName
The name of the event		Example:
Behind-the-Scenes Tour
ticketingTypeName
The name of the ticket type		Example:
Adult
quantity (Required)
The number of these items in the shopping cart		Example:
2
unitPrice
The price for each item in the shopping cart. If a discount is applied, this will reflect the discounted price.		Example:
24.00
retailUnitPrice
The retail price (aka full price) for each item in the shopping cart.		Example:
32.00
isRetail
Boolean value. 
  • If true, system will charge full price. 
  • If false, the system will apply a discount. 
If a membership is in the cart, the system will default to true.		Example:
  • true
  • false
amount
The total amount (quantity x unitPrice) of the items in the cart. In the case of a donation, this is used only for variable donation prices.		Example:
48.00
itemType: (Required if not an Event)
The type of item. Can be one of Event, Inventory, ComboEvent, ComboInventory. The default is Event.		Example:
  • Event
  • Inventory
  • ComboEvent
  • ComboInventory
inventoryId (Required for Add On or Donation)
If this item is not an event then this is the inventory id of the item.		Example:
4575
inventoryName
Name of the item, if it's not an event.		Example:
$10 Donation
membershipInfo
Information about the membership being purchased. 		Example:
See Membership Info Object (coming soon)
ignoreEntitlements
If a membership is being used to make this purchase then setting this flag will ignore restrictions on the membership. For example, if Gold members can only buy two tickets, setting this to true will ignore the restriction and enable the member to buy more.		Example:
  • true
  • false
discountId
If a discount is applicable (i.e. if you are using a coupon code), the discount id may be returned.		Example:
97ebd8c3ddf94120a62e6781
donationDetail
The details about the donation if this item is a donation. See Donation Details Object