Bulk Import Product Rules
POST/api/admin/portal/catalogs/:catalog/rules/bulk
Bulk-add product include/exclude rules. Products can be supplied by SKU and/or by product id; at least one of the two is required. Each SKU is matched to a product; matched products that don't already carry a rule of this type are added. Returns a summary of how many rules were added, how many were skipped as duplicates, and which SKUs matched no product.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- rule_type (required): one of include_product, exclude_product. Category / brand rules are not supported here.
- skus (required without product_ids): array of up to 5,000 SKU strings.
- product_ids (required without skus): array of up to 5,000 product ids.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
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.