Skip to main content
GET
/
v2
/
commissions
/
vendor
List Vendor Commissions
curl --request GET \
  --url https://api.puppetvendors.com/v2/commissions/vendor \
  --header 'x-access-token: <api-key>'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve a paginated list of commission rates configured at the vendor level. Both merchant and vendor tokens are accepted. Vendor tokens are automatically scoped to the authenticated vendor’s own commission record.

​
Use Cases

  • Audit commission structures across all vendors
  • Display vendor-specific rates in a self-service portal
  • Export commission data for accounting reconciliation

​
Query Parameters

​
first
integer
Number of items to return, forward pagination (1–100).
​
after
string
Cursor for forward pagination.
​
last
integer
Number of items to return, backward pagination (1–100).
​
before
string
Cursor for backward pagination.

​
Response

200
{
  "success": true,
  "data": {
    "edges": [
      {
        "node": {
          "vendorId": "507f1f77bcf86cd799439011",
          "vendorName": "Acme Supplies",
          "commissionType": "percentage",
          "commissionAmount": 14
        },
        "cursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
      },
      {
        "node": {
          "vendorId": "507f1f77bcf86cd799439012",
          "vendorName": "Widgets Co",
          "commissionType": "flat",
          "commissionAmount": 5.00
        },
        "cursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMiJ9"
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": false,
      "startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9",
      "endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMiJ9"
    }
  }
}

​
Example

curl -X GET "https://api.puppetvendors.com/v2/commissions/vendor?first=20" \
  -H "x-access-token: YOUR_JWT_TOKEN"