Versions Compared

Key

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


Page Properties
labelapi_docs_orders


NameOrders Create
DescriptionCreate an Order (or Purchase Order).
TypePOST
URL/v9/orders
Credential TypeAPI|User


...

Info

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_idID of the ticket group that was soldIntegerRequired for sales orders
pricePrice per ticket at which the ticket group was soldDecimalRequired. Optional if using ticket_hold_idMaximum 2 decimal places
quantityQuantity sold from the ticket groupIntegerRequired
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.StringRequired
low_seatLowest seat sold from the ticket groupIntegerOptional*
seat_order"consecutive" or "odd_even"StringOptional*
ticket_group_idID of the ticket group that was soldIntegerRequired for sales orders
ticket_groupFor purchase orders, creates new inventory in the system. See /wiki/spaces/API/pages/9469980 or /wiki/spaces/API/pages/6455302.HashRequired for purchase orders
ticket_hold_idThe 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.IntegerRequired 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}]


 IntegerRequired only when creating or updating a shipment for an existing order 

...

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

* 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.

...