Skip to main content
PUT
Update Policy

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

policy_id
integer<int32>
required

The id of the referenced ReplenishmentPolicy.

Body

application/json

Properties of a Replenishment Policy to change. Only the properties present in the body are applied; an absent one keeps its stored value rather than being cleared. The warehouse cannot be changed, and every derived or index-owned property of ReplenishmentPolicy is rejected if present.

name
string

The user-visible Policy name; must be unique within the warehouse.

Required string length: 1 - 255
Example:

"Fast Movers - Forward Pick"

is_active
boolean

Whether the Policy participates in Product evaluation. Changing this invalidates the warehouse's published Replenishment results.

sort_order
integer

Policy precedence; lower values are evaluated first, with id as the tie-break.

Required range: 0 <= x <= 65535
Example:

10

merchant_ids
integer[] | null

Merchant IDs the Policy selects. null or an empty list means every Merchant.

Maximum array length: 100
Required range: x >= 1
Example:
product_profile_ids
integer[]

Product Profile IDs the Policy selects. An empty list means Product Profiles do not restrict the subject.

Maximum array length: 100
Required range: x >= 1
Example:
product_profile_match_mode
enum<string>

How the selected Product Profiles are matched against a Product. The none mode requires at least one Product Profile.

Available options:
any,
all,
none
handling_class_ids
integer[]

Handling Class IDs the Policy selects. Each must be assigned to this warehouse. An empty list means Handling Classes do not restrict the subject.

Maximum array length: 100
Required range: x >= 1
Example:
location_profile_id
integer<int32>

The id of the Location Profile supplying the target group. It must belong to this warehouse and already have a published revision.

Required range: x >= 1
Example:

3

demand_period_days
integer

The Product Velocity window used to derive daily demand. Must equal one of the configured Product Velocity periods.

Required range: 1 <= x <= 65535
Example:

30

trigger_doi_days
number

The coverage threshold below which an assigned Product is flagged for Replenishment.

Required range: 0 <= x <= 999999.9999
Example:

7

target_doi_days
number

The target coverage used to calculate the required replenishment quantity. Must not be lower than trigger_doi_days; equal values are accepted.

Required range: 0 <= x <= 999999.9999
Example:

21

Response

OK - The operation completed successfully and there is no response body.