Skip to main content

Save Lifecycle State Policies

PUT 

/api/v2/product-lifecycle/states/:state/policies

Save new policy values for a state. Only the processes you send change; the rest keep their current value. When products are in the state, a background job re-applies the policy to them (for example re-syncing channel quantities) and its id is returned as tracked_job_id next to data; it is null when the state has no products.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The active state must keep every process running: you may not set any process other than sell_out_action to a blocking value (block, excluded, off or hidden) on active — create a custom state instead.

Body:

  • policies (required, object, at least one entry): process key => policy value. Allowed values per process:
  • demand_planning (Demand planning & reorder suggestions): enabled, capped, excluded
  • mrp (MRP planned orders): enabled, capped, excluded
  • send_planning (Send planning (FBA, AWD, WFS, FBT)): enabled, warn, block
  • low_stock_alerts (Low-stock alerts): enabled, off
  • po_creation (Adding to purchase orders): enabled, warn, block
  • po_receiving (Receiving open purchase orders): enabled, warn
  • manufacturing (New work orders & assemblies): enabled, warn, block
  • component_use (Using it as a component): enabled, warn, block
  • sales_order_creation (Manual & API sales order lines): enabled, warn, block
  • backorders (New backorders): enabled, warn, block
  • portal_visibility (B2B portal): visible, visible_in_stock, hidden
  • listing_publishing (Publishing new listings): enabled, warn, block
  • channel_quantity (Channel quantity): normal, sell_through
  • drop_ship_stock (Drop-ship supplier stock): enabled, excluded
  • sell_out_action (When it sells out): none, settings_default

State fields: key (stable identifier used in URLs and on products), label, description, color, is_system (true for active, phasing_out and discontinued, which cannot be deleted), sort_order, product_count (products currently in the state), auto_return (null, or {after_days, to_state}: products move back automatically after that many days), and policies — one entry per business process with process, label, help, value (current), value_label, default_value (the system default for this state), and allowed_values [{value, label}].

Requires a Bearer token with the products read/write scope and the settings.update permission.

Request​

Responses​

OK

Response Headers
    Content-Type