TABLE OF CONTENTS
- Summary
- List / Search Orders
- List Orders for an Event
- Get an Order
- Update an Order
- Delete an Order
- Order Object
- Examples
Summary
APIs to view and manage orders online. Make sure you have validation in place to ensure people are only able to access orders they have permission to view.
Required Headers
- x-b2c-tenant-id: tenant ID for the owner of the event templates you are looking for.
- x-acme-api-key: If you do not yet have one, request an API key. This key must be securely passed into calls using the x-acme-api-key header.
- x-acme-browser-ip: ACME integration projects uses IP addresses to prevent unauthorized activity across endpoints. (Required for checkout, optional otherwise)
Search / List Orders
GET /v2/b2c/orders/search
List all orders matching the search criteria.
Search Parameters
One search parameter is required. This will return an empty list if no parameters are passed in.
- email: (Optional) the email address on the order.
- phoneNumber: (Optional) the phone number on the order
Additional Input
- page: (Optional) The page that you want returned, default is 1.
- pageSize: (Optional) The number of items you want returned in a page. Default is 100. Setting this to -1 will return everything.
- sortField: (Optional) The filed that you want to sort by
- sortDirection: (Optional) Can be asc or desc based on the required direction of sorting.
Returns
A list of Order JSON objects. To retrieve order items, use Get an Order
List Orders for an Event
GET /v2/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.
Get an Order
GET /v2/b2c/orders/{id}
Parameters
- id: the id of the order
Returns
An Order JSON object.
Update an Order
PUT /v2/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.
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. | |
| organizationId | The id of the reseller that sold the order. | |
| visitorId | The id of the visitor that bought the order. | Visitor is an internal only field - ACME - do not use |
| tempVisitorId | The temporary visitor id of the customer that bought the order. | Visitor is an internal only field - ACME - do not use |
| 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. Note: if you are using this barcode to create a custom email with QR codes images, please make sure to use QR code model 2. ACME generated barcodes will have a prefix of "at" added. For example: ata6f22a-e79c2b4aa6a2f3204a-0c491203 | |
| 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. |
Examples
List / Search Orders
Request
GET /v2/b2c/orders/search?email=janedoe@gmail.com&sortField=createdOn&sortDirection=desc
Response
{
"list": [
{
"id": "30263798",
"tenantId": 107,
"visitorId": "1573098",
"email": "janedoe@gmail.com",
"billingEmail": "janedoe@gmail.com",
"contactFirstName": "Jane",
"contactLastName": "Doe",
"billingFirstName": "Jane",
"billingLastName": "Doe",
"billingAddress1": "1234 Main St.",
"billingCountry": "United States",
"billingCity": "Anytown",
"billingZipCode": "95113",
"billingState": "California",
"address1": "1234 Main St.",
"country": "United States",
"city": "Anytown",
"state": "California",
"zipCode": "95113",
"phoneNumber": "1234567890",
"billingPhoneNumber": "1234567890",
"orderNumber": "100148401",
"discountedTotalAmount": "255.00",
"totalAmount": "255.00",
"discountedOriginalTotalAmount": "255.00",
"originalTotalAmount": "255.00",
"paidAmount": "255.00",
"balanceAmount": "0.00",
"refundAmount": "0.00",
"saleChannel": "Online",
"checkInStatus": "NotCheckedIn",
"creationDate": "2021-05-13T10:02:09-07:00",
"paymentDueDate": "2021-05-13T10:02:09-07:00",
"createdOn": "2021-05-13T10:02:09-07:00",
"createdBy": "2258",
"updatedOn": "2021-05-13T10:02:14-07:00",
"updatedBy": "2258",
"legacy": false,
"hideEventDate": false,
"membershipId": 4600100,
"ccLastFourDigits": "4242",
"invoiceAfter": false,
"customerId": 7275424,
"obfuscated": false
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "desc",
"sortField": "createdOn",
"count": 1,
"hasMore": false
}
}Get an Order
Request
GET /v2/b2c/orders/30263798
Response
{
"id": "30263798",
"tenantId": 107,
"visitorId": "1573098",
"email": "janedoe@gmail.com",
"billingEmail": "janedoe@gmail.com",
"contactFirstName": "Jane",
"contactLastName": "Doe",
"billingFirstName": "Jane",
"billingLastName": "Doe",
"billingAddress1": "1234 Main St.",
"billingCountry": "United States",
"billingCity": "Anytown",
"billingZipCode": "95113",
"billingState": "California",
"address1": "1234 Main St.",
"country": "United States",
"city": "Anytown",
"state": "California",
"zipCode": "95113",
"phoneNumber": "+11234567890",
"billingPhoneNumber": "+11234567890",
"orderNumber": "100148401",
"discountedTotalAmount": "255.00",
"totalAmount": "255.00",
"discountedOriginalTotalAmount": "255.00",
"originalTotalAmount": "255.00",
"paidAmount": "255.00",
"balanceAmount": "0.00",
"refundAmount": "0.00",
"saleChannel": "Online",
"checkInStatus": "NotCheckedIn",
"creationDate": "2021-05-13T10:02:09-07:00",
"paymentDueDate": "2021-05-13T10:02:09-07:00",
"orderItems": [
{
"itemId2": "615a5555659c4a28a355f702ec036108",
"itemName": "Standard",
"pricePointId": "5cde1cd11f02166eca047b8b",
"pricePointName": "Individual Member",
"itemDetailId": "4600100",
"parentItemId": "43371676",
"comboTemplateType": "fixedPrice",
"basicOriginalQuantity": 1,
"originalQuantity": 1,
"basicQuantity": 1,
"quantity": 1,
"unitPrice": "20.00",
"discountedUnitPrice": "20.00",
"discountedOriginalAmount": "20.00",
"originalAmount": "20.00",
"discountedAmount": "20.00",
"amount": "20.00",
"balanceAmount": "0.00",
"itemType": "MembershipPurchase",
"itemTypeNg": "Event",
"conversionStatus": "NoConversion",
"itemId": "43371676"
},
{
"parentItemId": "43371677",
"comboTemplateType": "fixedPrice",
"eventId": "5ff74342210cbe0c44913be2",
"ticketingTypeId": "54248ac8e4b01cd228b007a4",
"eventName": "Sailing",
"eventStartTime": 1621036800000,
"ticketingTypeName": "Adulting",
"basicOriginalQuantity": 2,
"originalQuantity": 2,
"basicQuantity": 2,
"quantity": 2,
"unitPrice": "100.00",
"discountedUnitPrice": "100.00",
"discountedOriginalAmount": "200.00",
"originalAmount": "200.00",
"discountedAmount": "200.00",
"amount": "200.00",
"balanceAmount": "0.00",
"itemType": "Event",
"itemTypeNg": "Event",
"conversionStatus": "NoConversion",
"itemId": "43371677",
"displayName": "Adulting"
},
{
"parentItemId": "43371678",
"comboTemplateType": "fixedPrice",
"eventId": "5ff74342210cbe0c44913be2",
"eventName": "Sailing",
"eventStartTime": 1621036800000,
"basicOriginalQuantity": 2,
"originalQuantity": 2,
"basicQuantity": 2,
"quantity": 2,
"unitPrice": "1.00",
"discountedUnitPrice": "1.00",
"discountedOriginalAmount": "2.00",
"originalAmount": "2.00",
"discountedAmount": "2.00",
"amount": "2.00",
"balanceAmount": "0.00",
"itemType": "Inventory",
"itemTypeNg": "Event",
"inventoryId": 1800,
"inventoryName": "Event Add-On",
"conversionStatus": "NoConversion",
"itemId": "43371678",
"displayName": "Event Add-On"
},
{
"parentItemId": "43371679",
"comboTemplateType": "fixedPrice",
"eventId": "5ff75b38e8827e149af3ba34",
"ticketingTypeId": "54248ac8e4b01cd228b007a4",
"eventName": "Hiking",
"eventStartTime": 1621029600000,
"ticketingTypeName": "Adulting",
"basicOriginalQuantity": 2,
"originalQuantity": 2,
"basicQuantity": 2,
"quantity": 2,
"unitPrice": "10.00",
"discountedUnitPrice": "10.00",
"discountedOriginalAmount": "20.00",
"originalAmount": "20.00",
"discountedAmount": "20.00",
"amount": "20.00",
"balanceAmount": "0.00",
"itemType": "Event",
"itemTypeNg": "Event",
"conversionStatus": "NoConversion",
"ruleSetId": "5b29c42a79e71d616f47693c",
"itemId": "43371679",
"displayName": "Adulting"
},
{
"itemDetailId": "1398791",
"parentItemId": "43371680",
"comboTemplateType": "fixedPrice",
"basicOriginalQuantity": 1,
"originalQuantity": 1,
"basicQuantity": 1,
"quantity": 1,
"unitPrice": "13.00",
"discountedUnitPrice": "13.00",
"discountedOriginalAmount": "13.00",
"originalAmount": "13.00",
"discountedAmount": "13.00",
"amount": "13.00",
"balanceAmount": "0.00",
"itemType": "Inventory",
"itemTypeNg": "Donation",
"inventoryId": 2728,
"inventoryName": "Variable",
"conversionStatus": "NoConversion",
"itemId": "43371680",
"displayName": "Variable"
}
],
"createdOn": "2021-05-13T10:02:09-07:00",
"createdBy": "null",
"updatedOn": "2021-05-13T10:02:14-07:00",
"updatedBy": "null",
"legacy": false,
"hideEventDate": false,
"membershipId": 4600100,
"ccLastFourDigits": "4242",
"invoiceAfter": false,
"customerId": 7275424,
"obfuscated": false
}