One order with its tickets, by id or reference

GET https://api.app2email.com/v1/{number}/tickets/orders/{id}
scope: tickets:manage sandbox: reads MCP: get_ticket_order

Scope: tickets:manage. By id or reference (TK-XXXXXX). The order with its money, the buyer and every ticket with its status and check-in state. page_url (on the order and on each valid ticket) opens the tickets without a login: treat it like a password and give it only to the buyer.

Path

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270
  • id string required

    The order: its id or its reference (TK-XXXXXX).

    e.g. TK-7H3KQ9

Responses

200 The order.
Fields
  • success boolean
  • request_id string
  • order object

    A ticket order: the buyer, the money and, where asked for, its tickets. Money is a number in the order's currency plus a label. Also inside ticket.order.confirmed and ticket.order.refunded, there with an empty page_url.

    42 fields
    • id integer

      The order's id.

      e.g. 8812
    • reference string
      e.g. TK-7H3KQ9
    • status string

      pending: a checkout that is not finished. expired: it was never paid or confirmed. confirmed: the tickets were issued.

      pendingconfirmedpartly_refundedrefundedcancelledexpired
    • kind string

      online: paid by card. free: a free order. comp: complimentary. outside: paid outside app2email.

      onlinefreecompoutside
    • channel string

      Where it was made.

      webwhatsappstaffdoorapi
    • source string

      The src label of the link the buyer came through.

    • event object
      3 fields
    • date object

      The date that was bought.

      4 fields
    • buyer object
      4 fields
      • name string
      • contact string

        The WhatsApp number in digits, or a business-scoped user id. Empty when unknown; erased-... after an erase.

      • email string
      • no_whatsapp boolean

        The buyer said they do not use WhatsApp.

    • currency string
      e.g. AUD
    • total number

      What the buyer pays, in currency.

    • total_label string
      e.g. A$24.00
    • The sum of the ticket prices.

    • order_fee number
    • donation number
    • discount number

      Information: already taken off tickets_total.

    • fees number

      Information: the booking fees inside total.

    • tax number

      Information: the tax inside total.

    • refunded number
    • Empty while nothing was refunded.

    • ticket_count integer

      Tickets of role ticket.

    • people_count integer

      The people they admit.

    • addon_count integer
    • promo_code string
    • payment object
      3 fields
      • id integer | null

        The online payment: the id of GET /payments/{id}. null for free, complimentary and outside orders.

      • method string

        stripe, paypal, cash, bank, card_machine, other, or empty.

      • note string

        The note of a sale paid outside.

    • comp_reason string

      kind comp: guest, artist, press, sponsor, staff, prize or other.

    • staff_note string

      The business's internal note.

    • created_by string

      customer, a person of the business, or API key <name>.

    • attention string

      Not empty: the order needs a look. dispute: the buyer's bank opened a card dispute and the tickets are blocked.

      refund_failedrefund_outsiderefund_mismatchpaid_twicedispute
    • close_reason string

      Why it ended without tickets: unpaid, buyer_cancelled, staff_cancelled, late_payment, date_cancelled, event_cancelled or erased.

    • refund_request object | null

      A refund the buyer asked for. null when there is none.

      3 fields
      • status string
        openrefundeddeclined
      • reason string
      • at string (date-time) | null
    • answers object any keys

      The answers given for the order: question id -> value.

    • erased boolean

      The buyer's details were erased on request.

    • page_url string

      The ticket page of this order. Anyone who has the link can open the tickets: treat it like a password and give it only to the buyer. Empty in webhook events and for an erased order.

    • expires string (date-time) | null

      pending: until when it can be paid or confirmed.

    • confirmed string (date-time) | null

      When the tickets were issued.

    • cancelled string (date-time) | null
    • refunded_at string (date-time) | null
    • created string (date-time)
    • updated string (date-time)
    • tickets object[]

      Every ticket of the order, any status. In GET /tickets/orders only with tickets=true.

      29 item fields
      • id integer

        The ticket's id.

        e.g. 501
      • order_id integer
        e.g. 8812
      • e.g. TK-7H3KQ9
      • event_id integer
        e.g. 12
      • date_id integer

        The date the ticket is for.

        e.g. 31
      • type_id integer
        e.g. 44
      • type_name string

        The ticket type's name as it was sold.

        e.g. Adult
      • role string
        ticketaddon
      • seq integer

        1..n inside the order.

      • status string

        valid and blocked tickets hold a place; refunded, cancelled and transferred (passed on) are final.

        validblockedrefundedcancelledtransferred
      • holder_name string
      • answers object any keys

        The answers given for this ticket: question id -> value.

      • seat object | null

        null without a seat.

        6 fields
        • key string

          The key of the seat in the seat plan.

        • label string
          e.g. Stalls, Row C, Seat 7
        • section string
        • row string
        • seat string
        • table string
      • admits integer
      • check_in object

        The check-in state of a ticket.

        7 fields
        • people integer

          People admitted so far (0 to admits). Above 0 = checked in.

        • inside integer

          People inside now, for events that count people leaving.

        • entries integer

          Accepted scans on the way in.

        • first_at string | null
        • last_at string | null
        • last_out_at string | null
        • gate string

          The id of the entrance of the last scan.

      • currency string
      • price number

        What was paid for this ticket, all in: what a refund of it returns.

      • price_label string
      • face number

        The all-in list price before a discount.

      • refunded number
      • refunded_at string (date-time) | null
      • block_reason string

        Why staff blocked it. A disputed payment reads Payment disputed.

      • passed_on boolean

        true: the ticket was made when a holder passed a ticket on.

      • replaces_id integer

        The ticket this one replaced. 0 = none.

      • The ticket that replaced this one. 0 = none.

      • page_url string

        The ticket page of this ticket. Anyone who has the link can open the ticket: treat it like a password and give it only to the buyer. Empty in webhook events, for an erased order and for a ticket that is no longer valid.

      • created string (date-time)
      • updated string (date-time)
      • buyer object

        Only in the rows of GET /tickets/issued: who bought it.

        3 fields
  • sent boolean

    Only after an order was made: a delivery to the buyer was started.

  • refunded number

    Only after a refund: what this call refunded.

  • note string

    What happened, in one sentence.

Errors

  • 401 Missing, invalid, revoked or expired API key.
  • 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
  • 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
  • 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
  • 500 Unexpected error on app2email's side.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.