Sign in
Organisations

Create a Sales Channel

Create a new sales channel against the given organisation. The channel becomes immediately available for tagging orders, appointments, and other revenue-bearing records across every site under the organisation.

post/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.

Request body

namestring required

Display name of the sales channel, shown in pickers across the admin UI and on reports that break revenue down by channel.

Example request

{
  "name": "Front Desk"
}

Response

The sales channel was successfully retrieved.

Example response

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Front Desk",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.