VTEX · Schema

SaveSuggestionRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
ProductName	string	Name of the suggested product. This field has a limit of 150 characters.
ProductId	string	Product ID in seller's account.
ProductDescription	string	Product Description containing the main information about the product (not the SKU).
BrandName	string	Name of the brand to which this SKU belongs. It must match the brand created in the marketplace.
SkuName	string	Name of the suggested SKU.
SellerId	string	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.
Height	integer	Height of the SKU.
Width	integer	Width of the SKU.
Length	integer	Length of the SKU.
Weight	integer	Weight of the SKU in grams.
RefId	string	SKU reference code. Mandotory if the EAN is not informed.
EAN	string	SKU reference code. Mandatory if the RefId is not informed.
SellerStockKeepingUnitId	integer	ID of the SKU registered in the seller.
CategoryFullPath	string	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/Ove
SkuSpecifications	array	Array containing the names and values of the SKU specifications.
ProductSpecifications	array	Array containing the names and values of the product specifications.
Images	array	Array containing the URLs and names the SKU images.
MeasurementUnit	string	Measurement unit that should be used for this SKU. If this information doesn't apply, you should use the default value `un`.
UnitMultiplier	integer	Unit multiplier for this SKU. If this information doesn't apply, you should use the default value `1`.
AvailableQuantity	integer
Pricing	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SaveSuggestionRequest",
  "title": "SaveSuggestionRequest",
  "required": [
    "ProductName",
    "ProductId",
    "ProductDescription",
    "BrandName",
    "SkuName",
    "SellerId",
    "Height",
    "Width",
    "Length",
    "Weight",
    "Updated",
    "RefId",
    "CategoryFullPath",
    "Images",
    "EAN",
    "AvailableQuantity",
    "Pricing"
  ],
  "type": "object",
  "properties": {
    "ProductName": {
      "type": "string",
      "description": "Name of the suggested product. This field has a limit of 150 characters.",
      "default": ""
    },
    "ProductId": {
      "type": "string",
      "description": "Product ID in seller's account.",
      "default": "1234"
    },
    "ProductDescription": {
      "type": "string",
      "description": "Product Description containing the main information about the product (not the SKU)."
    },
    "BrandName": {
      "type": "string",
      "description": "Name of the brand to which this SKU belongs. It must match the brand created in the marketplace."
    },
    "SkuName": {
      "type": "string",
      "description": "Name of the suggested SKU."
    },
    "SellerId": {
      "type": "string",
      "description": "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.",
      "default": "1"
    },
    "Height": {
      "type": "integer",
      "format": "decimal",
      "description": "Height of the SKU.",
      "default": 10
    },
    "Width": {
      "type": "integer",
      "format": "decimal",
      "description": "Width of the SKU.",
      "default": 10
    },
    "Length": {
      "type": "integer",
      "format": "decimal",
      "description": "Length of the SKU.",
      "default": 10
    },
    "Weight": {
      "type": "integer",
      "format": "decimal",
      "description": "Weight of the SKU in grams.",
      "default": 100
    },
    "RefId": {
      "type": "string",
      "description": "SKU reference code. Mandotory if the EAN is not informed.",
      "default": "REF10"
    },
    "EAN": {
      "type": "string",
      "description": "SKU reference code. Mandatory if the RefId is not informed.",
      "default": "EAN10"
    },
    "SellerStockKeepingUnitId": {
      "type": "integer",
      "format": "int32",
      "description": "ID of the SKU registered in the seller."
    },
    "CategoryFullPath": {
      "type": "string",
      "description": "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'."
    },
    "SkuSpecifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SkuSpecification"
      },
      "description": "Array containing the names and values of the SKU specifications."
    },
    "ProductSpecifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductSpecification"
      },
      "description": "Array containing the names and values of the product specifications."
    },
    "Images": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Image"
      },
      "description": "Array containing the URLs and names the SKU images."
    },
    "MeasurementUnit": {
      "type": "string",
      "description": "Measurement unit that should be used for this SKU. If this information doesn't apply, you should use the default value `un`."
    },
    "UnitMultiplier": {
      "type": "integer",
      "format": "int32",
      "description": "Unit multiplier for this SKU. If this information doesn't apply, you should use the default value `1`."
    },
    "AvailableQuantity": {
      "type": "integer",
      "format": "int32",
      "description": ""
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "Currency": {
          "type": "string"
        },
        "SalePrice": {
          "type": "integer",
          "format": "int32"
        },
        "CurrencySymbol": {
          "type": "string"
        }
      },
      "description": ""
    }
  },
  "default": {
    "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$"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/vtex-savesuggestionrequest"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.