Swagger Petstore - OpenAPI 3.0
GET/api/ordering/recurring/occurrences

The day's scheduled fires

Every occurrence on one day, across all customers — what the "firing today" panels read.

Omit ?date= and you get the server's Montreal business day, which is the intended call: it means the client does no date arithmetic and cannot disagree with the bakery about what "today" is. Pass from/to instead for a window.

Returns a bare array, ordered by date then id.

6 parameters
datestringoptional
One Montreal business day, `yyyy-mm-dd`. Defaults to today. Ignored when `from`/`to` are given.
fromstringoptional
Start of an inclusive window, `yyyy-mm-dd`.
tostringoptional
End of an inclusive window, `yyyy-mm-dd`. A range may cover at most 92 days — a wider one is refused, not truncated.
recurringOrderIdstringoptional
Filter to one standing order.
customerIdstringoptional
Filter to one customer.
statusstringoptional
Filter to one ledger state.
Allowed:scheduledgeneratedskippedcancelled

4 status codes
200The occurrences.
idstringoptional
recurringOrderIdstringoptional
recurringOrderNamestringoptional
customerIdstringoptional
customerNamestringoptional
occurrenceDatestringoptional
The DELIVERY day this fire is for — which becomes the generated order's `requestedDeliveryDate`.
statusstringoptional
`scheduled` = due · `generated` = fired · `skipped` = a HUMAN took it out · `cancelled` = the SYSTEM did.
Allowed:scheduledgeneratedskippedcancelled
cancelReasonstringoptional
Why the system cancelled it. Never rendered as a status. `missed` means the day passed with no run — a past day is NEVER generated late.
Allowed:pausedschedule_changedmissed
generatedOrderIdstringoptional
The order this fire produced.
generatedOrderNumberstringoptional
Snapshot taken inside the generating transaction. The history rail labels its jump-to-order button with this.
resolvedAtstringoptional
400Invalid input — the `error` string says what was wrong.
errorstringrequired
401Not authenticated. Sign in first (see the Auth tag).
errorstringrequired
500Unexpected server error.
errorstringrequired

Error handling

A 400 is returned: Invalid input — the error string says what was wrong. A 401 is returned: Not authenticated. Sign in first (see the Auth tag). A 500 is returned: Unexpected server error.