Sign in

v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-201720164.6 KB
Match received SKUs

Match received SKUs individually

All SKUs sent from a seller to a marketplace must be reviewed and matched. Actions in the matching process are added in the request body through the [matchType] object. Match type actions include:

  1. newproduct: Match the SKU as a new product.

  2. itemMatch: Associate the received SKU to an existing SKU.

  3. productMatch: Associate the received SKU to an existing product.

  4. deny: Deny the received SKU.

  5. pending: The received SKU requires attention.

  6. incomplete: The received SKU is lacking information to be matched.

  7. insufficientScore: The Score given by the Matcher to this received SKU doesn't qualify it to be matched.

Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

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

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/{sellerId}/{sellerskuid}/versions/{version}/matches/{matchid}

Path parameters

accountNamestring required
Example:apiexamples

Name of the VTEX account. 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.

sellerskuidstring required
Example:1234

A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.

versionstring required
Example:09072021142808277

Whenever an SKU Suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions. This field is the versionId associated to the version you choose to search for. You can get this field's value through theGet SKU Suggestion by ID. through the latestVersionId field.

matchidstring required

Whenever an SKU suggestion is matched, it is associated to a unique ID. Fill in this field with the matchId you wish to filter by. The matchId's value can be obtained through the *Get SKU Suggestion by ID endpoint.

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

matcherIdstring required

Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by partners, for example. The matcherId's value can be obtained through the Get SKU Suggestion by ID endpoint.

matchTypestring required

Define the action you want to apply to each SKU. Values include:

  1. newproduct: match the SKU as a new product.

  2. itemMatch: associate the received SKU to an existing SKU.

  3. productMatch: associate the received SKU to an existing product.

  4. deny: deny the received SKU.

  5. pending: the received SKU requires attention.

  6. incomplete: the received SKU is lacking information to be matched.

  7. insufficientScore: the score given by the Matcher to this received SKU doesn't qualify it to be matched.

Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

scorestring required

Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of these scores determines whether the product has been:

Approved: score equal to or greater than 80 points.

Pending: from 31 to 79 points.

Denied: from 0 to 30 points.

Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

skuRefstring nullable

In itemMatch actions, fill in this field on your request to match the item to an existing SKU in the marketplace.

productRefstring nullable

In productMatch actions, fill in this field on your request to match the item to an existing product in the marketplace.

Example request

{
  "matcherId": "vtex-matcher",
  "score": "80",
  "matchType": "itemMatch",
  "skuRef": "12345-sku",
  "productRef": "67890-product",
  "product": {
    "name": "Product exemple",
    "description": "Descricption exemple",
    "categoryId": 12,
    "brandId": 1234567,
    "specifications": null
  },
  "sku": {
    "name": "Sku exemple",
    "eans": [
      "12345678901213"
    ],
    "refId": null,
    "height": 1,
    "width": 1,
    "length": 1,
    "weight": 1,
    "images": {
      "image1.jpg": "imageurl.example"
    },
    "unitMultiplier": 1,
    "measurementUnit": "un",
    "specifications": {
      "Packaging": "3 kg"
    }
  }
}

Response

OK

matchIdstring

Unique identifier for the match operation, which can be used for tracking and auditing purposes.

matcherIdstring

Identifier for the matcher entity that performed the match. It can represent VTEX's internal matcher or an external matcher service.

sellerIdstring

Unique identifier of the seller who owns the SKU being matched.

itemIdstring

Unique identifier of the item (SKU) that was processed during the match operation.

isSuccessboolean

Indicates whether the match operation was successful. A value of true means the operation succeeded, while false indicates a failure.