Skip to main content

Preview Lifecycle State Policy Changes

POST 

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

See what a policy change would do before saving it: how many products are in the state and, for each process whose value would actually change, the current and proposed value labels. Nothing is saved.

Required scope: products:write

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

Body:

  • policies (required, object, at least one entry): process key => policy value. Each value must be one of the process's allowed values:
  • 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

Response fields: product_count, changes [{process, label, from, to}] (from/to are value labels; unchanged processes are omitted).

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

Request​

Responses​

OK

Response Headers
    Content-Type