Skip to main content

List Lifecycle States

GET 

/api/v2/product-lifecycle/states

Every lifecycle state (the three system states plus any custom ones), each with its product count and its resolved policy for every business process. The response also carries reasons (the lifecycle reasons a change can record, as {value, label}) and colors (the colours a state may use) next to data.

Required scope: products:read

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

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}].

Business processes and their 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

Reasons: brand_decision, supplier_discontinued, seasonal_end, low_performance, replaced, quality_issue, other. Colours: grey, blue, green, orange, red, purple, teal.

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

Request​

Responses​

OK

Response Headers
    Content-Type