Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Sales channel

Get sales channel by ID

Retrieves a specific sales channel by its ID.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Catalog APIGeneralView Product

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog_system/pub/saleschannel/{salesChannelId}

Path parameters

salesChannelIdstring required
Example:1

Sales channel ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Idinteger

Sales channel unique identifier.

Namestring

Sales channel name.

IsActiveboolean

Defines if the sales channel is active (true) or not (false).

ProductClusterIdinteger nullable

Product cluster ID, if the sales channel has releated product cluster.

CountryCodestring

Country code in ISO 3166-1 alfa-3 standard.

CultureInfostring

Language country code in LCID string standard.

TimeZonestring

Name of time zone.

CurrencyCodestring nullable

Currency code in ISO 4217 standard.

CurrencySymbolstring

Currency symbol.

CurrencyLocaleinteger

Currency locale code in LCID standard.

Originstring nullable

Origin of products in the sales channel.

Positioninteger nullable

Defines the position on index.

ConditionRulestring nullable

Defines what is the conditional rule to activate de Sales channel.

CurrencyDecimalDigitsinteger

Quantity of currency decimal digits.