# Order

## GET /public-api/v1/event/{eventId}/order

> List orders for an event

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/order":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"stripeAccountId":{"type":["string","null"],"format":"uuid"},"userId":{"type":"string","format":"uuid"},"currency":{"type":"string","enum":["USD","HKD","THB","VND","IDR","MYR","PHP","TWD","SGD","KRW","JPY","CNY"]},"amount":{"type":"string"},"status":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"txRef":{"type":["string","null"]},"orderUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"promoCodeSnapshot":{"type":["object","null"],"properties":{},"additionalProperties":false},"orderItems":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"ticketClassId":{"type":["string","null"],"format":"uuid"},"unitPrice":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},"qty":{"type":"number","format":"float"},"regFormDataSnapshot":{"type":"object","properties":{},"additionalProperties":false},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"snapshot":{"type":"object","properties":{},"additionalProperties":false},"qty":{"type":"number","format":"float"}},"required":["ticketClassAddOnId","snapshot","qty"],"additionalProperties":false}},"associatedAttendeeId":{"type":["string","null"],"format":"uuid"}},"required":["orderId","ticketClassId","unitPrice","qty","regFormDataSnapshot","addOns","associatedAttendeeId"],"additionalProperties":false}},"paymentMethod":{"type":["string","null"],"enum":["online","offline"]},"paymentBillingInformation":{"type":["string","null"]},"offlinePaymentInvoiceId":{"type":["string","null"]},"offlinePaymentBillingInformation":{"type":["string","null"]},"offlinePaymentInvoiceDueAt":{"type":["string","null"],"format":"date-time"},"offlinePaymentApprovalStatus":{"type":["string","null"],"enum":["pending","approved","cancelled"]},"tax":{"type":["string","null"]},"isTaxInclusive":{"type":["boolean","null"]},"orderSummaryEmailSentAt":{"type":["string","null"],"format":"date-time"},"purchasedAt":{"type":["string","null"],"format":"date-time"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"additionalProperties":false}},"required":["id","stripeAccountId","userId","currency","amount","status","txRef","orderUtmParams","promoCodeSnapshot","orderItems","paymentMethod","paymentBillingInformation","offlinePaymentInvoiceDueAt","offlinePaymentApprovalStatus","tax","isTaxInclusive","orderSummaryEmailSentAt","purchasedAt","cancelledAt","createdAt","updatedAt","user"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"page":{"type":"number","format":"float","description":"Current page number"},"pageSize":{"type":"number","format":"float","description":"Number of items per page"},"pageCount":{"type":"number","format":"float","description":"Total number of pages"},"totalCount":{"type":"number","format":"float","description":"Total number of items"}},"required":["page","pageSize","pageCount","totalCount"],"additionalProperties":false}},"required":["dataList","pagination"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"number","format":"float","default":1,"minimum":1},"name":"page","in":"query"},{"schema":{"type":"number","format":"float","default":25,"maximum":100,"minimum":1},"name":"pageSize","in":"query"},{"schema":{"type":"string","default":"-createdAt"},"description":"Multiple Sort syntax \"-\" DESC, Empty for ASC, Available sorts: createdAt, offlinePaymentInvoiceDueAt, purchasedAt, orderSummaryEmailSentAt, userName, userEmail","name":"sort","in":"query"},{"schema":{"type":"object"},"properties":{"orderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"status":{"type":"array","items":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]}},"paymentMethod":{"type":"array","items":{"type":"string","enum":["online","offline"]}},"offlinePaymentApprovalStatus":{"type":"array","items":{"type":"string","enum":["pending","approved","cancelled"]}},"emails":{"type":"array","items":{"type":["string","null"]}},"q":{"type":"string"}},"additionalProperties":false,"description":"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.","name":"filter","in":"query"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Order"],"operationId":"getPaginatedOrderByEventId","summary":"List orders for an event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filter":{"type":"object","properties":{"orderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"status":{"type":"array","items":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]}},"paymentMethod":{"type":"array","items":{"type":"string","enum":["online","offline"]}},"offlinePaymentApprovalStatus":{"type":"array","items":{"type":"string","enum":["pending","approved","cancelled"]}},"emails":{"type":"array","items":{"type":["string","null"]}},"q":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}}}}}}}}
```

## GET /public-api/v1/event/{eventId}/order/{orderId}

> Get an order by ID

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/order/{orderId}":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"stripeAccountId":{"type":["string","null"],"format":"uuid"},"userId":{"type":"string","format":"uuid"},"currency":{"type":"string","enum":["USD","HKD","THB","VND","IDR","MYR","PHP","TWD","SGD","KRW","JPY","CNY"]},"amount":{"type":"string"},"status":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"txRef":{"type":["string","null"]},"orderUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"promoCodeSnapshot":{"type":["object","null"],"properties":{},"additionalProperties":false},"orderItems":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"ticketClassId":{"type":["string","null"],"format":"uuid"},"unitPrice":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$"},"qty":{"type":"number","format":"float"},"regFormDataSnapshot":{"type":"object","properties":{},"additionalProperties":false},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"snapshot":{"type":"object","properties":{},"additionalProperties":false},"qty":{"type":"number","format":"float"}},"required":["ticketClassAddOnId","snapshot","qty"],"additionalProperties":false}},"associatedAttendeeId":{"type":["string","null"],"format":"uuid"}},"required":["orderId","ticketClassId","unitPrice","qty","regFormDataSnapshot","addOns","associatedAttendeeId"],"additionalProperties":false}},"paymentMethod":{"type":["string","null"],"enum":["online","offline"]},"paymentBillingInformation":{"type":["string","null"]},"offlinePaymentInvoiceId":{"type":["string","null"]},"offlinePaymentBillingInformation":{"type":["string","null"]},"offlinePaymentInvoiceDueAt":{"type":["string","null"],"format":"date-time"},"offlinePaymentApprovalStatus":{"type":["string","null"],"enum":["pending","approved","cancelled"]},"tax":{"type":["string","null"]},"isTaxInclusive":{"type":["boolean","null"]},"orderSummaryEmailSentAt":{"type":["string","null"],"format":"date-time"},"purchasedAt":{"type":["string","null"],"format":"date-time"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"additionalProperties":false}},"required":["id","stripeAccountId","userId","currency","amount","status","txRef","orderUtmParams","promoCodeSnapshot","orderItems","paymentMethod","paymentBillingInformation","offlinePaymentInvoiceDueAt","offlinePaymentApprovalStatus","tax","isTaxInclusive","orderSummaryEmailSentAt","purchasedAt","cancelledAt","createdAt","updatedAt","user"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"orderId","in":"path"}],"tags":["Order"],"operationId":"getOrderById","summary":"Get an order by ID"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eventx-hq.gitbook.io/knowledge-base/api-doc/order.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.