Ga naar hoofdinhoud

Orders

Read orders from the Peppered API. Useful for syncing to CRM/BI systems.

MethodPathPurpose
GET/peppered/orderList all orders (filter by changedSince)
GET/peppered/order/{orderId}Get a specific order

For bulk exports (including seat-level detail, deleted seats, customer info in-line) see Exports.


List orders​

GET /v1/:client_name/peppered/order

Query parameters​

NameTypeDescription
changedSincedateOnly return orders changed on or after this date/time. Useful for incremental sync.

Response​

200 OK - paginated data array (100 orders per page, newest first) of Order. This route is served by the same method as POST /peppered/export/orders, so each order also carries the export-only fields (orderChannel, fee, seats, deletedSeats, user) and the response is wrapped in the same pagination envelope (current_page, last_page, next_page_url, total, …).

{
"data": [
{
"orderId": 12345,
"orderKey": "XgFca-QmBxG-9WhAj-Osszb",
"customerId": 867,
"orderStatus": "ord",
"orderPaymentStatus": "paid",
"orderDate": "2026-04-22T13:08:55+02:00",
"timeOut": null,
"amount": 49.00,
"donation": 5.00,
"lastChanged": "2026-04-22T13:10:12+02:00",
"handlingTextPayment": "iDEAL",
"discountName": null
}
],
"current_page": 1,
"last_page": 1,
"per_page": 100,
"total": 1,
"next_page_url": null
}

Get order​

GET /v1/:client_name/peppered/order/{orderId}

Returns a single order.

Response​

200 OK - Order for one order.

404 Not Found - order doesn't exist for this client.


Order fields​

FieldTypeDescription
orderIdintegerInternal order ID
orderKeystringUnique key used in public ticket URLs
customerIdinteger | nullLinked customer (null for anonymous orders)
orderStatusstringOrder state - see table below
orderPaymentStatusstringPayment state - see table below
orderDateISO datetimeWhen the order was created
timeOutISO datetime | nullFor reservations: when it expires
amountdecimalTotal amount
donationdecimalDonation portion (the cart checkout response uses orderDonation for the same value)
lastChangedISO datetimeLast modification timestamp
handlingTextPaymentstringPayment method label
discountNamestring | nullOrder-level discount (if any)

Order statuses​

orderStatus:

ValueMeaning
ordRegular order
cancelCancelled
reemitRe-issued (replacement order)
reissueRe-issued (older valid-again)
resReservation (no payment yet)
prosProspectus (offer, not confirmed)
trashSoft-deleted

orderPaymentStatus:

ValueMeaning
noneNo payment yet
pendingPayment in progress
paidPaid in full
partialPartially paid
cancelledCancelled

Incremental sync pattern​

To keep a CRM or data warehouse in sync without fetching everything every time:

  1. Record the lastChanged timestamp from your last sync.
  2. Call GET /peppered/order?changedSince=<last-sync> to fetch only what changed.
  3. For each order, optionally fetch details or linked customer.
  4. Update your local copy.
  5. Save the new high-watermark timestamp.

For full seat-level data (not included in the list endpoint), use Exports → Orders.


See also: Customers · Exports · Cart