V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Retrieve a paginated list of SKU-level commission overrides. These overrides take precedence over vendor-level commission rates when calculating payouts. Both merchant and vendor tokens are accepted.
Use Cases
- Review SKU overrides before a payout run
- Search commissions by SKU or product for auditing
- Sync commission data to an external accounting system
Query Parameters
Filter by SKU (partial match supported).
Filter by product ObjectId.
Search across SKU and product title (max 200 characters).
Number of items to return, forward pagination (1–100).
Cursor for forward pagination.
Number of items to return, backward pagination (1–100).
Cursor for backward pagination.
Response
{
"success": true,
"data": {
"edges": [
{
"node": {
"sku": "WP-LG-BL",
"rate": 10,
"type": "percentage",
"productId": "507f1f77bcf86cd799439050"
},
"cursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MCJ9"
},
{
"node": {
"sku": "WP-SM-RD",
"rate": 3.50,
"type": "flat",
"productId": "507f1f77bcf86cd799439051"
},
"cursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MSJ9"
}
],
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MCJ9",
"endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MSJ9"
}
}
}
Example
curl -X GET "https://api.puppetvendors.com/v2/commissions/sku?sku=WP&first=20" \
-H "x-access-token: YOUR_JWT_TOKEN"