Bulk Create Products from Configurable Products
POST/api/configurable-products/bulk-create
Create products for several configured SKUs at once, each with the configured SKU as its SKU. One row failing never stops the rest.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope products:write). Moving open order lines (relink_open_lines) also needs the orders:write scope and permission to update sales orders; without them the products are still created and the lines stay where they are, with the reason in each row's message.
Body:
ids(integer[], required, 1–2,000, distinct) — configured SKU IDs. Selecting every row that matches a filter: send the matching IDs inids, at most 2,000 per request; split a larger selection into several requests.name_overrides(object, optional) — product name per configured SKU ID, e.g.{"42": "Black cover, 3:1 wire, long edge"}. IDs without an override get<base product name> — <visible option values>.copy_from_base_product(boolean, optional, default true).relink_waiting_lines(boolean, optional, default true) — attach order lines held without a product (waiting for this configured SKU) to the new product.relink_open_lines(boolean, optional, default true) — also move open order lines still booked to the base product onto the new product. Only lines that are safe to move are moved (the same rules as Re-link Open Lines to Mapped Product); the order total and tax stay exactly as the channel charged.recipe(object, optional) — also create the product's recipe (bill of materials), using the base product as its single component, and activate it as the default:recipe.create(boolean) — must be true to build a recipe.recipe.component_quantity(number > 0, max 1,000,000, default 1) — base product quantity per unit.recipe.operations[](max 50) — steps from the operations library:operation_template_id(integer, required) andoption_names(string[], max 50, optional) — the line option names the step shows on its manufacturing orders (for examplePunching Pattern).recipe.operations_by_option_value[](max 200) — steps added only when the configured SKU's options carry a given value:option_name(string, required),option_value(string, required),operation_template_id(integer, required). The step shows that option on its manufacturing orders.
apply_to_all,filters(optional) — accepted but ignored;idsdecides what is created.
Response:
- Up to 25 IDs: 200 with
results[]— one row per ID:id,configured_sku,outcome(created,skippedwhen the SKU already exists or the row is already mapped,failed),product_id,message,bom_id, plus the open-line move counts:lines_moved,lines_skippedandlines_skipped_reasons(reason → count, lines left on the base product because moving them isn't safe),lines_failedandlines_failed_reasons(lines whose move raised an error), andlines_move_failed(true when the move could not run at all). Retry leftover lines with Re-link Open Lines to Mapped Product. - More than 25 IDs: 202 with
tracked_job_id(also indata.tracked_job_log_id). The products are created by a background job; follow it with the tracked jobs endpoints. Its results carrysummary,has_failures/failed_count(rows that failed to create plus rows whose line moves failed),errors[]andwarnings[].
Returns 404 while line options are switched off.
Copy from base:
copy_fields(array, optional) — which base-product details to copy, from:brand,product_type,category,unit_of_measure,weight_dimensions,tax,accounting_codes,suppliers,images,tags_attributes,price. Omitted → the tenant'sline_options.copy_from_basesetting. An empty array copies nothing.price_mode(string, optional) —baseorbase_plus_addons(base tier prices plus the option add-on prices recorded on the configured SKU's first order line; falls back to the base price when none was recorded). Omitted → thecopy_price_modesetting. Only used whencopy_fieldsincludesprice.copy_from_base_productstill works:falsecopies nothing;trueor omitted usescopy_fields/ the settings.- Suppliers copy with lead time, minimums, default flag, tax rate and tier costs; the supplier SKU is left blank. Images stored by SKU.io are duplicated; outside-URL images are shared.
Request
Responses
- 200
- 202
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Accepted
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.