Skip to main content

Update Lifecycle Schedule

PUT 

/api/v2/product-lifecycle/schedules/:schedule

Change a pending schedule's date and/or target state. Send at least one of the two. A date of today applies the change straight away (the returned schedule then has status applied). Moving the target to phasing_out requires the schedule to already carry a discontinue date; moving it to phasing_out or discontinued without a reason records brand_decision. A phasing_out schedule must start before its discontinue date.

Required scope: products:write

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

422 errors:

  • "Only pending schedules can be changed." (schedule)
  • "The date must be today or later." (effective_on)
  • "Unknown lifecycle state "<key>"." (to_state)
  • "A scheduled move to Phasing out needs a discontinue date. Cancel this schedule and phase the product out instead." (to_state)
  • "The phase-out must start before its discontinue date (<date>, in the account's date format). Pick an earlier date, or cancel this schedule and phase the product out again with a new discontinue date." (effective_on) — when the new effective_on is on or after the schedule's discontinue_on

Body:

  • effective_on (date Y-m-d, today or later): required unless to_state is sent
  • to_state (string): existing lifecycle state key; required unless effective_on is sent

Schedule fields: id, product_id, product {id, sku, name, lifecycle_state, lifecycle_state_label, lifecycle_state_color}, from_state and from_state_label (the product's current state), to_state, to_state_label, effective_on, status (pending, applied, cancelled), origin (manual — scheduled by a user; phase_out — the automatic move to discontinued created when a product is phased out; auto_return — a state's automatic return), discontinue_on, last_order_date, reason (brand_decision, supplier_discontinued, seasonal_end, low_performance, replaced, quality_issue, other), note, created_by {id, name}, created_at.

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

Request​

Responses​

OK

Response Headers
    Content-Type