Skip to main content

List Configurable Products

GET 

/api/configurable-products

List the configured SKUs seen on sales order lines. When a sales channel sends the SKU of a made-to-order variant in a line option (for example a SKU property on a Shopify line), that configured SKU decides which product the line is for. Each configured SKU is listed once per sales channel, with the base product the channel sent, the product it is mapped to (if any), and how many order lines are waiting for a product.

Required scope: products:read

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

Authentication: Requires Bearer token (scope products:read).

Returns 404 while line options are switched off (see Settings → Line Options).

Filters use filter[column]=value (implicit is) or filter[column.operator]=value.

  • Text columns: configured_sku, base_sku, product_sku, base_sales_channel_listing_id, created_via, status, sales_channel_id, option, option_value, has_waiting_lines, has_base_lines, option_rules. 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. For status, sales_channel_id and option, contains/starts_with/ends_with behave as is.
  • Numeric columns: id, base_product_id, seen_count, waiting_lines_count. Operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
  • Date columns: first_seen_at, last_seen_at. 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.
  • filter[search] searches the configured SKU, base and mapped product SKUs and sample option values.

Grouped filters: pass filter_groups (base64-encoded JSON, or a JSON object in the request body) to combine conditions with AND/OR, e.g. {"conjunction":"and","children":[{"type":"condition","condition":{"column":"status","operator":"is","value":"needs_mapping"}},{"type":"condition","condition":{"column":"waiting_lines_count","operator":"greater_than","value":0}}]}. Filters on unknown columns are ignored rather than rejected.

Sorts: waiting_lines_count (alias waiting_lines), last_seen_at, first_seen_at, configured_sku, id. Default -waiting_lines_count.

Pagination: page, per_page (default 10, max 500).

Response: a standard paginated list plus status_counts — totals per status (all, needs_mapping, mapped, created, auto_matched, uses_base), narrowed only by filter[sales_channel_id] — and option_rules_count, how many configured SKUs the saved option rules affect (the filter[option_rules]=1 total).

Row fields: status is derived (a row whose mapped product was archived reads needs_mapping with product.archived = true); waiting_lines_count is open lines held without a product; waiting_lines_blocked_reason is set (Mapped to a bundle — replace waiting lines manually) when those lines can't be linked automatically, otherwise null; base_product_open_lines_count is open lines booked to the base product that still have units to ship and could move to the mapped product (see Re-link Open Lines; fully shipped lines are not counted); orders_count is distinct sales orders carrying the SKU; blocked_orders_count is channel orders held back from import because the connection requires mapped products; base_sales_channel_listing_id is the channel listing ID (for Shopify, the variant ID) the configured SKU was first sold as, or null when it is not known; exact_match_product is an unarchived product whose SKU equals the configured SKU (a one-click map suggestion); needs_recipe is true when the mapped product has no active recipe (bill of materials).

  • addon_price_total (number|null) — the sum of every option add-on price (e.g. "+ $8.00") stored on this configured SKU's earliest priced order line, hidden options included; null when none was recorded (add-ons are only recorded when "Strip price add-on text" is on).
  • addon_currency_code (string|null) — the currency the add-on was charged in (the order's, else the tenant default). Create's base + add-ons price mode adds it only to tiers in this currency; null when addon_price_total is null.

Uses base product: status uses_base (with created_via base_product when set by hand with Use Base Product, or option_rule when an option rule set it at import or Re-scan) means the configured SKU stands for its own base product: product is the base product, and its lines on the base are where they belong, so base_product_open_lines_count is 0 and has_base_lines never matches it.

Option rules: option_rules_effect is what the saved option rules (Settings → Line Options) do to the configured SKU: uses_base (its lines go on the base product; a configured SKU that already has another product is never changed), ignores (some of its options are ignored, so they no longer print) or null. filter[option_rules]=1 lists only the configured SKUs with an effect, =0 the rest.

Request​

Responses​

OK

Response Headers
    Content-Type