Orders / Create

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

Long Description

This will create an order in the Ticket Evolution system.

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.

Parameters

Name	Description	Value Type	Required
orders	Array of orders to create	Array	Required

Orders Parameters

Name	Description	Type	Presence	Other
`is_purchase`	Indicates whether you are creating a Purchase Order or an Invoice	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. 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 `credit_card` the payment amount will dictate how much the Client will be charged regardless of the order amount. The total amount will be calculated as ((`price` * `quantity`) of each item) + `shipping` + `service_fee` + `additional_expense` + `tax` - `discount`	Array	Optional
`seller_id`	ID of the office for which the order is being created (i.e.: your office)	Integer	Required
`buyer_id`	ID of an office which is the buyer for this order	Integer	Required unless client_id exists
`client_id`	ID of a client which is the buyer for this order	Integer	Required unless buyer_id exists
`created_by_ip_address`	IP address of the buyer	String	Required for brokerages who have enabled Minfraud
`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
`reference`	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.	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	Optional
`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

* These items are required when creating a purchase order such as through Core.

Payments Parameters

See Payments / Create

Examples

Request

Response

/v9/orders

Creating an order with one item that will ship via FedEx.

{
  "orders": [
    {
      "shipped_items": [
        {
          "items": [
            {
              "ticket_group_id": 52554285,
              "price": 50.00,
              "quantity": 2,
              "ticket_group_signature": "a35e9ba5ffee9aabd0546f676cdda3c8"
            }
          ],
          "phone_number_id": 33333,
          "service_type": "LEAST_EXPENSIVE",
          "type": "FedEx",
          "address_id": 111111,
          "ship_to_name": "Moe Szyslak"
        }
      ],
      "billing_address_id": 111111,
      "payments": [
        {
          "amount": 114.00,
          "type": "credit_card",
          "credit_card_id": 2222
        }
      ],
      "seller_id": "1691",
      "client_id": 107655,
      "created_by_ip_address": "12.34.56.78",
      "instructions": "These instructions will be visible to everyone",
      "shipping": 15.00,
      "service_fee": 9.00,
      "additional_expense": 0.00,
      "tax": 0.00,
      "discount": 10.00,
      "promo_code": "10DOLLARSOFF"
    }
  ]
}

See Orders / Index.

Creating an order with one item that is edelivery.

{
  "orders": [
    {
      "shipped_items": [
        {
          "items": [
            {
              "ticket_group_id": 52554287,
              "price": 50.00,
              "quantity": 2,
              "ticket_group_signature": "a35e9ba5ffee9aabd0546f676cdda3c8"
            }
          ],
          "type": "Eticket",
          "email_address_id": 33333
        }
      ],
      "billing_address_id": 111111,
      "payments": [
        {
          "amount": 114.00,
          "type": "credit_card",
          "credit_card_id": 22222
        }
      ],
      "seller_id": "1691",
      "client_id": 107655,
      "created_by_ip_address": "12.34.56.78",
      "instructions": "These instructions will be visible to everyone",
      "shipping": 15.00,
      "service_fee": 9.00,
      "additional_expense": 0.00,
      "tax": 0.00,
      "discount": 10.00,
      "promo_code": "10DOLLARSOFF"
    }
  ]
}

See Orders / Index.