v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-282624202.6 KB
Sales Channel Mapping

Get sales channel mapping data

Retrieves information about the mapping between marketplace's sales channels and a specific seller.

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
Seller RegisterSeller AdministrationView Seller

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Seller managerView Seller

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

get/seller-register/pvt/sellers/{sellerId}/sales-channel/mapping

Path parameters

accountNamestring required
Example:apiexamples

Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account.

environmentstring required

Environment to use. Used as part of the URL.

sellerIdstring required
Example:seller123

A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.

Query parameters

anstring required

Marketplace's account name, the same one inputted on the endpoint's path.

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

marketplaceSalesChannelstring

Marketplace's sales channel that will be associated to the seller's affiliate.

sellerChannelstring

Seller's affiliate that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channel will be used for the mapping.