state-machines

Update state machine

Changed on

Partially updates a state machine by its identifier (name, transitions, active). The code and entity type are immutable. When transitions change, the resulting graph goes through the same structural save validations as creation. Deactivating (active: false) is blocked while a live strategy references the machine, and ORDER machines cannot be deactivated at all (canonical order flow of the account).

patch/api/v1/state-machines/{id}

Request

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

State machine identifier (UUID).

Request body

namestring
activeboolean

Response

State machine updated.

idstring required
entity_type'ORDER' | 'FULFILLMENT_ORDER' required
codestring required
namestring required
activeboolean required
is_defaultboolean required
versionnumber required
created_atstring required
updated_atstring required

Changes

    • breaking

      added the new required request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status