...
...
Page Properties | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Info |
---|
Please review our information on placing Test Orders in our Sandbox environment. 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. |
Order Types
Ticket Evolution has 3 types of orders and they are described below.
Info |
---|
Mostpeopleusers 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.
...
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 | Presence |
---|
Other | ||||
---|---|---|---|---|
| Array of orders to create. An array must be used even if creating just a single order. If you wish to create multiple orders at once it is recommended to you submit multiple POSTs instead of a larger | Array | Required | |
|
If you utilize our fraud prevention service (currently Riskified) and wish to skip the fraud check on this order only then pass in | Boolean | Optional |
Orders Object Parameters
Name | Description | Type | Presence | Other |
---|
is_purchase
| The ID of a Client Address which should be recorded as their billing address for this order. | Integer | Optional | |
| If you are creating a Buy (Purchase |
shipped_items
) Order the | Integer | Required for Buy Order (Purchase Order) | ||
| ID of the Client that is buying the tickets from your Office in a Buy/Sell order. | Integer | Required for Buy/Sell orders | |
| IP address of the buyer. | String | Required if using Fraud Protection | |
| 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 |
| 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 | |
| Array of Payments which will be applied to the order. An array must be used even if creating |
a single payment. |
|
|
| Array |
created_by_ip_address
consignment
shipping
Required |
seller_id
buyer_id
client_id
| 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 | |
| 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 search this in CORE Reference filters on your Orders Search Page. | String | Optional | |
| If you are creating a Buy/Sell Order or a Sell Order the If you are creating a Buy Order (Purchase Order) or a the | Integer | ||
| Additional amount added to the order to be labeled as |
a Service Fee | Decimal | Optional | Maximum 2 decimal places |
|
additional_expense
| Session ID of the buyer. This should be a unique session of the buyer. | String | Required if using Fraud Protection. | |
| Array of Shipped Items | Array | Required | |
| Additional amount added to the order to be labeled as |
Shipping Cost. Shipments / Suggestion will return the pricing you have configured for a shipment method. | Decimal | Optional | Maximum 2 decimal places |
| Additional amount added to the order to be labeled as |
discount
Tax. If you are using Tax Quotes / Create to calculate the retail tax amount you can pass the retail tax amount here for record keeping. | Decimal | Optional | Maximum 2 decimal places |
|
internal_notes
external_notes
instructions
seller_reference_number
| Unique identifier generated by Tax Quotes / Create to ensure consistency between your quote and your order. | UUID | 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.
Infonote |
---|
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 |
Items
...
Parameters
Name | Description | Type | Presence | Other |
---|
|
price
ticket_hold_id
quantity
ticket_group_signature
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.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 | ||
| Lowest seat sold from the ticket group | Integer | Optional* | |
| Quantity sold from the ticket group | Integer | Required | |
|
|
or |
|
String | Optional |
ticket_group_id
Required when creating a purchase order in Core | ||||
| For purchase orders, creates new inventory in the system. See /wiki/spaces/API/pages/9469980 or /wiki/spaces/API/pages/6455302. | Hash | Optional | Required for purchase orders in Core |
| ID of the ticket group being sold | Integer | Required | |
| The ID returned from a /wiki/spaces/API/pages/9469967 or /wiki/spaces/API/pages/9469976 call. If supplied, | Integer | Required only if the tickets are Held or Taken |
id
The id
of an item from an existing order.
When creating/replacing a shipment for an existing order each array element should be an object with a single property, id
, with that value being the same as theorder_item_id
from the corresponding object within the items
array of the order containing the ticket groups to be included in this shipment. e.g.: "items": [{"id": 26117}]
* These items are required when creating a purchase order such as through Core.
Payments Parameters
See Payments / Create
Info |
---|
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
...
Payments Parameters
Internal Use Only Parameters
Include Page | ||||||
---|---|---|---|---|---|---|
|
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 |
---|---|
| See Orders / Index |
Child pages (Children Display) | |||
---|---|---|---|
|
...
|
...
|