On this page
commissionEntryList
query · in the family Reading your records
What it does
The commission ledger — what staff earned, entry by entry.
from/to are the half-open period bounds over createdAt (UTC ISO-8601). 'nextToken' = the prior page's cursor. Requires authentication; tenant-scoped server-side.
What happens
Reads only.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:commissionEntryList
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
agentUserId | ID | no | No further notes. |
from | String | no | No further notes. |
to | String | no | No further notes. |
limit | Int | no | How many records to answer at most; a page may hold fewer. |
nextToken | String | no | The cursor from the previous page, passed back exactly as received. |
Returns
CommissionEntryPage CommissionEntryPage! — One commissionEntryList page.
This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.
Example request
query ExampleCommissionEntryList($agentUserId: ID) {
commissionEntryList(agentUserId: $agentUserId) {
items {
id
parentId
entryType
entryClass
amountMinor
currency
configId
orderId
returnId
caption
createdAt
}
nextToken
}
}Variables:
{
"agentUserId": "01900000-0000-7000-8000-640b76dc0000"
}Example response
{
"data": {
"commissionEntryList": {
"items": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"parentId": "01900000-0000-7000-8000-065235280000",
"entryType": "earn",
"entryClass": "attributed",
"amountMinor": 1,
"currency": "USD",
"configId": "01900000-0000-7000-8000-bfbd59aa0000",
"orderId": "01900000-0000-7000-8000-f6d8263a0000",
"returnId": "01900000-0000-7000-8000-4d4c03d20000",
"caption": "Blue jeans",
"createdAt": "2027-01-31T00:00:00.000Z"
}
],
"nextToken": "<the cursor from the previous page>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)