api
sales-channels

Get all sales channel groups

get/api/sales-channels/groups

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/sales-channels/groups
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

statusstring[]

Filter sales channel groups by status

namestring

Filter sales channel groups by name

includeDefaultGroupsboolean

Whether default groups should be included

topinteger

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

skipinteger

The number of objects to skip for the requested result

Response

OK

namestring required

The name of the sales channel group

status'ACTIVE' | 'INACTIVE' required

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

salesChannelIdsstring[]

The sales channels that are in the group

restrictEventAccessboolean required

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

_idstring required

The ID of the sales channel group

sellerIdstring required

The ID of the seller of the sales channel group

createdAtstring date-time

An ISO timestamp indicating when the sales channel group was created

updatedAtstring date-time

An ISO timestamp indicating when the sales channel group was updated

Changes

No recorded changes to this operation across all 48 revisions of this API.