Inventory Manager API · commissions
Set a catalog's commission rule for one SKU
PUT /catalogs/{catalogId}/commission/{sku}
Set a catalog's commission rule for one SKU: uncommissionable (no group earns on it), or rates naming each group's rate in basis points — a group not named earns its base rate.
The rule replaces whatever the SKU inherited from the catalog's base. Appends inventory.catalog-commission-set. Idempotent by content: a retry setting the same rule is acknowledged and appends nothing.
Access
Requires commissions:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by content: a retry setting the same rule is acknowledged and appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
inventory.catalog-commission-set
What a fact is: Facts and the journal.
AI agent tool
Agents call this as commissions_set_catalog_rule (Commissions: Set catalog rule), in the commissions toolset.
Connecting an agent: AI agents.
Example
Gold earns 8% on the blue widget sold wholesale.
curl -X PUT 'https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30/commission/WIDGET-BLUE' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"rule": {
"_tag": "rates",
"groups": [
{
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"rateBps": 800
}
]
}
}'const response = await fetch("https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30/commission/WIDGET-BLUE", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"rule": {
"_tag": "rates",
"groups": [
{
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"rateBps": 800
}
]
}
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"rule": {
"_tag": "rates",
"groups": [
{
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"rateBps": 800
}
]
}
}{
"catalogId": "cat_019e394f-ed80-7da2-823a-3ff13eb84f30",
"rules": [
{
"sku": "WIDGET-BLUE",
"rule": {
"_tag": "rates",
"groups": [
{
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"rateBps": 800
}
]
}
}
],
"inheritsFrom": "cat_019cadd3-8524-7934-9ee3-29b896f71f80"
}The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web
page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.
Errors
Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.
401
| Refusal | What it means | What to do |
|---|---|---|
Unauthorized reason | The token is missing, expired or not one Manifold issued. | Get a fresh token and send the call again. |
TokenAlreadyUsed tokenId | A single-use app token was already spent. | Mint a new token for this call. |
402
| Refusal | What it means | What to do |
|---|---|---|
SubscriptionRequired status | The organization's subscription has lapsed, so writes are refused. | An owner settles billing. Reads still work meanwhile. |
403
| Refusal | What it means | What to do |
|---|---|---|
TenantRequired userId | The token names no organization. | Choose the organization, then get a new token. |
ScopeRequired required | The token's roles do not grant the scope this call needs. | Ask an owner or admin for a role that grants it. |
404
| Refusal | What it means | What to do |
|---|---|---|
CatalogNotFound catalogId | No such record in this organization. | Check the id in the path or the body. |
CommissionGroupNotFound groupId | No such record in this organization. | Check the id in the path or the body. |
409
| Refusal | What it means | What to do |
|---|---|---|
CatalogArchived catalogId | The catalog is archived, and an archived catalog takes no changes. | Use an active catalog. |
CommissionGroupArchived groupId | The request was refused, and nothing changed. | Nothing changed. Read the record, then decide. |
MirroredFromSource source | This area is fed by your source system until the organization goes live. | Make the change in the source system, or go live first. |
503
| Refusal | What it means | What to do |
|---|---|---|
RequestLogUnavailable tokenId, reason | The service could not record the request, so it did nothing. | Send the same request again shortly. |
How refusals work everywhere: Errors.
Used in
- Pay reps commission, step 5: Give the SKU its own rate for the group