strategies

Update strategy

Partially updates a strategy by its identifier. The code is immutable. When cluster_id is provided it must reference an existing cluster owned by the same account. When state_machine_id is provided it must reference an active FULFILLMENT_ORDER state machine; sending null re-resolves the account default.

patch/api/v1/strategies/{id}

Path parameters

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

Strategy identifier (UUID).

Request body

namestring
descriptionstring nullable
type'STORE' | 'DC' | 'DARK_STORE' | 'SELLER' | 'FULFILLMENT_NODE'
category'SALES' | 'OPERATIONS' | 'SALES_AND_OPERATIONS'
activeboolean
daily_capacitynumber
sfsboolean
endless_aisleboolean
operates_on_holidaysboolean
cluster_idstring nullable
state_machine_idstring nullable
colorstring nullable
tagsstring[] nullable
metadataobject nullable

Response

Strategy updated.

idstring required
codestring required
namestring required
descriptionstring nullable required
type'STORE' | 'DC' | 'DARK_STORE' | 'SELLER' | 'FULFILLMENT_NODE' required
category'SALES' | 'OPERATIONS' | 'SALES_AND_OPERATIONS' required
activeboolean required
sfsboolean required
endless_aisleboolean required
operates_on_holidaysboolean required
cluster_idstring nullable required
state_machine_idstring nullable required
colorstring nullable required
daily_capacitynumber required
tagsstring[] nullable required
metadataobject nullable required
created_atstring required
updated_atstring required

Changes

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

    • added the new optional request property active

      new-optional-request-property

    • added the new optional request property address

      new-optional-request-property

    • added the new optional request property category

      new-optional-request-property

    • added the new optional request property cluster_id

      new-optional-request-property

    • added the new optional request property color

      new-optional-request-property

    • added the new optional request property contact

      new-optional-request-property

    • added the new optional request property daily_capacity

      new-optional-request-property

    • added the new optional request property description

      new-optional-request-property

    • added the new optional request property endless_aisle

      new-optional-request-property

    • added the new optional request property holiday_operating_hours

      new-optional-request-property

    • added the new optional request property metadata

      new-optional-request-property

    • added the new optional request property name

      new-optional-request-property

    • added the new optional request property operates_on_holidays

      new-optional-request-property

    • added the new optional request property operating_hours

      new-optional-request-property

    • added the new optional request property sfs

      new-optional-request-property

    • added the new optional request property state_machine_id

      new-optional-request-property

    • added the new optional request property tags

      new-optional-request-property

    • added the new optional request property type

      new-optional-request-property

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

    • added the required property cluster_id 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 contact 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 daily_capacity 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 endless_aisle to the response with the 200 status

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

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

      response-required-property-added

    • added the required property type 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

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

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

    • removed the required property cluster_id 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 contact 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 daily_capacity from the response with the 200 status

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

    • removed the required property holiday_operating_hours 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 metadata from the response with the 200 status

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

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

      response-required-property-removed

    • removed the required property type 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 address

      request-property-removed

    • removed the request property category

      request-property-removed

    • removed the request property cluster_id

      request-property-removed

    • removed the request property color

      request-property-removed

    • removed the request property contact

      request-property-removed

    • removed the request property daily_capacity

      request-property-removed

    • removed the request property description

      request-property-removed

    • removed the request property endless_aisle

      request-property-removed

    • removed the request property holiday_operating_hours

      request-property-removed

    • removed the request property metadata

      request-property-removed

    • removed the request property name

      request-property-removed

    • removed the request property operates_on_holidays

      request-property-removed

    • removed the request property operating_hours

      request-property-removed

    • removed the request property sfs

      request-property-removed

    • removed the request property tags

      request-property-removed

    • removed the request property type

      request-property-removed

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