Skip to main content

Orders

Overview

Orders represent ticket registrations for organizing events. Use these endpoints to list orders, create orders on behalf of attendees, and approve or reject pending orders. Subscription: All plans, including Free.

Order fields vs attached form

orders/create has two layers of attendee data: Do not duplicate first_name, last_name, or email as form fields — those come from the order body. The attached form is for extra questions (job title, dietary requirements, etc.). For paid ticket types, orders/create creates the order but does not charge the attendee. OrderResource does not currently include a payment URL field. Send the attendee to the Mollie checkout page:
Requires a connected Mollie account on the company — see Ticket types — Paid tickets and Mollie.

Endpoints

List orders

  • Method: GET
  • Path: /api/v1/{company}/event/{organizingEvent}/orders
  • Scope: orders:read (route group also requires events:read)
  • Subscription: All plans, including Free

Path parameters

Query parameters

Response 200

Response fields


Show order

  • Method: GET
  • Path: /api/v1/{company}/event/{organizingEvent}/orders/{order}
  • Scope: orders:read
  • Subscription: All plans, including Free

Query parameters

Response 200

Single OrderResource in data envelope.

Create order

  • Method: POST
  • Path: /api/v1/{company}/event/{organizingEvent}/orders/create/{ticketType}
  • Scope: orders:create
  • Subscription: All plans, including Free
Registers tickets on behalf of an attendee.

Path parameters

Request body

See the request body table below for field requirements.

Form answers (form field)

Not yet fully implemented. The form array is accepted by validation but order creation does not yet persist form submissions server-side. Shape is expected to be field sqid → value:
Keys are form field sqids from the attached ticket type form. Do not include order-level fields (first_name, last_name, email) here.

Response 200

Returns the created OrderResource. For paid tickets, redirect the attendee to the checkout URL. paid_at remains null until payment completes.

Approve order

  • Method: PATCH
  • Path: /api/v1/{company}/event/{organizingEvent}/orders/{order}/approve
  • Scope: orders:curate
  • Subscription: All plans, including Free
Approves a pending order that requires curator approval.

Response 200

Returns the updated OrderResource with approved_at set.

Reject order

  • Method: PATCH
  • Path: /api/v1/{company}/event/{organizingEvent}/orders/{order}/reject
  • Scope: orders:curate
  • Subscription: All plans, including Free
Rejects a pending order.

Response 200

Returns the updated OrderResource with rejected_at set.

Not implemented

  • DELETE /api/v1/{company}/event/{organizingEvent}/orders/{order}/cancel — route is commented out