Use Base Product for Configurable Product
POST/api/configurable-products/:id/use-base-product
Say a configured SKU is just its base product ("This is just the base product"): its options don't change what is picked, packed or made — for example a binding edge chosen with no punching pattern. The configured SKU is mapped to the base product the channel sent, with status uses_base and created_via base_product.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Future order lines carrying the configured SKU are booked to the base product. Lines already on the base product are settled: they are not counted as lines on the base product to move, and Re-link has nothing to do. Lines on any other product are never changed. Undo it with Delete Configurable Product Mapping, or map or create another product.
Authentication: Requires Bearer token (scope products:write) and the permission to create products.
Body:
relink_waiting_lines(boolean, optional, default true) — also link the order lines waiting with no product to the base product (in the background);relinked_linesis how many were queued.
Response: the updated configured SKU (data) and relinked_lines.
Returns 422 when no base product is recorded for the configured SKU (map the channel listing to its base product first) or the base product is archived, 404 when the configured SKU does not exist or line options are switched off.
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.