VTEX · Example Payload

Vtex Match Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Match 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

Raw ↑ 
{
  "operationId": "Match",
  "method": "PUT",
  "path": "/suggestions/{sellerId}/{sellerskuid}/versions/{version}/matches/{matchid}",
  "summary": "VTex Match Received SKUs individually",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "matcherId": "{{matcherid}}",
        "matchType": "itemMatch",
        "score": "{{score}} (must be decimal)",
        "skuRef": "{{skuid}}(should be specifed when match is a sku match)",
        "productRef": "{{productRef}}(should be specified when match is a product match)",
        "product": {
          "name": "Book A",
          "description": "Book description",
          "categoryId": 12,
          "brandId": 1234567,
          "matchType": "itemMatch",
          "specifications": null
        },
        "sku": {
          "name": "Sku exemplo",
          "eans": [
            "12345678901213"
          ],
          "refId": null,
          "height": 1,
          "width": 1,
          "length": 1,
          "weight": 1,
          "images": [
            {
              "imagem1.jpg": {
                "imagem1.jpg": "https://imageurl.example"
              }
            }
          ],
          "unitMultiplier": 1,
          "measurementUnit": "un",
          "specifications": {
            "Embalagem": "3 k   g"
          }
        }
      }
    }
  ],
  "responseExamples": []
}