v1

latestOpenAPI 3.1.02026-08-065143121.0 KB
Orders

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

Path parameters

eventIdHashstring required

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
statusstring
buyer_emailstring
page_sizeinteger
pageinteger
field_sortstring
sortstring

Response

OK

Example response

{
  "data": [
    {
      "address": {
        "address_num": "string",
        "city": "string",
        "country": "string",
        "lat": 0.1,
        "lon": 0.1,
        "name": "string",
        "state": "string"
      },
      "category_prim": {
        "name": "string"
      },
      "end_date": "2026-06-18T19:12:37.547Z",
      "host": {
        "description": "string",
        "name": "string"
      },
      "id": "string",
      "image": "string",
      "name": "string",
      "private_event": 1,
      "published": 1,
      "reference_id": 0,
      "start_date": "2026-06-18T19:12:37.547Z",
      "url": "string"
    }
  ],
  "pagination": {
    "has_next": true,
    "has_prev": false,
    "offset": 0,
    "page": 0,
    "page_size": 0,
    "quantity": 0
  },
  "sort": {
    "field_sort": "string",
    "sort": "string"
  }
}