v50

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

Upsert sales channel mapping

This endpoint allows the marketplace to map its trade policies with a seller's affiliate. A seller can have multiple trade policies associated with the same marketplace, creating different affiliates. The mapping allows the seller to segment catalog, pricing, inventory, logistics, and payments in the marketplace.

Permissions

Any user or API key must have at least one of the appropriate License Manager capabilities in order to successfully execute this request. Otherwise, they will receive a 403 status code error. These are the applicable capabilities for this endpoint:

ProductCategoryResource
Seller RegisterSeller AdministrationSave seller

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

RoleResource
Seller ManagerSave Seller

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

put/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.

Request body

marketplaceSalesChannelinteger required

The sales channel of the marketplace to be associated with the seller's affiliate. It is linked to the seller's affiliate.

sellerChannelstring required

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

Example request

[
  {
    "marketplaceSalesChannel": 1,
    "sellerChannel": "GCB"
  },
  {
    "marketplaceSalesChannel": 2,
    "sellerChannel": "DFT"
  }
]

Response

OK

marketplaceSalesChannelstring

Marketplace's trade policy that will be associated to the seller's affiliate.

sellerChannelstring

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