Inventory Manager API · commissions
The terms an order is snapshotted under
GET /commissions/terms
The terms an order is snapshotted under: the settings, the earner's group (when userId names one) and, per catalog, whether that group sells from it and each SKU's rule up the catalog's chain of bases.
Fulfillment asks this as it creates, places and re-attributes an order.
Access
Requires commissions:read.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
AI agent tool
No agent tool. Fulfillment asks it under its own credential as it snapshots an order; an agent reads the rates on the order and the rules with commission_get_catalog_rules.
Connecting an agent: AI agents.
Example
curl -X GET 'https://inventory.getmanifold.io/commissions/terms?userId=usr_019e5a10-51b0-7a42-8c1d-0e9f3a6b2c71&catalogId=cat_019e394f-ed80-7da2-823a-3ff13eb84f30&sku=WIDGET-BLUE' \
-H "Authorization: Bearer $MANIFOLD_TOKEN"const response = await fetch("https://inventory.getmanifold.io/commissions/terms?userId=usr_019e5a10-51b0-7a42-8c1d-0e9f3a6b2c71&catalogId=cat_019e394f-ed80-7da2-823a-3ff13eb84f30&sku=WIDGET-BLUE", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"settings": {
"earnedOn": "invoiced",
"earner": "order-rep"
},
"rep": {
"userId": "usr_019e5a10-51b0-7a42-8c1d-0e9f3a6b2c71",
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"groupName": "Gold",
"baseRateBps": 500
},
"catalogs": [
{
"catalogId": "cat_019e394f-ed80-7da2-823a-3ff13eb84f30",
"open": true,
"rules": [
{
"sku": "WIDGET-BLUE",
"commission": {
"catalogId": "cat_019e394f-ed80-7da2-823a-3ff13eb84f30",
"rule": {
"_tag": "rates",
"groups": [
{
"groupId": "cgr_019e5a10-4c2a-7d11-9a3e-5b7c2d8e1f40",
"rateBps": 800
}
]
}
}
}
]
}
]
}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. |
409
| Refusal | What it means | What to do |
|---|---|---|
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. | Try again shortly. |
How refusals work everywhere: Errors.