Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Creating orders via the API is by far the most daunting of API tasks because there are so many moving parts to get right.

Step-by-step guide

  1. Choose a ticket group
  2. Create a client, if you don't already have one
  3. Create the client’s properties, if they do not yet exist
  4. Choose a delivery method
  5. Choose a payment method
  6. Submit the order details

Anchor
select_ticket_group
select_ticket_group
Selecting a ticket group

All orders need at least one ticket group, usually chosen from the response of Ticket Groups / Index. Although the API allows a single order to contain more than one ticket group, it is recommended that you separate each ticket group into separate orders.

 

Anchor
create_client
create_client
Create a client

The order process requires that the client (purchaser) already exists. Usually this means that you need to use the Clients / Create endpoint. Within the response of successful client creation will be a unique id (a/k/a client_id) that must be captured and retained for use when POSTing the order. If this is a repeat customer, be sure to utilize the existing client_id instead of creating a duplicate client entry.

 

Anchor
create_client_properties
create_client_properties
Create the client’s properties

The Ticket Evolution API allows you to store various properties for clients including, Company, Email Address(es), Phone Number(s), Address(es) and even Credit Card(s). You can create each of these individually and capture the resulting item’s id for use when creating the order or you may create them at the time of the order. It is recommended that you create each item before the order and that your checkout process include the ability to add/edit/delete these various properties. Each of these properties has a label attribute that can be used to help separate a Home address from a Work address. The labels can be any string you wish—up to 20 characters.

...

If you do not utilize the Braintree Gateway you will not be able to store credit card information, nor will our API process payments for you. Instead, you will need to handle payment processing on your end before submitting the order.

 

Anchor
choose_delivery_method
choose_delivery_method
Choose a delivery method

In your Settings you must specify the delivery options that you wish to allow. It is suggested that you include as many of the non-ground FedEx as you wish as well as Eticket, Will Call and Local Pickup.

...

Luckily, we have made it easier to account for all these variables by providing the Shipments / Suggestions endpoint. Simply provide the  ticket_group_id and the shipping address_id and we will utilize our algorithm to return which of your shipping methods we suggest. Shipments / Suggestions may return a specific FedEx service_type, but as mentioned above, we recommend that you use LEAST_EXPENSIVE when creating the order, but you probably should use the price returned as the price to charge your customer.

Anchor
choose_payment_method
choose_payment_method
Choose a payment method

Most Brokers and Partners placing orders from their website will use either credit_card or offline as the payment method. 

...

Info
titleOffline payments

WARNING: When using the offline payment type you must ensure that you have received payment and completed any fraud reviews before submitting your order.

Anchor
submit_order
submit_order
Submit the order details

Once you have handled all of the above you are ready to POST your order details to the Orders / Create endpoint. The details must be JSON encoded in the POST body.

...