v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-201720164.6 KB

SKU approval settings

Save account's approval settings

Marketplaces use this endpoint to create or update approval settings on their 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:

Product	Category	Resource
Channels	UI resources	Save suggestion rules
Suggestion	Suggestion resources	Main 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

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.

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

SpecificationsMappingstring[] required

This attribute maps product and SKU specifications.

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

{
  "Score": {
    "Approve": 80,
    "Reject": 30
  },
  "Matchers": [
    {
      "MatcherId": "vtex-matcher",
      "hook-base-address": "http://simple-suggestion-matcher.vtex.com.br",
      "IsActive": true,
      "UpdatesNotificationEndpoint": "https://example.com/notification-endpoint",
      "Description": "This approval is for the new product batch from supplier X."
    }
  ],
  "SpecificationsMapping": [
    "color=red"
  ],
  "MatchFlux": "autoApprove"
}

Response

MatchFluxstring

Type of approval configuration that apply to received SKUs sent by sellers. The possible values are:

default: The matcher approves the SKU.

manual: Manual SKU's approvals.

AutoApprove: Automatic SKU's approvals.