v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-201720164.6 KB
Multiple product specification mapping

Map seller specifications to marketplace catalog

This endpoint allows the seller to perform a bulk mapping of product specifications to the marketplace catalog.

Specifications are additional properties that can be registered on products. To ensure this information is correctly interpreted, the marketplace must map the seller specifications to the corresponding fields in its own catalog.

⚠️ This process ensures that products sent by the seller contain data that matches the marketplace's catalog. Sending a new item without prior mapping does not override existing values. Adding new specifications must follow the instructions in the Mapping categories, brands, and specifications for the marketplace guide. The mapping must be done based on specifications that already exist in the marketplace's catalog.

All differing specifications must be mapped, even if the only difference is the capitalization of the word.

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
CatalogContentProduct and SKU Management

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.

put/suggestions/configuration/{sellerID}/specifications

Path parameters

accountNamestring required
Example:marketplaceexample

Name of the VTEX account. Used as part of the URL

sellerIDstring required
Example:seller123

Marketplace seller ID whose specifications will be mapped

Headers

Content-Typestring required

Describes the type of the content being sent.

Acceptstring required

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

Request body

object required

Key-value pairs where the key is the seller's specification name and the value is the equivalent specification in the marketplace.

Response

OK