commerce/channels

Use the Channels resource to manage the channels a company uses to create logical commercial business divisions based on region or types of sales, such as "US Online," "Amazon," or "EMEA Retail." All orders include a channel association that enables the company to perform financial reporting for each defined channel. Because channels are managed at the tenant level, you must associate all the tenant's sites with a channel. Sites that do not have a defined channel association cannot successfully submit orders.

JSON Example

Channel 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.

countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

groupCode

type: string

User-defined code that identifies the channel group.

name

type: string

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

region

type: string

The geographical region associated with this channel. This region could represent any geographical entity from a state to a continent.

siteIds

type: list of int

Array list of site identifiers associated with this channel. Each tenant site must have a channel association.

tenantId

type: int

Unique identifier for the tenant.

Operations

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

Creates a new channel that defines a new logical business division to use for financial reporting.

DeleteChannel DELETE %7bcode%7d

Deletes a defined channel for the tenant and removes the defined site associations. After deleting this channel, assign its associated sites to another channel.

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

Retrieves the details of the channel specified in the request.

GetChannels 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 channels defined for a tenant according to any filter or sort criteria specified in the request.

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

Updates one or more details of a defined channel, including the associated sites.