state-machines

Create state machine

Creates a new state machine within the caller account. The transition graph is validated against the Kruzer mandatory skeleton (mandatory statuses present, cancellation route, no post-invoice cancellation, arrow integrity, custom status placement, nature composition).

post/api/v1/state-machines

Request body

entityType'ORDER' | 'FULFILLMENT_ORDER' required
codestring required
namestring required

Response

State machine created.

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

Changed in 2 of the 9 revisions of this API.14511

  • a3b4750a505f411See the full diff
    • added the new required request property code

      new-required-request-property

    • added the new required request property entityType

      new-required-request-property

    • added the new required request property name

      new-required-request-property

    • added the new required request property transitions

      new-required-request-property

    • added the new optional request property states

      new-optional-request-property

    • added the required property active to the response with the 201 status

      response-required-property-added

    • added the required property code to the response with the 201 status

      response-required-property-added

    • added the required property created_at to the response with the 201 status

      response-required-property-added

    • added the required property entity_type to the response with the 201 status

      response-required-property-added

    • added the required property id to the response with the 201 status

      response-required-property-added

    • added the required property is_default to the response with the 201 status

      response-required-property-added

    • added the required property name to the response with the 201 status

      response-required-property-added

    • added the required property transitions to the response with the 201 status

      response-required-property-added

    • added the required property updated_at to the response with the 201 status

      response-required-property-added

    • added the required property version to the response with the 201 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 84194c31ab85105See the full diff
    • the response property states/items/actions became optional for the status 201

      response-property-became-optional

    • the response property states/items/status became optional for the status 201

      response-property-became-optional

    • removed the required property active from the response with the 201 status

      response-required-property-removed

    • removed the required property code from the response with the 201 status

      response-required-property-removed

    • removed the required property created_at from the response with the 201 status

      response-required-property-removed

    • removed the required property entity_type from the response with the 201 status

      response-required-property-removed

    • removed the required property id from the response with the 201 status

      response-required-property-removed

    • removed the required property name from the response with the 201 status

      response-required-property-removed

    • removed the required property transitions from the response with the 201 status

      response-required-property-removed

    • removed the required property updated_at from the response with the 201 status

      response-required-property-removed

    • removed the request property code

      request-property-removed

    • removed the request property entityType

      request-property-removed

    • removed the request property name

      request-property-removed

    • removed the request property states

      request-property-removed

    • removed the request property transitions

      request-property-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog