VTEX · Example Payload

Vtex Productvariations Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Productvariations 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": "ProductVariations",
  "method": "GET",
  "path": "/api/catalog_system/pub/products/variations/{productId}",
  "summary": "VTex Get product's SKUs by product ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "productId": 9,
        "name": "Tshirt",
        "salesChannel": "2",
        "available": true,
        "displayMode": "list",
        "dimensions": [
          "Color",
          "Size",
          "Origin country",
          "Gender"
        ],
        "dimensionsInputType": {
          "Color": "Combo",
          "Size": "Combo",
          "Origin country": "Combo",
          "Gender": "Combo"
        },
        "dimensionsMap": {
          "Color": [
            "Yellow",
            "Blue",
            "Red"
          ],
          "Size": [
            "S",
            "M",
            "L"
          ],
          "Origin country": [
            "Brazil"
          ],
          "Gender": [
            "Male"
          ]
        },
        "skus": [
          {
            "sku": 310118454,
            "skuname": "Yellow - L",
            "dimensions": {
              "Color": "Yellow",
              "Size": "L",
              "Origin country": "Brazil",
              "Gender": "Male"
            },
            "available": false,
            "availablequantity": 0,
            "cacheVersionUsedToCallCheckout": null,
            "listPriceFormated": "R$ 0,00",
            "listPrice": 0,
            "taxFormated": "R$ 0,00",
            "taxAsInt": 0,
            "bestPriceFormated": "R$ 9.999.876,00",
            "bestPrice": 999987600,
            "spotPrice": 999987600,
            "installments": 0,
            "installmentsValue": 0,
            "installmentsInsterestRate": null,
            "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000",
            "sellerId": "1",
            "seller": "lojadobreno",
            "measures": {
              "cubicweight": 1.0,
              "height": 5.0,
              "length": 20.0,
              "weight": 200.0,
              "width": 20.0
            },
            "unitMultiplier": 1.0,
            "rewardValue": 0
          },
          {
            "sku": 310118455,
            "skuname": "Red - M",
            "dimensions": {
              "Color": "Red",
              "Size": "M",
              "Origin country": "Brazil",
              "Gender": "Male"
            },
            "available": true,
            "availablequantity": 99999,
            "cacheVersionUsedToCallCheckout": "38395F1AEF59DF5CEAEDE472328145CD_",
            "listPriceFormated": "R$ 0,00",
            "listPrice": 0,
            "taxFormated": "R$ 0,00",
            "taxAsInt": 0,
            "bestPriceFormated": "R$ 20,00",
            "bestPrice": 2000,
            "spotPrice": 2000,
            "installments": 1,
            "installmentsValue": 2000,
            "installmentsInsterestRate": 0,
            "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155468-292-292/image-601a6099aace48b89d26fc9f22e8e611.jpg?v=637321906602470000",
            "sellerId": "pedrostore",
            "seller": "pedrostore",
            "measures": {
              "cubicweight": 0.4167,
              "height": 5.0,
              "length": 20.0,
              "weight": 200.0,
              "width": 20.0
            },
            "unitMultiplier": 1.0,
            "rewardValue": 0
          }
        ]
      }
    }
  ]
}