Checkout
POST /v2/b2b/checkout/kiosk
Headers:
Content-Type: application/json
x-acme-session: valid acme session
x-acme-request-uuid: a unique identifier to help prevent duplicate transactions (optional)
Body:
A Checkout Input JSON Object with shopping cart
Response:
A WillCall Order Detail object describing the order, order items, and tickets arranged by event
Checkout JSON Objects
Checkout Input JSON Object
Field | Description | Notes |
|---|---|---|
| Email address of the customer. | optional | |
| phoneNumber | Phone number of the customer. | optional |
| contactFirstName | First name of the customer. | optional |
| contactLastName | Last name of the customer. | optional |
| zipCode | Zip code of the customer. | optional |
| acmeToken | First 6 digits and last 4 digits of the credit card. | required for cc |
| paymentProcessorToken | Token received from the payment processor. | not used |
| paymentProcessorFingerPrint | Finger Print received from the payment processor. | not used |
| ccLastFourDigits | Last four digits of the credit card | required for cc |
| creditCardBrand | Type of credit card. One of Visa, MasterCard, AmericanExpress, Discover or Jcb | not used |
| giftCardNumber | The gift card number used to make the order | not used |
| notes | Notes about the order | optional |
| shoppingCart | The shopping cart object with the items to be purchased. | required |
| shoppingCart.id | If it's an existing shopping cart then the id of the cart. | not used |
| shoppingCart.tempVisitorId | Temporary Id of the visitor that is not signed into Acme as a customer | not used |
| shoppingCart.visitorId | Id of the visitor if it is a customer signed into Acme as a customer | not used |
| shoppingCart.items | A list of items in the shopping cart | required |
| shoppingCart.items[x].itemId | A unique id for this item. | Read Only |
| shoppingCart.items[x].eventId | Event id of the item. | required |
| shoppingCart.items[x].ticketingTypeId | Type of ticket. | required |
| shoppingCart.items[x].eventName | The name of the event. | optional |
| shoppingCart.items[x].quantity | The number of these items in the shopping cart. | Required |
| shoppingCart.items[x].unitPrice | The price for each item in the shopping cart. | Read Only |
| shoppingCart.items[x].amount | The total amount (quantity X unit price) | Read Only |
| shoppingCart.items[x].itemType | The type of item, one of Event, Inventory, ComboEvent, ComboInventory | required |
| shoppingCart.items[x].inventoryId | If this item is not an event then this is the inventory id of the item. | required for inventory |
| shoppingCart.items[x].inventoryName | Name of the item, if it's not an event. | optional |
| shoppingCart.comboItems | A list of combo items in the cart. | not used |
| shoppingCart.comboItems[x].itemId | The inventory item id, if this is an inventory item. | not used |
| shoppingCart.comboItems[x].comboTemplateId | The combo template id associated with this combo item. | not used |
| shoppingCart.comboItems[x].comboTemplateName | the name of the combo template. | not used |
| shoppingCart.comboItems[x].comboTemplateType | Either fixedPrice or Discount depending on the type combo template. | not used |
| shoppingCart.comboItems[x].tickets | The list of tickets for this combo item. | not used |
| shoppingCart.comboItems[x].tickets[y].eventTemplateId | The event template associated with this ticket. | not used |
| shoppingCart.comboItems[x].tickets[y].ticketTypeId | The id for the type of ticket. | not used |
| shoppingCart.comboItems[x].tickets[y].name | The name on the ticket. | not used |
| shoppingCart.comboItems[x].tickets[y].description | A description of what the ticket is for. | not used |
| shoppingCart.comboItems[x].tickets[y].price | The retail price of the ticket. | not used |
| shoppingCart.comboItems[x].tickets[y].discountedPrice | The price after discounts for resellers are applied to the retail price. | not used |
| shoppingCart.comboItems[x].tickets[y].quantity | The number of tickets. | not used |
| shoppingCart.comboItems[x].tickets[y].subTotal | The subtotal of the retail price of the tickets for the purchased quantity | not used |
| shoppingCart.comboItems[x].tickets[y].discountedSubTotal | The subtotal of the discounted price of the tickets for the purchased quantity | not used |
| shoppingCart.comboItems[x].events | A list of events in the shopping cart. | not used |
| shoppingCart.comboItems[x].events[y].eventTemplateId | The id of the event template for this event. | not used |
| shoppingCart.comboItems[x].events[y].eventId | The id of the event. | not used |
| shoppingCart.comboItems[x].events[y].eventName | The name of the event. | not used |
| shoppingCart.comboItems[x].events[y].eventStartTime | The start time of the event. | not used |
| shoppingCart.comboItems[x].addOns | The list of add ons in this combo item. | not used |
| shoppingCart.comboItems[x].addOns[y].addOnId | The id of the add-on . | not used |
| shoppingCart.comboItems[x].addOns[y].name | The name of the add on. | not used |
| shoppingCart.comboItems[x].addOns[y].quantity | The number of items of this add on in the shopping cart. | not used |
| shoppingCart.comboItems[x].addOns[y].unitPrice | The price of these items. | not used |
| shoppingCart.comboItems[x].addOns[y].priceSplit | Either 'each' or 'total'. If each then the price will be quantity * unitPrice, if total the price will be unitPrice. | not used |
| encTrack1 | MTSCRA getTrack1 | required for cc |
| encTrack2 | MTSCRA getTrack2 | required for cc |
| encmp | MTSCRA getMagnePrint | required for cc |
| ksn | MTSCRA getKSN | required for cc |
| devSN | MTSCRA getDeviceSerial | required for cc |
| mpStatus | MTSCRA getMagnePrintStatus | required for cc |
| magtekCardType | 1 | required for cc |
| encryptionBlockType | 1 | required for cc |
| expDate | expiration date in a mmyy format (no separators) | required for cc |
| chargeAmount | the charge amount | required |
| uuid | a unique identifier to help prevent duplicate transactions (does not have to be a uuid per se) | required |
| accountId | an account id if it's an account/voucher purchase | required for account purchase |
| paymentId | the voucher or check number in a voucher or check transaction | required for voucher or check |
| orderExceptionCode | not used | |
| terminalId | a valid kiosk terminal id | required |
| paymentMethod | a list of payment types. In practice, there will only be one for now. The options are "Cash", "Credit Card", "Voucher", or "Check" |