CommissionPackages
List UserCommissionAssignments
Use this endpoint to retrieve a list of UserCommissionAssignments, optionally filtered by site or user. Each assignment attaches a CommissionPackage to a plain User at a site, for staff who earn commission but aren't modelled as a Practitioner.
get/shop/user-commission-assignments
Query parameters
site_idstring
Filter results by the site they belong to
user_idstring uuid
Restrict results to assignments for a single user.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The UserCommissionAssignments were successfully retrieved.
Example response
{
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}