Sign in

v1

latestOpenAPI 3.1.02026-08-065143121.0 KB
Orders

Lista os pedidos de um evento

Retorna uma lista paginada de pedidos associados a um evento

get/v1.6.0/events/{eventIdHash}/orders

Path parameters

eventIdHashstring required

Hash do ID do evento

Query parameters

timezonestring

Timezone IANA aplicada às datas de entrada/saída. Padrão: America/Sao_Paulo.

Example:America/Sao_Paulo

Timezone IANA aplicada às datas de entrada/saída. Padrão: America/Sao_Paulo.

fromstring date-time

Data/hora inicial (ISO-8601 local na timezone informada).

Data/hora inicial (ISO-8601 local na timezone informada).

tostring date-time

Data/hora final (ISO-8601 local na timezone informada).

Data/hora final (ISO-8601 local na timezone informada).

fieldsstring[]

Campos a retornar, separados por vírgula (snake_case). Disponíveis: id, event_id, order_date, order_status, updated_date, approved_date, discount_code, transaction_type, order_total_sale_price, order_total_net_value, buyer_first_name, buyer_last_name, buyer_email, presentation_id, invoice_info, utm.

Campos a retornar, separados por vírgula (snake_case). Disponíveis: id, event_id, order_date, order_status, updated_date, approved_date, discount_code, transaction_type, order_total_sale_price, order_total_net_value, buyer_first_name, buyer_last_name, buyer_email, presentation_id, invoice_info, utm.

[
  "id,order_status,buyer_email"
]
cancelled_filterstring

Filtro de cancelados: none (padrão) | include | only.

buyer_emailstring

Filtra pelo e-mail do comprador (correspondência exata).

page_sizeinteger

Quantidade de itens por página (1–200). Padrão: 100.

cursorstring

Cursor de paginação retornado em pagination.next_cursor para buscar a próxima página.

field_sortstring

Campo de ordenação. Valores: order_date (padrão; alias: created_at), updated_date, approved_date, buyer_email, status, id.

sortstring

Direção da ordenação: asc | desc.

Response

Success

Example response

{
  "data": [
    {
      "approved_date": "2026-06-18 19:12:37",
      "buyer_email": "string",
      "buyer_first_name": "string",
      "buyer_last_name": "string",
      "discount_code": "string",
      "event_id": "string",
      "id": "string",
      "invoice_info": {
        "name": "string"
      },
      "order_date": "2026-06-18 19:12:37",
      "order_status": "string",
      "order_total_net_value": 0.1,
      "order_total_sale_price": 0.1,
      "presentation_id": 0,
      "transaction_type": "string",
      "updated_date": "2026-06-18 19:12:37",
      "utm": {
        "utm_source": "string"
      }
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "page_size": 0,
    "quantity": 0
  },
  "sort": {
    "field_sort": "string",
    "sort": "string"
  }
}