Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Orders

List orders with cursor-based pagination

Returns order data with cursor-based pagination, optional full-text search via query, advanced filters, and deterministic sorting.

get/orders

Query parameters

mineboolean

When true, returns only the authenticated user's orders. Can be combined with teamId or eventId to further filter results.

Example:true
teamIdstring

Filter orders by team unique identifier

eventIdstring

Filter orders by event unique identifier

Example:evt_01jps5cgsenjrazw6wswmyspa3
status'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'DISPUTED' | 'ABANDONED'

Filter orders by payment status

Example:SUCCESSFUL
querystring

Optional search query to filter orders by customer details. When provided, search-backed pagination is used.

Example:John Doe
includeEventTermsboolean

When true for authenticated user-owned order searches, also matches event name, slug, and location unless eventId is already provided.

Example:true
field'STATUS' | 'DELIVERY_METHOD' | 'CUSTOMER_EMAIL' | 'CUSTOMER_PHONE' | 'COUPON_CODE' | 'PAYMENT_SOURCE' | 'PAYMENT_METHOD' | 'CURRENCY' | 'CREATED_AT' | 'UPDATED_AT' | 'RESERVED_AT' | 'TOTAL' | 'TICKETS' | 'ORDER_ID' | 'CUSTOMER_ID' | 'EVENT_ID' | 'PROMOTER_ID' | 'PAYOUT_ID' required
operator'IS' | 'IS_NOT' | 'IS_ANY_OF' | 'CONTAINS' | 'IS_EMPTY' | 'IS_NOT_EMPTY' | 'BETWEEN' | 'GTE' | 'LTE' required
valuesstring[] required
sort'UPDATED_AT' | 'CREATED_AT' | 'EVENT_NAME' | 'TOTAL' | 'STATUS' | 'CUSTOMER_NAME' | 'PAYMENT_SOURCE' | 'COUPON_CODE' | 'TICKETS' | 'DELIVERY_METHOD' | 'CUSTOMER_EMAIL' | 'CUSTOMER_PHONE' | 'ORDER_ID'

Field to sort order lists by.

Example:UPDATED_AT
direction'asc' | 'desc'

Sort direction for order lists. Defaults to desc when omitted.

Example:asc
fromstring date

Filter orders created on or after this date (YYYY-MM-DD format). Inclusive of the entire day.

Example:2025-01-01
tostring date

Filter orders created on or before this date (YYYY-MM-DD format). Inclusive of the entire day.

Example:2025-12-31
limitinteger

Maximum number of orders to return per request (1-100, default: 20)

Example:20
cursorstring

Pagination cursor for continuing to fetch subsequent results

Example:eyJpZCI6Im9yZF8wMWpwczVjZ3NmZ3ZlNWI1ZzI2NjZreXJ5aCJ9

Response

OK

beforestring nullable

Cursor for navigating backward in the result set. Omitted when there are no prior results.

afterstring nullable

Cursor for navigating forward in the result set. Omitted when there are no subsequent results.

limitnumber required

Maximum number of items to return in each result set

Example response

