statuses

Update status

Partially updates a custom status by its identifier (label, color, active). The code and entity type are immutable. KRUZER base statuses cannot be modified.

patch/api/v1/statuses/{id}

Path parameters

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

Status identifier (UUID).

Request body

labelstring
descriptionstring
colorstring
activeboolean

Response

Status updated.

idstring required
entity_type'ORDER' | 'FULFILLMENT_ORDER' required
codestring required
labelstring required
descriptionstring required
nature'INITIAL' | 'PROCESSING' | 'FINAL' | 'ERROR' required
colorstring required
origin'KRUZER' | 'CUSTOM' required
activeboolean required
created_atstring required
updated_atstring required

Changes

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

    • added the new optional request property active

      new-optional-request-property

    • added the new optional request property color

      new-optional-request-property

    • added the new optional request property description

      new-optional-request-property

    • added the new optional request property label

      new-optional-request-property

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

      response-required-property-added

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

      response-required-property-added

    • added the required property color to the response with the 200 status

      response-required-property-added

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

      response-required-property-added

    • added the required property description to the response with the 200 status

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

    • added the required property label to the response with the 200 status

      response-required-property-added

    • added the required property nature to the response with the 200 status

      response-required-property-added

    • added the required property origin to the response with the 200 status

      response-required-property-added

    • added the required property updated_at to the response with the 200 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

  • 84194c31ab85103See the full diff
    • removed the required property active from the response with the 200 status

      response-required-property-removed

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

      response-required-property-removed

    • removed the required property color from the response with the 200 status

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

    • removed the required property label from the response with the 200 status

      response-required-property-removed

    • removed the required property nature from the response with the 200 status

      response-required-property-removed

    • removed the required property origin from the response with the 200 status

      response-required-property-removed

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

      response-required-property-removed

    • removed the request property active

      request-property-removed

    • removed the request property color

      request-property-removed

    • removed the request property label

      request-property-removed

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