Update Product Scorecard Settings

PUT 
/api/reporting/products/scorecard-settings

Updates the tenant's product scorecard configuration.

Required scope: reports:write

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

Authentication: Requires Bearer token (scope: reports)

Request body (all fields required):

• weights: object — a numeric weight (0–100) for each of the six dimensions (gross_margin, gmroi, sales_growth, sell_through, stock_cover, return_rate). The six weights must sum to exactly 100.
• thresholds: object — for each dimension, an array of at least one band; each band has a numeric min and an integer score between 1 and 5.
• min_so_count: integer — minimum sales-order count before a product is scored (at least 1).

Request

Responses

200

OK

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

Unprocessable Entity

Response Headers

Content-Type

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.