Order Types
Ticket Evolution has 3 types of orders and they are described below.
Most people utilizing this documentation need to create Buy/Sell orders. If you are unsure please ask.
Buy/Sell Order
This is where you create an order in which your Office is selling tickets to one of your Clients. Additionally, if the tickets are owned by another Office the system will create the corresponding purchase order to purchase the tickets from the Office that owns them. This is the type of order most Partners and websites should be creating.
Buy Order
This is a purchase order where your Office is purchasing tickets from another Office and there is no corresponding sale to a Client or anyone else. You might create a Buy Order if you are simply looking to purchase tickets to add to your own inventory.
Sell Order
This is a sale of your own inventory to one of your own Clients. This is typically only done via Core POS. If you are building a website you do not need to worry about checking whether your office owns the inventory or not and choosing between a Buy/Sell order or a Sell order, just use a Buy/Sell order and the system will be smart enough to know that no corresponding purchase order is necessary.
Parameters
Name | Description | Type | Required |
|---|---|---|---|
orders | Array of orders to create. An array must be used even if creating just a single order. | Array | Required |
Orders Parameters
Name | Description | Type | Presence | Other | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
is_purchase | Indicates whether you are creating a Purchase Order or an Invoice. Unless you have been specifically instructed to use this, you should omit this parameter. | Boolean | Optional | Default: false | ||||||||||||||||
shipped_items | Array of Shipments (which contain items) | Array | Required | |||||||||||||||||
payments | Array of Payments which will be applied to the order. An array must be used even if creating just a single payment. Note: Payments of type 'credit_card' will fail, even in Sandbox, if you have not yet signed up for the Braintree gateway. Note: The payment amount does not dictate the total amount of an order. If the payment type is The total amount will be calculated as (( | Array | Optional | |||||||||||||||||
|
| Integer | See table | |||||||||||||||||
created_by_ip_address | IP address of the buyer | String | Optional | |||||||||||||||||
consignment | Set as consignment order | Boolean | Optional | |||||||||||||||||
shipping | Additional amount added to the order to be labeled as Shipping Cost | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||
service_fee | Additional amount added to the order to be labeled as a Service Fee | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||
additional_expense | Additional amount added to the order to be labeled as Additional Expense | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||
tax | Additional amount added to the order to be labeled as Tax | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||
discount | Additional amount subtracted from the order to be labeled as Discount. (Positive value, but will have a negative effect on the order total) | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||
promo_code | The name of a promo code applied to an order. Does not automatically apply the discount, this is simply for your own logging purposes. | String | Optional | |||||||||||||||||
internal_notes | Internal Notes will only be visible to the Office that created them. Using an Array of strings will create multiple Internal Notes. | String|Array | Optional | |||||||||||||||||
external_notes | External Notes are visible to both the buyer and the seller and are considered a request. If you have specific requirements please reach out to the seller to ensure your requirements can be met. Using an Array of strings will create multiple External Notes. | String|Array | Optional | |||||||||||||||||
instructions | Instructions are visible to both the buyer and the seller and are considered a request. If you have specific requirements please reach out to the seller to ensure your requirements can be met. | String | Optional | |||||||||||||||||
seller_reference_number | Reference will only be visible to the Office that created them and is recommended for storing something such as a PO or Invoice number from another system. You can find this in through CORE Reference filters on your Orders Search Page in CORE. | String | Optional |
Shipped Items Parameters
shipped_items is an array of shipment objects that include the items to be delivered via that shipment. (Despite being named "shipment" this can refer to uploading etickets or other fulfillment methods as well.)
For the parameters for a shipment object please see Shipments / Create.
Even though Shipped Items is an array you can only have one item per order. If your site has a cart functionality allowing the purchase of multiple items, simply split them into multiple orders.
The exception to this is that you may order multiple items only if all items are owned by the same Office as the one creating the order (the seller_id).
Items Parameters
Name | Description | Type | Presence | Other |
|---|---|---|---|---|
ticket_group_id | ID of the ticket group that was sold | Integer | Required for sales orders | |
price | Price per ticket at which the ticket group was sold | Decimal | Required. Optional if using ticket_hold_id | Maximum 2 decimal places |
quantity | Quantity sold from the ticket group | Integer | Required | |
ticket_group_signature | The ticket_group_signature attribute from the ticket group. If enabled for your account, including the ticket_group_signature will prevent an order from being created if the quantity is no longer valid or if the cost has increased. This can be used to help prevent creating orders that have a high likelyhood of being rejected. | String | Required | |
low_seat | Lowest seat sold from the ticket group | Integer | Optional* | |
seat_order | "consecutive" or "odd_even" | String | Optional* | |
ticket_group_id | ID of the ticket group that was sold | Integer | Required for sales orders | |
ticket_group | For purchase orders, creates new inventory in the system. See /wiki/spaces/API/pages/9469980 or /wiki/spaces/API/pages/6455302. | Hash | Required for purchase orders | |
ticket_hold_id | The ID returned from a /wiki/spaces/API/pages/9469967 or /wiki/spaces/API/pages/9469976 call. If supplied, quantity, price and low_seat from the Hold/Take will be used. You may override the Hold/Take price by supplying a price value. | Integer | Required only if the tickets are Held or Taken | |
id | The When creating/replacing a shipment for an existing order each array element should be an object with a single property, | Integer | Required only when creating or updating a shipment for an existing order |
* These items are required when creating a purchase order such as through Core.
Payments Parameters
See Payments / Create
If you are using the Sandbox and testing the Braintree credit card integration you might want to look at their documentation for testing credit cards.
Substitutions
* If an order is rejected by a TEvo Seller, there is a configuration on the API buyer's account for Buy / Sell orders to auto-cancel the customers order or not. If not, the API will allow for a substitute ticket to be created as a new purchase order, associated to the original via the same Orders / Create endpoint.
* The two order links, original and new, will share an order group id.
* Here is a link to a page the shows the calls that could be made to create a substitution purchase order: HOW TO: Process a Substitution via the API
Examples
All order types use the same endpoint, and the response to a successful request will be the order that was created.
| Request | Response |
|---|---|
POST /v9/orders | See Orders / Index |