Skip to main content

Product Lifecycle

📄️Change Product Lifecycle

Move a product to another lifecycle state — now, or on a future date. A future `effective_on` creates a pending schedule (replacing any pending schedule for the product) and the product keeps its current state until then; the message is then 'Lifecycle change scheduled.'. For a matrix parent the change also applies to its variants per `cascade`. The response is the product's updated lifecycle; `transition_id` is the id of the change just recorded (use it with Undo Lifecycle Change).

📄️Bulk Change Product Lifecycle

Change the lifecycle of many products at once, as a background job. Select explicit `ids`, or set `apply_to_all` with the products-list `filters` to target every matching product. Each product is processed on its own, so one failure does not block the rest; a future `effective_on` schedules each change. The response returns the background job id to follow progress and the number of products selected. Changes are recorded with source bulk unless you send source suggestion or automation.

📄️Export Lifecycle Sell-through

Exports sell-through rows as CSV, either an explicit selection of product ids or every row matching the same filters and sort as the list. Up to 1,000 rows the CSV downloads directly (200, text/csv, file name product-lifecycle-sell-through-YYYY-MM-DD.csv). Above 1,000 rows the export runs as a background job and the response is 202 with the tracked job id and row count; when the job finishes, download the file with the export download endpoint (the job result carries its download URL).

📄️Update Clearance Plan

Change an active plan's settings or ladder. Partial: send only the fields that change. Sending steps replaces the whole ladder. Adding a price tier saves the enrolled products' current price in that tier as their original price. Narrowing the scope — removing a price tier from price_tier_ids or a channel from integration_instance_ids — takes those listings out of the plan: for products the plan already marked down, the compare-at ('was') price it set is cleared on those listings (pushed straight away and retried on later price pushes until the channel confirms), and open suggestions for a removed price tier are skipped with the reason 'Price tier removed from the plan'. Ended plans cannot be changed (422).

📄️Send Closeout Offer

Check that the offer can reach someone, then queue a closeout offer email to each selected customer, listing the selected products with units and prices. Emails go out in a background job, one per customer, to the customer's email (or billing email when the main one is missing or invalid). They use the store's editable Closeout offer email template (Settings → Email Templates); if that template is switched off, no email is sent. Customers without a valid address, or whose store has the template switched off, are skipped and listed in the response. Each sent offer is logged on the customer's activity history. Before anything is queued the request is refused with 422 when the selection matches no products with stock (on selection), when none of the customers can be emailed (on customer_ids, saying how many have no valid address and how many belong to stores with the template switched off), or when the linesheet is needed - attach_linesheet, or a template that links to it - but no Closeout linesheet PDF template exists (on attach_linesheet).