Bulk Set Product Numeral Tax Category
PUT/api/products/bulk/numeral-category
Set — or reset to the default — the Numeral sales-tax category on many products at once, by ID list or by the same filter[...] query List Products accepts (send the filter keys without the filter[] wrapper, as filters). One of the two must be sent.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Up to 500 products are updated immediately (mode: "sync", HTTP 200). A larger selection runs as a background job (mode: "job", HTTP 202); a filter is resolved to a fixed list of product IDs when the request is made.
Request body:
- numeral_product_category (string|null, required — the key must be present): a
codefrom List Numeral Product Categories, or null to reset the products to the Numeral connection's default category - product_ids (array of integers, optional, max 100000): the products to update; IDs that are not products are ignored
- filters (object, optional;
filteris accepted too): the product list filters to resolve into products
Response data:
- mode (string): sync or job
- total (integer): products targeted
- updated (integer|null): products whose category changed (null when queued)
- tracked_job_log_id (integer|null): the background job to follow (null when applied immediately)
Authentication: Requires Bearer token. Requires the products.update permission (API tokens: products:write scope).
Request
Responses
- 200
- 202
- 401
- 403
- 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.
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.