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 |
|---|---|---|
| id | The unique ID of the order object. | read only |
| tenantId | The id of the tenant the order was created for. | |
| accountId | The id of the reseller that sold the order. | |
| visitorId | The id of the visitor (customer) that bought the order. | |
| tempVisitorId | The temporary visitor id of the customer that bought the order. | |
| The email address of the customer. | ||
| contactFirstName | The first name of the customer. | |
| contactLastName | the last name of the customer. | |
| zipCode | The zip code of the customer. | |
| phoneNumber | The phone number of the customer. | |
| orderNumber | The order number of the order. | |
| discountedOriginalTotalAmount | ||
| originalTotalAmount | ||
| discountedTotalAmount | The total discounted amount for this order. | |
| totalAmount | ||
| paidAmount | ||
| balanceAmount | ||
| refundAmount | ||
| saleChannel | The sale cannel used to place the order (online, pointOfSale, reseller, customerRep, manualEntry, insideSalesIndividual). | |
| checkInStatus | The check in status of the order (NotCheckedIn, CheckedIn, PartiallyCheckedIn) | |
| orderExceptionCodeId | ||
| orderExceptionCodeName | ||
| notes | Notes about the order | |
| posUUID | ||
| createdOn | The date the order was created. | |
| createdBy | The id of the user that created the order. | |
| updatedOn | The date that the order was last modified. | |
| updatedBy | The id of the user who last modified the order. | |
| paymentDueDate | ||
| ticketDelivery | How the tickets will be delivered (print, willCall) | |
| ticketExpireDays | The number of days that the ticket is valid for. | |
| hideEventDate | Whether you want to hide dates on the tickets, default is false. | |
| legacy | Set to true for imported legacy orders from other systems, otherwise false. | |
| membershipId | The membershipId used during order checkout. | |
| couponId | The couponId used during checkout. | |
| ccLastFourDigits | The last four digits of the card used during checkout. | |
| paymentId | ||
| accountContactId | If the order was placed by a reseller/account, the contact id of the account user. | |
| orderItems | List of items in the order, these are the components that make up the order. Like tickets. | |
| orderItems[x].itemId | Unique id of the order item. | read only |
| orderItems[x].parentItemId | ||
| orderItems[x].comboTemplateId | ID of the combo that this item is part of. | |
| orderItems[x].comboTemplateName | Name of the combo that this item is part of. | |
| orderItems[x].comboTemplateType | Type of combo that this item is part of (fixedPrice, discountCode). | |
| orderItems[x].eventId | The id of the event that this order item is for. | |
| orderItems[x].eventName | The name of the event. | |
| orderItems[x].eventStartTime | The time that the event starts. | |
| orderItems[x].ticketingTypeId | The id of the ticket type. | |
| orderItems[x].ticketingTypeName | The name of the ticket type like 'Child', 'Adult'... | |
| orderItems[x].basicOriginalQuantity | ||
| orderItems[x].originalQuantity | The original number of items. | |
| orderItems[x].basicQuantity | ||
| orderItems[x].quantity | The current number of items. | |
| orderItems[x].discountId | The id of the discount for this order item. | |
| orderItems[x].accountCategoryId | ||
| orderItems[x].checkedInQuantity | The number of items that have checked in. If there were five items total then any number 0 - 5 can be checked in. | |
| orderItems[x].unitPrice | The price for each item. | |
| orderItems[x].discountedUnitPrice | The discounted unit price. | |
| orderItems[x].discountedOriginalAmount | ||
| orderItems[x].originalAmount | ||
| orderItems[x].discountedAmount | The amount of the discounted price of the items for the purchased quantity. | |
| orderItems[x].amount | The total amount (quantity X unit price) | |
| orderItems[x].balanceAmount | ||
| orderItems[x].checkInDate | The date that the visitors checked in. | |
| orderItems[x].itemType | The type of order item this is (event, inventory, comboEvent, comboInventory). | |
| orderItems[x].inventoryId | The id of the inventory item, if this order item is an inventory item. | |
| orderItems[x].inventoryName | The name of the inventory item (like 'Audio Guide') | |
| orderItems[x].ticketVos | A list of the tickets for this order item. | |
| orderItems[x].ticketVos[y].id | Id of the ticket. | |
| orderItems[x].ticketVos[y].tenantId | Id of the tenant. | |
| orderItems[x].ticketVos[y].uuid | A unique id for this ticket. This is the uuid used in the QR code for this unit. | |
| orderItems[x].ticketVos[y].checkInDate | The check in time for the ticket. | |
| orderItems[x].ticketVos[y].firstName | First name of the customer. | |
| orderItems[x].ticketVos[y].lastName | Last name of the customer. | |
| orderItems[x].ticketVos[y].email | email address of the customer. | |
| orderItems[x].ticketVos[y].phoneNumber | Phone number of the customer. | |
| orderItems[x].ticketVos[y].ticketStatus | The ticket status one of (Normal, Rebook, Refund or Void). | |
| orderItems[x].ticketVos[y].printed | true if the ticket has been printed already. | |
| orderItems[x].ticketVos[y].notes | Notes associated with the ticket. |