Create Decoration Cost Rule

POST 
/api/decoration-cost-rules

Create a new decoration cost rule.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Required: name, priority, is_active, conditions (object), effect (object). effect.type must be one of fixed, per_unit, rate_x_metric, minimum, flag_loss. effect.metric (when present) must be one of stitch_count, ink_colors_count, area_sq_in. conditions.method, conditions.placement, conditions.setup_type must be valid enum values when present. conditions.product_id / conditions.customer_id and effect.cost_category_id must reference existing records.

Requires permission: sales_orders.update.

Authentication: Requires Bearer token.

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.