Get Channels

get https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/channels

Retrieves a list of channels according to any specified filter criteria and sort options. 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.

Query Params

startIndex

int32

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin.
For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=50. The default value is 0. Optional.

pageSize

int32

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

sortBy

string

The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional.

filter

string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals,
gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

responseFields

string

limits which fields are returned in the response body

Response

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/channels \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success