Swagger Petstore - OpenAPI 3.0
PATCH/api/ordering/recurring/occurrences/{id}

Skip a recurring order occurrence

Skips a scheduled occurrence of a standing order before it generates an order. Use this one-way ledger transition to record a human decision; you cannot restore an occurrence to scheduled. The response returns the skipped occurrence.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The unique identifier of the occurrence to skip.

The status transition to apply to the occurrence.

statusstringrequired
The occurrence status to set. Must be `skipped`.
Allowed:skipped

6 status codes
200Returns the skipped occurrence, including its status and occurrence details.
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
400Returned when the input is invalid or the occurrence is already resolved; the `error` field describes what was wrong.
errorstringrequired
401Returned when you are not authenticated.
errorstringrequired
403Returned when you are authenticated but lack the required department membership or role.
errorstringrequired
404Returned when the occurrence is not found.
errorstringrequired
500Returned when an unexpected server error occurs.
errorstringrequired

Error handling

A 400 is returned when the occurrence is already resolved or the input is invalid; a 401 is returned when you are not authenticated; a 403 is returned when you lack the required department membership or role; a 404 is returned when the occurrence is not found; and a 500 is returned for an unexpected server error. The id path parameter must identify the occurrence to skip. status is required and must be skipped.