commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Recurring-order → Update RecurringOrder by Key

AI-generated

Summary

Update a commercetools recurring order identified by its unique key, applying one or multiple update actions specified either in JSON format or through a UI collection.

Inputs

  • Recurring-order Key (required) — The unique key identifying the recurring order to update.
  • Version (required) — The current version number of the recurring order for concurrency control.
  • Actions (JSON) — A raw JSON array of update actions to apply; overrides the UI-based actions if provided.
  • Actions (UI) — One or more update actions defined via the UI, including setting custom fields/types, expiration, keys, order skip configuration, recurring order state, schedule, start date, or state transitions.

Output shape

a single JSON object representing the updated recurring order resource as returned by the commercetools API

The update requires the current version for optimistic concurrency. Either 'Actions (JSON)' or 'Actions (UI)' must be provided to specify update operations. Errors during update throw exceptions unless 'continueOnFail' is enabled.

Examples

Example 1: Update expiresAt date and set a custom field on a recurring order

Provide the recurring order key, current version, and use either 'Actions (UI)' to set 'setExpiresAt' and 'setCustomField' actions, or provide equivalent raw JSON actions in 'Actions (JSON).'

Links

Discussion