v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-201720164.6 KB
SKU approval settings

Save seller's approval settings

Marketplaces use this endpoint to create or update approval settings to a specific seller, on the Received SKUs module.

The request includes all the details necessary to implement the chosen approval settings.

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
ChannelsUI resourcesSave suggestion rules
SuggestionSuggestion resourcesMain access

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/seller/{sellerId}

Path parameters

accountNamestring required
Example:apiexamples

Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.

sellerIdstring required
Example:seller123

A string that identifies the seller in the marketplace. This ID must be created by the marketplace.

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

sellerIdstring required

A string that identifies the seller in the marketplace. This ID must be created by the marketplace.

mappingobject nullable required

Mapping of SKU and product Specifications. This object should be sent in the following format for all fields you wish to map:

{specificationName}:{specificationValue},

Example:

Choose voltage: Voltage,

Choose size: Size.

matchFluxstring required

This field determines the type of approval configuration applied to SKUs received from a seller. The possible values include:

  • default where the Matcher reviews the SKU, and approves it based on its score

  • manual for manual approvals through the Received SKU UI or Match API

  • autoApprove for every SKU received from a given seller to be approved automatically, regardless of the Matcher Score.

Example request

{
  "sellerId": "seller123",
  "mapping": {
    "Choose voltage": "Voltage",
    "Choose size": "Size",
    "Choose volume": "Volume",
    "Choose type": "Type"
  },
  "matchFlux": "autoApprove"
}

Response

OK