Inventory Manager API · commissions
Set the catalogs a group's reps see and sell from
PUT /commission-groups/{groupId}/catalogs
Set the catalogs a group's reps see and sell from: all (every catalog, a new one too), or listed with exactly the catalogs named (an empty list is none).
A rep bound by their group (a sales role, neither an owner, an admin nor a holder of commissions:read) creates, quotes, edits and places orders only from these, and lists only these. Appends inventory.commission-group-catalogs-set. Idempotent by content: a retry naming the same catalogs 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 naming the same catalogs is acknowledged and appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
inventory.commission-group-catalogs-set
What a fact is: Facts and the journal.
AI agent tool
Agents call this as commissions_set_group_catalogs (Commissions: Set group catalogs), in the commissions toolset.
Connecting an agent: AI agents.
Example
Gold sells from the wholesale catalog only.
curl -X PUT 'https://inventory.getmanifold.io/commission-groups/cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40/catalogs' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"catalogs": {
"_tag": "listed",
"catalogIds": [
"cat_019e394f-ed80-7da2-823a-3ff13eb84f30"
]
}
}'const response = await fetch("https://inventory.getmanifold.io/commission-groups/cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40/catalogs", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"catalogs": {
"_tag": "listed",
"catalogIds": [
"cat_019e394f-ed80-7da2-823a-3ff13eb84f30"
]
}
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"catalogs": {
"_tag": "listed",
"catalogIds": [
"cat_019e394f-ed80-7da2-823a-3ff13eb84f30"
]
}
}{
"id": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"name": "Gold",
"baseRateBps": 500,
"description": "Senior wholesale reps",
"catalogs": {
"_tag": "listed",
"catalogIds": [
"cat_019e394f-ed80-7da2-823a-3ff13eb84f30"
]
},
"archived": false
}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 |
|---|---|---|
CommissionGroupNotFound groupId | No such record in this organization. | Check the id in the path or the body. |
CatalogNotFound catalogId | No such record in this organization. | Check the id in the path or the body. |
409
| Refusal | What it means | What to do |
|---|---|---|
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 6: Let the group's reps sell from that catalog only