VTEX · Example Payload

Vtex Savesuggestion Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Savesuggestion Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "SaveSuggestion",
  "method": "PUT",
  "path": "/suggestions/{sellerId}/{sellerSkuId}",
  "summary": "VTex Send SKU Suggestion",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "ProductId": "321",
        "ProductName": "Product sample",
        "NameComplete": "Complete product name",
        "ProductDescription": "sample",
        "BrandName": "Brand 1",
        "SkuName": "Sku sample",
        "SellerId": "string",
        "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": "Fabric",
            "fieldValues": [
              "Cotton",
              "Velvet"
            ]
          }
        ],
        "SkuSpecifications": [
          {
            "fieldName": "Color",
            "fieldValues": [
              "Red",
              "Blue"
            ]
          }
        ],
        "EAN": "EAN123",
        "MeasurementUnit": "un",
        "UnitMultiplier": 1,
        "AvailableQuantity": 111,
        "Pricing": {
          "Currency": "BRL",
          "SalePrice": 399,
          "CurrencySymbol": "R$"
        }
      }
    }
  ],
  "responseExamples": []
}