Versions Compared

Key

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


Page Properties
labelapi_docs_orders
Info

If you are an affiliate please see the Affiliate Documentation instead.

Name

Orders Create

Description

Create an Order (or Purchase Order).

Type

POST

URL

/v9/orders

Credential Type

API|User

...

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.

...

Note

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, 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

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}]

 Integer

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

low_seat

Lowest seat sold from the ticket group

Integer

Optional*

quantity

Quantity sold from the ticket group

Integer

Required


seat_order

consecutive or odd_even

String

Optional

Required when creating a purchase order in Core

ticket_group

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

ticket_group_id

ID of the ticket group being sold

Integer

Required

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


...

Internal Use Only Parameters

Include Page
Internal Use Only Orders / Create Parameters
Internal Use Only Parameters Orders / Create Internal Use Only Parameters
isMissingRequiredParameterstrue

...