Preview End of Season
POST/api/v2/seasons/:season/end/preview
Show which products would be ended with the season and what changing them would affect, without changing anything.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Candidates are unarchived products linked to the season for which it is their latest season (no link to a later or planned season), that are not NOOS and not already Discontinued. Matrix parents are expanded to their eligible variants. Candidates are grouped by parent style.
Body (all optional):
- to_state: phasing_out or discontinued (default: discontinued).
- product_ids (array of integers): limit the change to these candidates. Ids that are not candidates of the season are ignored. Omit to include every candidate.
- discontinue_on (date Y-m-d): required when to_state is phasing_out, and must be after today. Ignored for discontinued.
- last_order_date (date Y-m-d): phasing_out only; must be on or before discontinue_on.
- note (string, max 500): reason recorded on each product's lifecycle history (default: "Season <code> ended").
- notify_customers (boolean, default false): after the change, email recent B2B buyers one discontinuation notice for the whole season.
Response data:
- candidates: season (id, code, name, status), product_count, product_ids, groups (style {id, sku, name} or null for standalone products; products: id, sku, name, options, lifecycle_state, on_hand)
- selected_ids: the candidate ids the change would apply to
- impact (null when nothing is selected): product_count, target_ids, to_state, on_hand_units, on_hand_value, by_location (warehouse_id, name, type, units), leaves_planning (products dropped from demand planning), open_po_lines (count, units, purchase_order_ids, line_ids), open_backorders (count, units, sales_order_ids), bundles_affected (product_id, sku, name, type), boms_affected, listings (live, by_channel: integration_instance_id, channel, count), channel_effects (plain-language notes), b2b_buyers (recent wholesale buyers who would get a notice), policies (process → policy for the target state), warnings.
Requires a Bearer token with the products read/write scope and the products.manage_lifecycle permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.