v46

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

Manage suggestions

Send SKU suggestion

This request is used by the seller when it wants to suggest that one of their SKUs is sold in the marketplace.

Before using this request, the seller should always use the Change Notification request in order to check if the SKU already exists in the marketplace. If it doesn't, then this is the next call in the SKU integration flow.

In the Send Suggestion request, the seller must send information about the SKU, such as the product and SKU name, the seller ID, and the image URL. All parameters are explained below.

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	Send marketplace suggestion

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}

Path parameters

accountNamestring required

Example:apiexamples

Name of the VTEX account to which the seller wants to suggest a new SKU. It is used as part of the request 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 seller. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.

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

ProductNamestring required

Name of the suggested product. This field has a limit of 150 characters.

ProductIdstring required

Product ID in seller's account.

ProductDescriptionstring required

Product description containing the main information about the product (not the SKU).

BrandNamestring required

Name of the brand to which this SKU belongs. It must match the brand created in the marketplace.

SkuNamestring required

Name of the suggested SKU.

SellerIdstring required

ID of the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.

Heightinteger required

Height of the SKU.

Widthinteger required

Width of the SKU.

Lengthinteger required

Length of the SKU.

Weightinteger required

Weight of the SKU in grams.

RefIdstring required

SKU reference code. Mandotory if the EAN is not informed.

EANstring required

SKU reference code. Mandatory if the RefId is not informed.

SellerStockKeepingUnitIdinteger

ID of the SKU registered in the seller.

CategoryFullPathstring required

Full path to the SKU's category. It should be written as {department}/{category}. For example: if the department is Appliances and the category is Oven, the full path should be 'Appliances/Oven'.

MeasurementUnitstring

Measurement unit that should be used for this SKU. If this information doesn't apply, you should use the default value un.

UnitMultiplierinteger

Unit multiplier for this SKU. If this information doesn't apply, you should use the default value 1.

AvailableQuantityinteger required

The number of items currently available for sales.

Example request

{
  "ProductId": "321",
  "ProductName": "Product sample",
  "NameComplete": "My complete product name?",
  "ProductDescription": "sample",
  "BrandName": "Brand 1",
  "SkuName": "Sku sample",
  "SellerId": "123",
  "Height": 1,
  "Width": 1,
  "Length": 1,
  "Weight": 1,
  "Updated": null,
  "RefId": "REFID123",
  "SellerStockKeepingUnitId": 567,
  "CategoryFullPath": "Category 1",
  "Images": [
    {
      "imageName": "Principal",
      "imageUrl": "https://i.pinimg.com/originals/2d/96/4a/2d964a6bf37d9224d0615dc85fccdd62.jpg"
    }
  ],
  "ProductSpecifications": [
    {
      "fieldName": "prodspec1",
      "fieldValues": [
        "value1",
        "value2"
      ]
    }
  ],
  "SkuSpecifications": [
    {
      "fieldName": "skuspec1",
      "fieldValues": [
        "value1",
        "value2"
      ]
    }
  ],
  "EAN": "EAN123",
  "MeasurementUnit": "un",
  "UnitMultiplier": 1,
  "AvailableQuantity": 111,
  "Pricing": {
    "Currency": "BRL",
    "SalePrice": 399,
    "CurrencySymbol": "R$"
  }
}

v46