Set Product Revenue Mapping
PATCH/api/products/:product/revenue-mapping
Applies (or clears) a revenue-line mapping across every sales-channel listing of this product.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
When a listing carries a revenue mapping, future channel orders containing it create a revenue financial line on the order instead of a stock-consuming sales order line. Use this endpoint to apply that behaviour to a product everywhere it is sold; use the per-channel revenue-mapping endpoint to map a single listing.
Body fields:
- financial_line_type_id (required, nullable integer) — ID of an existing financial line type. It must have a revenue classification; non-revenue types are rejected with a 422. Pass null to clear the mapping from every listing of this product.
Returns the number of listings updated.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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.