Skip to main content

Export Lifecycle Sell-through

GET 

/api/v2/product-lifecycle/sell-through/export

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).

Required scope: products:read

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

Query:

  • ids[] (optional, integer array, up to 5,000): export only these product ids (still subject to the filters)
  • columns (optional, comma-separated string): only export these columns; ID is always included. Keys and the CSV columns each one writes: id (ID), product (SKU, Product, Variant), lifecycle_state (State), since_at (Since), lifecycle_reason (Reason), units_at_discontinue (Units at discontinue), units_sold_since (Units sold since, Units received since), sell_through_pct (Sell-through %), on_hand (On hand, FBA units), stock_value (Value at cost), velocity_30d (30-day velocity), weeks_of_cover (Weeks of cover), projected_sell_out_on (Projected sell-out), target_sell_out_on (Target date), lifecycle_status (Status), markdown (Clearance plan, Markdown step), successor (Successor), fba_clock (FBA clock, Removal order by). Unknown keys are ignored; when none of the keys is known (or columns is omitted) every column is exported. Applies to the background export too.
  • Any list filter and sort (see List Lifecycle Sell-through); page and per_page are ignored

For large selections send POST with the filters in the query string and a JSON body {"ids": [1042, 877]}; columns may go in the query string or the body.

CSV columns (all, in this order, when columns is omitted): ID, SKU, Product, Variant, State, Since, Reason, Units at discontinue, Units sold since, Units received since, Sell-through %, On hand, FBA units, Value at cost, 30-day velocity, Weeks of cover, Projected sell-out, Target date, Status, Clearance plan, Markdown step, Successor, FBA clock, Removal order by.

202 response fields: data.tracked_job_log_id, data.rows, message.

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

Request​

Responses​

OK

Response Headers
    Content-Type