commerce/channelgroups

Use the Channel Groups resource to manage groups of channels with common information.

JSON Example

ChannelGroup Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

code

type: string

The unique identifier of the object.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

tenantId

type: int

Unique identifier for the tenant.

Operations

Operation Name Request URI Description
CreateChannelGroup POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new group of channels with common information.

DeleteChannelGroup DELETE %7bcode%7d

Deletes a defined group of channels, which removes the group association with each channel in the group but does not delete the channel definitions themselves.

GetChannelGroup GET %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a defined channel group.

GetChannelGroups GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of defined channel groups according to any filter and sort criteria specified in the request.

UpdateChannelGroup PUT %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of a defined channel group.