Skip to main content

List FBA Sell-through Checklist

GET 

/api/v2/product-lifecycle/fba-checklist

Paginated FBA wind-down checklist: one row per exiting product (a state where demand planning is capped or excluded) and Amazon account that still holds FBA units, with the checklist steps ticked so far and the aged-inventory surcharge clock for that account. Archived products are excluded. The response also carries instances: every Amazon account that appears on the checklist ([{value: integration instance id, title: name}]).

Required scope: products:read

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

Steps (in order): non_replenishable (marked non-replenishable in Seller Central), removal_settings (automated removal settings reviewed), removal_order (removal order placed).

Filters:

  • filter[search]: matches product id (exact), SKU or name; narrow with search_columns / search_strict_columns
  • Numeric operators: product_id, integration_instance_id, fba_units, completed_steps, days_until_next_band (days until the next surcharge band; is_empty matches rows with no band ahead)
  • Text operators: sku, name, lifecycle_state, checklist_progress (none, partial, complete)
  • filter[exempt] / filter[exempt.is]: true or false - exempt from the 181-270-day surcharge bands (override first, else the Amazon product type)

Filter syntax: filter[<field>.<operator>]=<value>. A bare filter[<field>]=<value> means is where noted. Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty. Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (two comma-separated values), is_empty, is_not_empty. Date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days. For AND/OR logic, send filter_groups as base64-encoded JSON: {"conjunction":"and","children":[{"type":"condition","condition":{"column":"sku.contains","operator":"contains","value":"TEE"}}]}.

Sort: product_id, sku, product (by SKU), name, lifecycle_state, instance_name, fba_units, completed_steps, progress (by completed steps). Prefix with - for descending. Default: -fba_units, then product_id.

Pagination: page, per_page (1-100, default 10).

Row fields: product_id, sku, name, lifecycle_state, state_label, state_color, integration_instance_id, instance_name, fba_units, steps [{step, completed, completed_at, completed_by_user_id, url}], seller_sku, completed_steps, total_steps, fba_clock.

seller_sku is the Amazon seller SKU the product is listed under on that account (the oldest listing when there are several), or null when none is known. Each step's url is a Seller Central link for the account's marketplace that opens the page where that step is done, filtered to the seller SKU when known (restock recommendations for non_replenishable, FBA settings for removal_settings, Manage FBA Inventory for removal_order).

fba_clock fields (null when the product has no FBA stock): product_id, fba_units, exempt (exempt from the 181-270-day surcharge bands), exemption_source (override, product_type, or null), product_types (Amazon product types behind the exemption), next_band_days (age in days at which the next band starts), next_band_date, days_until_next_band, next_band_units (units that will cross it), next_band_monthly_cost, current_monthly_cost, removal_deadline (last day a removal order avoids the next band - Amazon assesses on the 15th, so this is the 14th), label (human-readable summary).

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

Request​

Responses​

OK

Response Headers
    Content-Type