VTEX · Example Payload

Vtex Getproductoffers Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getproductoffers 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": "GetProductoffers",
  "method": "GET",
  "path": "/offer-manager/pvt/product/{productId}",
  "summary": "VTex Get Matched Offer's Data by Product ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "productId": "1561208",
          "skuId": "1559161",
          "nameComplete": "Blusa Cardigan Manga Longa Vestem - Feminina - CINZA G",
          "mainImage": {
            "imagePath": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
          },
          "sellersOffers": [
            {
              "sellerId": "1",
              "sellerSkuId": "1559161",
              "salesChannelOffer": {
                "salesChannelId": "1",
                "salesChannelName": "Principal",
                "price": 0,
                "listPrice": 0,
                "priceWithoutDiscount": 0,
                "availableQuantity": 0
              }
            }
          ]
        },
        {
          "productId": "1561208",
          "skuId": "1559163",
          "nameComplete": "Blusa Cardigan Manga Longa Vestem - Feminina - CINZA PP",
          "mainImage": {
            "imagePath": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
          },
          "sellersOffers": [
            {
              "sellerId": "1",
              "sellerSkuId": "1559161",
              "salesChannelOffer": {
                "salesChannelId": "1",
                "salesChannelName": "Principal",
                "price": 0,
                "listPrice": 0,
                "priceWithoutDiscount": 0,
                "availableQuantity": 0
              }
            }
          ]
        }
      ]
    }
  ]
}