Skip to content
View Markdown

Loading documentation…

Working with orders

Read paginated orders, individual order details, and compact snapshots.

An order groups billing information, payment state, and purchased order lines. Use order IDs as stable keys and keep the event relationship in your own model.

List event orders

cURL
curl --user "$PAYDRO_EMAIL:$PAYDRO_PASSWORD" \
  --header 'Accept: application/json' \
  "$PAYDRO_ORIGIN/$EVENT_ID/orders/index/all.json"

The response is an array of records with an Order property. The default page size is 50. Event scoped all reads are a useful starting point; use the pagination guide for later pages and filters.

Retrieve an order

cURL
curl --user "$PAYDRO_EMAIL:$PAYDRO_PASSWORD" \
  --header 'Accept: application/json' \
  "$PAYDRO_ORIGIN/$EVENT_ID/orders/view/$ORDER_ID.json"

The detail response includes Order and related OrderLine records. It retains the legacy envelope and can include additional related payment and attachment data. Match an order to the event in the request path.

Payment state

Use the derived is_paid and payment_state fields from ordinary order responses. Payment channel, settlement, reservation, refund, and cancellation are separate facts. An accepted invoice can have outstanding payment; a pending refund does not mean that the refund has settled.

Import many orders

/orders/all_data.json and /orders/changed_data.json return compact event grouped data across accessible companies. Their abbreviated fields and 75,000 row combined limit differ from ordinary order lists. Read synchronization before using them.

Manage the order

Read order management for billing edits, reservation confirmation/release, email resends, invoice settlement and eligible cancellation. These actions use the current payment-state capabilities. Invoice/ticket PDFs are described in Files; CSV/Excel downloads are in Exports.