Create order

POST

/orders

• Production API

Authorizations

• bearerAuth

Request Body ^required

object

order

required

Order data

object

orderNumber

required

Human-readable order number

string

Example

GW-12345679

currency

required

ISO 4217 currency code

string

/^[A-Z]{3}$/

Example

USD

companyId

required

Company/organization ID

string

organizerId

required

Organizer ID

string

contextId

required

Context ID (evt_, ven_, or org_*)

string

Example

evt_12mCmtjnL9AgfUn3rYlC

customer

required

object

id

string

email

string format: email

firstName

string

lastName

string

phone

string

status

Order status (defaults to ‘placed’)

string

default: placed

Allowed values: placed voided refunded completed attending cancelled started pending abandoned

items

Order items (tickets, merchandise, etc.)

Array<object>

object

costs

Total order cost breakdown

object

agreements

object

answers

Responses to checkout questions

object

meta

Order metadata

object

uid

User ID if order is associated with a user account

string

nullable

context

required

Context metadata for order creation

object

urn

URN for the order resource

string

Example

urn:cohost:order:external_12345

Responses

201

Order created successfully

object

ok

boolean

Example

true

data

object

order

object

id

string

orderNumber

string

currency

string

contextId

string

organizerId

string

status

string

Allowed values: placed completed attending cancelled refunded started pending abandoned

items

Array<object>

object

costs

object

subtotal

number

fees

number

tax

number

total

number

currency

string

customer

object

id

string

email

string format: email

firstName

string

lastName

string

phone

string

coupons

Array<object>

object

agreements

object

answers

object

forwarded

object

meta

object

context

object

uid

string

nullable

createdAt

string format: date-time

400

Invalid request body or validation error

401

Unauthorized - authentication required

500

Failed to create order