Get an Order

Get /v1/b2c/orders/{id}

Parameters

  • id: the id of the order

Returns

An Order JSON object.


List orders

Get /v1/b2c/orders

Parameters

  • visitorId:  (Optional) the id of the visitor you want the list of orders for.
  • tempVisitorId: (Optional) the temp visitor id of the visitor you want the orders for.
  • email:  (Optional) the email address of the visitor you want the orders for.
  • phoneNumber: (Optional) the phone number of the visitor you want the orders for. 

Returns

A list of Order JSON objects for the corresponding visitor.


List orders of an Event

Get /v1/b2c/orders/event/{eventId}

Parameters

  • eventId:  The id of the event you want the list of orders for.

Returns

A list of Order Objects associated with the specified event.


Create an order

Post /v1/b2c/orders

Body

An Order Object with the order information.

Returns
        The ID of the newly created order.


Update an order

Put /v1/b2c/orders/{id}

Parameters

  • id:  the id of the order you are modifying.

Body

An Order Object with the new order information

Returns

The resulting Order Object after the update is complete.


Delete an order

Delete /v1/b2c/orders/{id}

Parameters

  • id:  the id of the order you are deleting.

Returns


the Order Object that was deleted.


Order Object

Field
Description
Notes
idThe unique ID of the order object.read only
tenantIdThe id of the tenant the order was created for. 
accountIdThe id of the reseller that sold the order. 
visitorIdThe id of the visitor (customer) that bought the order. 
tempVisitorIdThe temporary visitor id of the customer that bought the order. 
emailThe email address of the customer. 
contactFirstNameThe first name of the customer. 
contactLastNamethe last name of the customer. 
zipCodeThe zip code of the customer. 
phoneNumberThe phone number of the customer. 
orderNumberThe order number of the order. 
discountedOriginalTotalAmount  
originalTotalAmount  
discountedTotalAmountThe total discounted amount for this order. 
totalAmount  
paidAmount  
balanceAmount  
refundAmount  
saleChannelThe sale cannel used to place the order (online, pointOfSale, reseller, customerRep, manualEntry, insideSalesIndividual). 
checkInStatusThe check in status of the order (NotCheckedIn, CheckedIn, PartiallyCheckedIn) 
orderExceptionCodeId  
orderExceptionCodeName  
notesNotes about the order 
posUUID  
createdOnThe date the order was created. 
createdByThe id of the user that created the order. 
updatedOnThe date that the order was last modified. 
updatedByThe id of the user who last modified the order. 
paymentDueDate  
ticketDeliveryHow the tickets will be delivered (print, willCall) 
ticketExpireDaysThe number of days that the ticket is valid for. 
hideEventDateWhether you want to hide dates on the tickets, default is false. 
legacySet to true for imported legacy orders from other systems, otherwise false. 
membershipIdThe membershipId used during order checkout. 
couponIdThe couponId used during checkout. 
ccLastFourDigitsThe last four digits of the card used during checkout. 
paymentId  
accountContactIdIf the order was placed by a reseller/account, the contact id of the account user. 
orderItemsList of items in the order, these are the components that make up the order.  Like tickets. 
orderItems[x].itemIdUnique id of the order item.read only
orderItems[x].parentItemId  
orderItems[x].comboTemplateIdID of the combo that this item is part of. 
orderItems[x].comboTemplateNameName of the combo that this item is part of. 
orderItems[x].comboTemplateTypeType of combo that this item is part of (fixedPrice, discountCode). 
orderItems[x].eventIdThe id of the event that this order item is for. 
orderItems[x].eventNameThe name of the event. 
orderItems[x].eventStartTimeThe time that the event starts. 
orderItems[x].ticketingTypeIdThe id of the ticket type. 
orderItems[x].ticketingTypeNameThe name of the ticket type like 'Child', 'Adult'... 
orderItems[x].basicOriginalQuantity  
orderItems[x].originalQuantityThe original number of items. 
orderItems[x].basicQuantity  
orderItems[x].quantityThe current number of items. 
orderItems[x].discountIdThe id of the discount for this order item. 
orderItems[x].accountCategoryId  
orderItems[x].checkedInQuantityThe number of items that have checked in.  If there were five items total then any number 0 - 5 can be checked in. 
orderItems[x].unitPriceThe price for each item. 
orderItems[x].discountedUnitPriceThe discounted unit price. 
orderItems[x].discountedOriginalAmount  
orderItems[x].originalAmount  
orderItems[x].discountedAmountThe amount of the discounted price of the items for the purchased quantity. 
orderItems[x].amountThe total amount (quantity X unit price) 
orderItems[x].balanceAmount  
orderItems[x].checkInDateThe date that the visitors checked in. 
orderItems[x].itemTypeThe type of order item this is (event, inventory, comboEvent, comboInventory). 
orderItems[x].inventoryIdThe id of the inventory item, if this order item is an inventory item. 
orderItems[x].inventoryNameThe name of the inventory item (like 'Audio Guide') 
orderItems[x].ticketVosA list of the tickets for this order item. 
orderItems[x].ticketVos[y].idId of the ticket. 
orderItems[x].ticketVos[y].tenantIdId of the tenant. 
orderItems[x].ticketVos[y].uuidA unique id for this ticket. 
orderItems[x].ticketVos[y].checkInDateThe check in time for the ticket. 
orderItems[x].ticketVos[y].firstNameFirst name of the customer. 
orderItems[x].ticketVos[y].lastNameLast name of the customer. 
orderItems[x].ticketVos[y].emailemail address of the customer. 
orderItems[x].ticketVos[y].phoneNumberPhone number of the customer. 
orderItems[x].ticketVos[y].ticketStatusThe ticket status one of (Normal, Rebook, Refund or Void). 
orderItems[x].ticketVos[y].printedtrue if the ticket has been printed already. 
orderItems[x].ticketVos[y].notesNotes associated with the ticket.