Skip to main content

Bulk create products

API operation: Open the endpoint in the API reference

Use POST /bulks/products to create products in one administrative request. The current public operation is ProductBulk.register and requires administrator or business-manager authentication.

The request field products carries a JSON-encoded array. Each item requires name, price, category_id, and business_id in the operation rules.

{
"products": "[{\"name\":\"Example product\",\"price\":12,\"category_id\":272,\"business_id\":41}]"
}

If available, the operation supports up to 1,000 products across at most five businesses. A business manager can target only owned businesses, and every category must belong to the stated business. The operation validates the collection before creating records; treat any failure as a failed batch and check the response before continuing.

Fields whose names begin with metafield_ are converted into product metafields during bulk creation. For example, metafield_color creates the metafield key color. Use only synthetic values in examples and confirm the full request schema in the API reference.

OpenAPI reference​

Operation: POST /bulks/products

Request body fields

NameTypeRequired
productsstringYes

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference