Page Comparison

Page Properties

label	api_docs_orders

Name	Orders Create
Description	Create an Order (or Purchase Order).
Type	POST
URL	/v9/orders
Credential Type	API\|User

...

Name	Description	Type	Required
`orders`	Array of orders to create. An array must be used even if creating just a single order.	Array	Required
`check_fraud`Indicates	whether the transaction will be run through Riskified or not. Any non-false value will set this to true, which will then defer to fraud check settings on the brokerage If you utilize our fraud prevention service (currently Riskified) and wish to skip the fraud check on this order only then pass in `false`.	Boolean	Optional

Orders Parameters

...

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_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 `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 the`order_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

...

Versions Compared

Old Version 79

New Version 80

Key

Orders Parameters