Sales Channels

Endpoints

The sales channel object

Attributes

_id

Required

string

The ID of the sales channel

sellerId

Required

string

The ID of the seller of the sales channel

name

Required

string

The name of the sales channel

status

Required

string

The status of the object, whether it is active or not

ACTIVEINACTIVE

type

Required

string

The type of the sales channel

POSDISTRIBUTORINTERNAL_BOOKINGWEBMARKETPLACE_APP

Optional Attributes

Collapse all

createdAt

Optional

string date-time

An ISO timestamp indicating when the sales channel was created

updatedAt

Optional

string date-time

An ISO timestamp indicating when the sales channel was updated

groupId

Optional

string

The group of the sales channel

owner

Optional

string

The app owner id, if the channel was created by a marketplace app

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "name": "string",
  "status": "ACTIVE",
  "type": "POS",
  "groupId": "string",
  "owner": "string"
}

Create a sales channel

Payload

One of

Only one of the following types

name

Required

string

The name of the sales channel

status

Required

string

The status of the object, whether it is active or not

ACTIVEINACTIVE

type

Required

string

DISTRIBUTOR

Optional Attributes

Collapse all

groupId

Optional

string

The group of the sales channel

distributor

Optional

object

distributor.type

Required

string

The type of the sales channel

RedeamGetYourGuideLogitixEventDynamicStubHubTicketmasterFrance

distributor.integrationType

Required

string

The integration type of the sales channel

DistributionServiceLogitixEventDynamicStubHubTicketmasterFrance

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "type": "DISTRIBUTOR",
  "groupId": "string",
  "distributor": {
    "type": "Redeam",
    "integrationType": "DistributionService"
  }
}

{
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "name": "string",
  "status": "ACTIVE",
  "type": "POS",
  "groupId": "string",
  "owner": "string"
}

Update a sales channel

Payload

One of

Only one of the following types

name

Required

string

The name of the sales channel

status

Required

string

The status of the object, whether it is active or not

ACTIVEINACTIVE

type

Required

string

DISTRIBUTOR

Optional Attributes

Collapse all

groupId

Optional

string

The group of the sales channel

distributor

Optional

object

distributor.type

Required

string

The type of the sales channel

RedeamGetYourGuideLogitixEventDynamicStubHubTicketmasterFrance

distributor.integrationType

Required

string

The integration type of the sales channel

DistributionServiceLogitixEventDynamicStubHubTicketmasterFrance

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "type": "DISTRIBUTOR",
  "groupId": "string",
  "distributor": {
    "type": "Redeam",
    "integrationType": "DistributionService"
  }
}

{
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "name": "string",
  "status": "ACTIVE",
  "type": "POS",
  "groupId": "string",
  "owner": "string"
}

Get a SalesChannel

Query

sellerId

Optional

string

The ID of the seller

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "name": "string",
  "status": "ACTIVE",
  "type": "POS",
  "groupId": "string",
  "owner": "string"
}

Get all sales channels

Query

status

Optional

array<string>

Filter sales channels by status

name

Optional

string

Filter sales channels by name

type

Optional

array<string>

Filter sales channels by type

permissions

Optional

array<string>

Filter sales channnels by permissions

groupIds

Optional

array<string>

sellerId

Optional

string

The ID of the seller

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "name": "string",
  "status": "ACTIVE",
  "type": "POS",
  "groupId": "string",
  "owner": "string"
}

The sales channel group object

Attributes

name

Required

string

The name of the sales channel group

status

Required

string

The status of the sales channel group, whether it is active or not

ACTIVEINACTIVE

restrictEventAccess

Required

boolean

Wether channels in this group can only access some events or all

_id

Required

string

The ID of the sales channel group

sellerId

Required

string

The ID of the seller of the sales channel group

Optional Attributes

Collapse all

salesChannelIds

Optional

array<string>

The sales channels that are in the group

createdAt

Optional

string date-time

An ISO timestamp indicating when the sales channel group was created

updatedAt

Optional

string date-time

An ISO timestamp indicating when the sales channel group was updated

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true,
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a sales channel group

Payload

name

Required

string

The name of the sales channel group

status

Required

string

The status of the sales channel group, whether it is active or not

ACTIVEINACTIVE

restrictEventAccess

Required

boolean

Wether channels in this group can only access some events or all

Optional Attributes

Collapse all

salesChannelIds

Optional

array<string>

The sales channels that are in the group

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true
}

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true,
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a sales channel group

Payload

name

Required

string

The name of the sales channel group

status

Required

string

The status of the sales channel group, whether it is active or not

ACTIVEINACTIVE

restrictEventAccess

Required

boolean

Wether channels in this group can only access some events or all

Optional Attributes

Collapse all

salesChannelIds

Optional

array<string>

The sales channels that are in the group

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true
}

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true,
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a SalesChannelGroup

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true,
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all sales channel groups

Query

status

Optional

array<string>

Filter sales channel groups by status

name

Optional

string

Filter sales channel groups by name

includeDefaultGroups

Optional

boolean

Whether default groups should be included

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "status": "ACTIVE",
  "salesChannelIds": [
    "string"
  ],
  "restrictEventAccess": true,
  "_id": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}