Skip to main content

Get Configurable Product

GET 

/api/configurable-products/:id

Get one configured SKU with everything needed to decide its 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 the same fields as the list, plus:

  • options — every option on the first order line seen with this configured SKU, including hidden ones (hidden: true, with hidden_by naming the hide rule), ones an option rule ignores (ignored: true, hidden: true, ignored_by naming the rule, e.g. "If Punching Pattern is empty → ignore Punching Edge") and the configured SKU option itself (is_identity: true). raw_name is the name as the channel sent it.
  • blocked_orders — channel orders held back from import because the connection requires mapped products (shopify_order_id, name, created_at), newest first, last 180 days.
  • waiting_lines — paginated open order lines held without a product (data, total, current_page, last_page, per_page).
  • base_product_lines — paginated open order lines booked to the base product that still have units to ship (fully shipped lines are history and not listed), plus eligible_count / blocked_count across every page (how many Re-link Open Lines moves and leaves). Each carries relinkable and, when false, why — see Blocked lines below.
  • order_lines — the 10 most recent order lines carrying this configured SKU.

Returns 404 when the configured SKU does not exist or line options are switched off.

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

A configured SKU with status uses_base has no base product lines to move: base_product_lines is empty with eligible_count and blocked_count 0.

Request​

Responses​

OK

Response Headers
    Content-Type