> For the complete documentation index, see [llms.txt](https://eventx-hq.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eventx-hq.gitbook.io/knowledge-base/api-doc/order.md).

# Order

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

> List orders for an event

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"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","format":"uuid","nullable":true},"userId":{"type":"string","format":"uuid"},"currency":{"type":"string","enum":["USD","HKD","THB","VND","IDR","MYR","PHP","TWD","SGD","KRW","JPY","CNY","AUD"]},"amount":{"type":"string"},"status":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"txRef":{"type":"string","nullable":true},"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","properties":{},"additionalProperties":false,"nullable":true},"orderItems":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"ticketClassId":{"type":"string","format":"uuid","nullable":true},"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","format":"uuid","nullable":true}},"required":["orderId","ticketClassId","unitPrice","qty","regFormDataSnapshot","addOns","associatedAttendeeId"],"additionalProperties":false}},"paymentMethod":{"type":"string","enum":["online","offline"],"nullable":true},"paymentBillingInformation":{"type":"string","nullable":true},"offlinePaymentInvoiceId":{"type":"string","nullable":true},"offlinePaymentBillingInformation":{"type":"string","nullable":true},"offlinePaymentInvoiceDueAt":{"type":"string","format":"date-time","nullable":true},"offlinePaymentApprovalStatus":{"type":"string","enum":["pending","approved","cancelled"],"nullable":true},"tax":{"type":"string","nullable":true},"isTaxInclusive":{"type":"boolean","nullable":true},"orderSummaryEmailSentAt":{"type":"string","format":"date-time","nullable":true},"purchasedAt":{"type":"string","format":"date-time","nullable":true},"cancelledAt":{"type":"string","format":"date-time","nullable":true},"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,"description":"Order response object returned by order endpoints"}},"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":[{"name":"page","in":"query","schema":{"type":"number","format":"float","minimum":1,"default":1}},{"description":"Optional inclusive ending page for requesting a range of pages. Maximum page range: 200.","name":"pageEnd","in":"query","schema":{"type":"number","format":"float","minimum":0,"maximum":0}},{"name":"pageSize","in":"query","schema":{"type":"number","format":"float","minimum":1,"maximum":100,"default":25}},{"description":"Multiple Sort syntax \"-\" DESC, Empty for ASC, Available sorts: createdAt, offlinePaymentInvoiceDueAt, purchasedAt, orderSummaryEmailSentAt, userName, userEmail","name":"sort","in":"query","schema":{"type":"string","default":"-createdAt"}},{"properties":{"orderIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"JSON array of order UUIDs to filter by"},"status":{"type":"array","items":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"description":"Filter by order statuses"},"paymentMethod":{"type":"array","items":{"type":"string","enum":["online","offline"]},"description":"Filter by payment methods"},"offlinePaymentApprovalStatus":{"type":"array","items":{"type":"string","enum":["pending","approved","cancelled"]},"description":"Filter by offline payment approval statuses"},"emails":{"type":"array","items":{"type":"string","nullable":true},"description":"JSON array of purchaser email addresses to filter by"},"q":{"type":"string","description":"Free-text search across order reference and purchaser fields"}},"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":"object","additionalProperties":false}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filter":{"type":"object","properties":{"orderIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"JSON array of order UUIDs to filter by"},"status":{"type":"array","items":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"description":"Filter by order statuses"},"paymentMethod":{"type":"array","items":{"type":"string","enum":["online","offline"]},"description":"Filter by payment methods"},"offlinePaymentApprovalStatus":{"type":"array","items":{"type":"string","enum":["pending","approved","cancelled"]},"description":"Filter by offline payment approval statuses"},"emails":{"type":"array","items":{"type":"string","nullable":true},"description":"JSON array of purchaser email addresses to filter by"},"q":{"type":"string","description":"Free-text search across order reference and purchaser fields"}},"additionalProperties":false}},"additionalProperties":false}}}},"tags":["Order"],"operationId":"getPaginatedOrderByEventId","summary":"List orders for an event"}}}}
```

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

> Get an order by ID

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"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","format":"uuid","nullable":true},"userId":{"type":"string","format":"uuid"},"currency":{"type":"string","enum":["USD","HKD","THB","VND","IDR","MYR","PHP","TWD","SGD","KRW","JPY","CNY","AUD"]},"amount":{"type":"string"},"status":{"type":"string","enum":["initialized","pending_payment","paid","cancelled","completed","refunding","refunded"]},"txRef":{"type":"string","nullable":true},"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","properties":{},"additionalProperties":false,"nullable":true},"orderItems":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"ticketClassId":{"type":"string","format":"uuid","nullable":true},"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","format":"uuid","nullable":true}},"required":["orderId","ticketClassId","unitPrice","qty","regFormDataSnapshot","addOns","associatedAttendeeId"],"additionalProperties":false}},"paymentMethod":{"type":"string","enum":["online","offline"],"nullable":true},"paymentBillingInformation":{"type":"string","nullable":true},"offlinePaymentInvoiceId":{"type":"string","nullable":true},"offlinePaymentBillingInformation":{"type":"string","nullable":true},"offlinePaymentInvoiceDueAt":{"type":"string","format":"date-time","nullable":true},"offlinePaymentApprovalStatus":{"type":"string","enum":["pending","approved","cancelled"],"nullable":true},"tax":{"type":"string","nullable":true},"isTaxInclusive":{"type":"boolean","nullable":true},"orderSummaryEmailSentAt":{"type":"string","format":"date-time","nullable":true},"purchasedAt":{"type":"string","format":"date-time","nullable":true},"cancelledAt":{"type":"string","format":"date-time","nullable":true},"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,"description":"Order response object returned by order endpoints"}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"tags":["Order"],"operationId":"getOrderById","summary":"Get an order by ID"}}}}
```