Skip to main content

List Closeout Rows

POST 

/api/v2/closeout/rows

The products a closeout selection covers, with available units and wholesale, clearance and MSRP prices — the same rows the CSV, linesheet and offer email contain. Read-only.

Required scope: products:write

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

Selection fields (all optional):

  • product_ids (array of integers, max 2000): explicit products. A matrix parent id brings in all its variants. When sent, the lifecycle_states, season_ids, brand_ids and search filters are ignored.
  • sell_through_query (object, optional): the query of a List Lifecycle Sell-through request - its filter[...], filter_groups and sort keys, flat ({"filter[lifecycle_status.is_one_of]": "stalled", "sort": "-stock_value"}) or nested. Used when product_ids is omitted: the selection becomes the rows that query returns, in its order, up to 2,000. When sent, the lifecycle_states, season_ids, brand_ids and search filters are ignored; in_stock_only and the price tiers still apply.
  • lifecycle_states (array of lifecycle state keys, each max 40 chars): used when product_ids and sell_through_query are omitted. Default: ["discontinued"].
  • season_ids (array of integers): only products in any of these seasons.
  • brand_ids (array of integers): only products of these brands.
  • search (string, max 255): partial match on SKU or name.
  • in_stock_only (boolean, default true): only products with available units across all warehouses.
  • wholesale_tier_id (integer, existing pricing tier id): the tier for the wholesale price column. Default: the unarchived tier named exactly "Wholesale" (any case), else the oldest unarchived tier whose name contains "wholesale" (e.g. "Wholesale EU").
  • msrp_tier_id (integer, existing pricing tier id): the tier for the MSRP column. Default: the default pricing tier.

Archived products, matrix parents and bundles are never included (they hold no stock). At most 2,000 products, ordered by SKU.

Response data: rows (list), product_count, total_units (sum of units_available), max_rows (the most products one export, linesheet or offer carries: 2000). Row fields: product_id, sku, name, attributes (option values such as "Colour: Sand · Size: M", or null), image_url (primary image or null), units_available (all warehouses), wholesale_price, clearance_price (current price in an active clearance plan, or null), msrp, case_pack (or null), currency (currency code of the MSRP tier, else the wholesale tier), lifecycle_state (the product's lifecycle state key, e.g. discontinued or phasing_out).

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

Request​

Responses​

OK

Response Headers
    Content-Type