Order

List orders for an event

get

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

Query parameters

pagenumber · float · min: 1OptionalDefault: 1

pageEndnumber · floatOptional

Optional inclusive ending page for requesting a range of pages. Maximum page range: 200.

pageSizenumber · float · min: 1 · max: 100OptionalDefault: 25

sortstringOptional

Multiple Sort syntax "-" DESC, Empty for ASC, Available sorts: createdAt, offlinePaymentInvoiceDueAt, purchasedAt, orderSummaryEmailSentAt, userName, userEmail

Default: -createdAtExample: -sorterA,sorterB

filterobjectOptional

This key can be provided in the body with key "filter" or query with stringified & encodeURIComponent format, e.g. query.filter = encodeURIComponent(JSON.stringify(filter)). Please refer to schema in body and do not provide both at the same time.

Body

Responses

200

Success

application/json

500

ERROR

get/public-api/v1/event/{eventId}/order

GET /public-api/v1/event/{eventId}/order HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "filter": {
    "orderIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "status": [
      "confirmed"
    ],
    "paymentMethod": [
      "credit-card"
    ],
    "offlinePaymentApprovalStatus": [
      "pending"
    ],
    "emails": [
      "user@example.com"
    ],
    "q": "EVT-001"
  }
}

{
  "dataList": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "stripeAccountId": null,
      "userId": "550e8400-e29b-41d4-a716-446655440001",
      "currency": "HKD",
      "amount": "100.00",
      "status": "CONFIRMED",
      "txRef": "EVT-2024-001",
      "orderUtmParams": {},
      "promoCodeSnapshot": null,
      "orderItems": [
        {
          "orderId": "550e8400-e29b-41d4-a716-446655440000",
          "ticketClassId": "550e8400-e29b-41d4-a716-446655440002",
          "unitPrice": "100.00",
          "qty": 1,
          "regFormDataSnapshot": {},
          "addOns": [],
          "associatedAttendeeId": "550e8400-e29b-41d4-a716-446655440003"
        }
      ],
      "paymentMethod": "CREDIT_CARD",
      "paymentBillingInformation": null,
      "offlinePaymentInvoiceId": null,
      "offlinePaymentBillingInformation": null,
      "offlinePaymentInvoiceDueAt": null,
      "offlinePaymentApprovalStatus": null,
      "tax": null,
      "isTaxInclusive": false,
      "orderSummaryEmailSentAt": null,
      "purchasedAt": "2024-01-01T00:00:00.000Z",
      "cancelledAt": null,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "user": {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "email": "user@example.com",
        "name": "John Doe"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pageCount": 1,
    "totalCount": 1
  }
}

Get an order by ID

get