{
  "orders": [
    {
      "id": "ord_01jps5cgsfgve5b5g2666kyryh",
      "createdAt": "2026-08-03T06:13:52.219Z",
      "updatedAt": "2026-08-03T06:13:52.219Z",
      "status": "PENDING",
      "payment": {
        "method": "FREE",
        "source": "APPLEPAY",
        "brand": "VISA",
        "last4": "4242",
        "stripeId": "pi_1234567890abcdef",
        "stripeClientSecret": "pi_1234567890abcdef_secret_xyz",
        "stripeCustomerSessionClientSecret": "cuss_1234567890abcdef_secret_xyz",
        "stripeAccountId": "acct_1234567890abcdef",
        "airwallexId": "int_hkdmr7v9rg1j8donpkmv96",
        "airwallexClientSecret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MTcwMDAwMzYwMCwiaW50ZW50X2lkIjoiaW50X2hrZG1yN3Y5cmcxajhkb25wa212OTYifQ.K8vLx2nPzQHdR5mT1wYcBfJkLmNpS3xG7aE9dH4qZvM",
        "airwallexCustomerId": "cus_hkdmrhkh8he4j3kvela",
        "airwallexCustomerClientSecret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MTcwMDAwMzYwMCwiY3VzdG9tZXJfaWQiOiJjdXNfaGtkbXJoa2g4aGU0ajNrdmVsYSJ9.abc123"
      },
      "items": [
        {
          "id": "itm_01jps5cgsfwyxj0516571eaf17",
          "kind": "ADMISSION",
          "quantity": 2,
          "admissionId": "adm_01jps5cgsee0xvapbk92e8eb4g",
          "sectionId": "sct_01jps5cgse0g3qj16kpq8t221r",
          "admission": {
            "id": "adm_01jps5cgsee0xvapbk92e8eb4g",
            "createdAt": "2026-08-03T06:13:52.214Z",
            "updatedAt": "2026-08-03T06:13:52.214Z",
            "sectionId": "sct_01jps5cgse0g3qj16kpq8t221r",
            "teamId": "tem_01jqpjksnsen9vprw95et60t2m",
            "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m",
            "eventId": "evt_01jps5cgsenjrazw6wswmyspa3",
            "eventSlug": "test-event",
            "name": "Final Release",
            "subtitle": "Entry before 10pm",
            "description": "Early bird pricing with priority entry. Must present valid ID at gate.",
            "capacity": 100000,
            "limit": -1,
            "available": 70000,
            "sold": 20000,
            "reserved": 10000,
            "order": 0,
            "entryStartsAt": "2026-08-04T06:13:52",
            "entryEndsAt": "2026-08-05T06:13:52",
            "saleStartsAt": "2026-08-03T06:13:52",
            "saleEndsAt": "2026-08-05T06:13:52",
            "saleEndsBehavior": "SALE_ENDED",
            "price": {
              "base": 1000,
              "booking": 200,
              "currency": "AUD"
            },
            "visibility": "ALWAYS",
            "tenantId": "tnt_01jqpj2t2kfvmstt6f6tzkbaf2",
            "deleted": false,
            "orderPadded": "0000000000"
          },
          "section": {
            "id": "sct_01jps5cgse0g3qj16kpq8t221r",
            "createdAt": "2026-08-03T06:13:52.214Z",
            "updatedAt": "2026-08-03T06:13:52.214Z",
            "name": "General Admission",
            "capacity": 1000,
            "limit": -1,
            "available": 700,
            "sold": 200,
            "reserved": 100,
            "visibility": "ALWAYS",
            "location": {
              "id": "loc_01hk153x00eh99pagyydz03sbz",
              "googlePlaceId": "ChIJP3Sa8ziYEmsRUKgyFmh9AQM",
              "createdAt": "2026-08-03T06:13:52.214Z",
              "updatedAt": "2026-08-03T06:13:52.214Z",
              "name": "Watson's EQ",
              "address": "The, Entertainment Quarter, 1 Bent St, Moore Park NSW 2021, Australia",
              "city": "Moore Park",
              "state": "New South Wales",
              "postcode": "2021",
              "country": "Australia",
              "latitude": -33.8944593,
              "longitude": 151.2252255,
              "timeZone": "Australia/Sydney",
              "types": [
                "establishment",
                "point_of_interest",
                "stadium"
              ],
              "description": "Historic outdoor amphitheater known for summer concerts",
              "image": {
                "src": "https://assets.session.services/my-image.jpg",
                "alt": "My Image",
                "width": 1080,
                "height": 1080
              }
            },
            "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m",
            "eventId": "evt_01jps5cgsenjrazw6wswmyspa3",
            "eventSlug": "test-event"
          },
          "price": {
            "net": 1200,
            "total": 1200,
            "gross": 1200,
            "base": 1000,
            "booking": 200,
            "currency": "AUD"
          }
        }
      ],
      "fees": [
        {
          "id": "fee_01jps5cgsgamykd6kh2t738qkh",
          "createdAt": "2026-08-03T06:13:52.219Z",
          "reason": "Gateway Fee",
          "amount": -30,
          "currency": "AUD",
          "requestId": "att_sgpdz4v2ph1axmdmdx8_m8w6qv",
          "kind": "GATEWAY"
        }
      ],
      "price": {
        "net": 500,
        "total": 1400,
        "gross": 2200,
        "base": 1000,
        "booking": 400,
        "sms": 200,
        "refunded": -700,
        "discount": -1000,
        "currency": "AUD"
      },
      "settlement": {
        "net": 500,
        "total": 1400,
        "gross": 2200,
        "base": 1000,
        "booking": 400,
        "sms": 200,
        "refunded": -700,
        "discount": -1000,
        "currency": "AUD",
        "exchangeRate": 1.4
      },
      "couponCode": {
        "id": "cod_01jps5cgsfzftw7hxcvr2wftk2",
        "name": "TEST50",
        "couponId": "cpn_01jps5cgsfzs1ksqaet5hba8ac"
      },
      "customer": {
        "id": "cus_01jps5cgsf4pn2a32eamppnap1",
        "firstName": "Test",
        "lastName": "User",
        "email": "test@session.services",
        "phone": "+61411111111"
      },
      "timeline": [
        {
          "id": "tln_01jps5cgsfgve5b5g2666kyryh",
          "createdAt": "2026-08-03T06:13:52.219Z",
          "status": "SUCCESSFUL",
          "kind": "ORDER_COMPLETED",
          "description": "Order was created successfully",
          "author": "System",
          "userId": "usr_01jps5cgsd4tzjghtnt45qnhn0",
          "externalId": "ses:01234567-89ab-cdef-0123-456789abcdef:Delivery"
        }
      ],
      "refunds": [
        {
          "id": "rfd_01jps5cgsfgve5b5g2666kyryh",
          "request": {
            "idempotencyKey": "refund_12345_customer_request"
          },
          "status": "PENDING",
          "acceptedAt": "2026-08-03T06:13:52.219Z",
          "failedAt": "2026-08-03T06:13:52.219Z",
          "failure": {
            "reason": "Insufficient funds for refund",
            "message": "The refund could not be processed."
          },
          "price": {
            "currency": "AUD",
            "total": 1200,
            "items": 1200
          },
          "reason": "CUSTOMER_REQUEST",
          "note": "Customer requested refund due to schedule conflict",
          "items": [
            {
              "orderItemId": "itm_01jps5cgsfwyxj0516571eaf17",
              "quantity": 2,
              "amount": 1200,
              "ticketIds": [
                "tkt_01jps5cgsg0s32w2pr73vbccde"
              ]
            }
          ],
          "tickets": {
            "cancelRequested": true,
            "cancelled": true,
            "cancelledCount": 2
          },
          "gateway": {
            "provider": "STRIPE",
            "refundId": "re_1234567890abcdef",
            "idempotencyKey": "rfd_01jps5cgsfgve5b5g2666kyryh"
          },
          "actor": {
            "type": "USER",
            "userId": "usr_01jps5cgsd4tzjghtnt45qnhn0"
          },
          "metadata": {
            "supportTicket": "#12345"
          },
          "notification": {
            "requested": true,
            "sentAt": "2026-08-03T06:13:52.219Z"
          },
          "createdAt": "2026-08-03T06:13:52.219Z"
        }
      ],
      "offers": [
        {
          "kind": "SMS_DELIVERY",
          "label": "SMS ticket delivery",
          "price": {
            "amount": 200,
            "currency": "AUD"
          }
        }
      ],
      "customerId": "cus_01jps5cgsf4pn2a32eamppnap1",
      "createdBy": {
        "id": "cus_01jps5cgsf4pn2a32eamppnap1",
        "firstName": "Test",
        "lastName": "User",
        "email": "test@session.services",
        "phone": "+61411111111"
      },
      "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m",
      "event": {
        "id": "evt_01jps5cgsenjrazw6wswmyspa3",
        "name": "Test Event",
        "slug": "test-event",
        "location": "Watson's EQ",
        "locationAddress": "The, Entertainment Quarter, 1 Bent St, Moore Park NSW 2021, Australia",
        "locationLatitude": -33.8944593,
        "locationLongitude": 151.2252255
      },
      "payoutIds": [
        "pay_01HQXYZ"
      ],
      "eventId": "evt_01jps5cgsenjrazw6wswmyspa3",
      "checkoutUrl": "https://example.com/checkout/ord_1234567890",
      "returnUrl": "https://example.com/event/success",
      "channel": {
        "name": "tenant-web",
        "referrer": "https://sash.teams.mixmag.au/events/example-event",
        "utmSource": "instagram",
        "utmMedium": "social",
        "utmCampaign": "summer-launch",
        "deviceType": "MOBILE",
        "browser": "Chrome",
        "country": "Australia",
        "region": "Australia - New South Wales",
        "sessionId": "ses_01HX...",
        "anonymousId": "aid_01HX..."
      },
      "reservedAt": "2026-08-03T06:13:52.282Z"
    }
  ],
  "before": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNqIn19",
  "after": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNkIn19",
  "limit": 20
}