Organisations
List Sales Channels
Returns a paginated list of every sales channel that belongs to the organisation, ordered by their stored display order then by name. Sales channels are used to label the source of a sale (e.g. "Front Desk", "Phone", "Website") so revenue can be broken down by channel on reports.
get/shop/organisations/{organisationId}/sales-channels
Path parameters
organisationIdstring uuid required
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
Query parameters
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The sales channels were successfully retrieved.
Example response
{
"data": [
{
"id": "6630f7a8e1a4c2b1d4d5e7c1",
"name": "Front Desk",
"organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
}
],
"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"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.