Orders
Read orders from the Peppered API. Useful for syncing to CRM/BI systems.
| Method | Path | Purpose |
|---|---|---|
GET | /peppered/order | List 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
| Name | Type | Description |
|---|---|---|
changedSince | date | Only return orders changed on or after this date/time. Useful for incremental sync. |
Response
200 OK — array of OrderResource:
[
{
"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,
"orderDonation": 5.00,
"lastChanged": "2026-04-22T13:10:12+02:00",
"handlingTextPayment": "iDEAL",
"discountName": null
}
]
Get order
GET /v1/:client_name/peppered/order/{orderId}
Returns a single order.
Response
200 OK — OrderResource for one order.
404 Not Found — order doesn't exist for this client.
OrderResource fields
| Field | Type | Description |
|---|---|---|
orderId | integer | Internal order ID |
orderKey | string | Unique key used in public ticket URLs |
customerId | integer | null | Linked customer (null for anonymous orders) |
orderStatus | string | Order state — see table below |
orderPaymentStatus | string | Payment state — see table below |
orderDate | ISO datetime | When the order was created |
timeOut | ISO datetime | null | For reservations: when it expires |
amount | decimal | Total amount |
orderDonation | decimal | Donation portion |
lastChanged | ISO datetime | Last modification timestamp |
handlingTextPayment | string | Payment method label |
discountName | string | null | Order-level discount (if any) |
Order statuses
orderStatus:
| Value | Meaning |
|---|---|
ord | Regular order |
cancel | Cancelled |
reemit | Re-issued (replacement order) |
reissue | Re-issued (older valid-again) |
res | Reservation (no payment yet) |
pros | Prospectus (offer, not confirmed) |
trash | Soft-deleted |
orderPaymentStatus:
| Value | Meaning |
|---|---|
none | No payment yet |
pending | Payment in progress |
paid | Paid in full |
partial | Partially paid |
cancelled | Cancelled |
Incremental sync pattern
To keep a CRM or data warehouse in sync without fetching everything every time:
- Record the
lastChangedtimestamp from your last sync. - Call
GET /peppered/order?changedSince=<last-sync>to fetch only what changed. - For each order, optionally fetch details or linked customer.
- Update your local copy.
- Save the new high-watermark timestamp.
For full seat-level data (not included in the list endpoint), use Exports → Orders.