VTEX · Example Payload

Vtex Getofferslist Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getofferslist 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": "Getofferslist",
  "method": "GET",
  "path": "/offer-manager/pvt/offers",
  "summary": "VTex Get Matched Offers List",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "LastModified": "2021-05-06T21:37:24.262529",
          "ProductId": "941947",
          "CategoryId": 1563,
          "BrandId": 2004291,
          "ProductName": "Produto Teste 04 - Preto - 40",
          "Skus": [
            {
              "SkuId": "1070268",
              "EanId": null,
              "RefId": null,
              "NameComplete": "Produto Teste 04 - Preto - 40 Cor:Preto",
              "Name": "Cor:Preto",
              "IsActive": true,
              "MainImage": {
                "ImageId": "53878805",
                "ImageLabel": null,
                "ImageTag": "<img src=\"~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg\" width=\"#width#\" height=\"#height#\" alt=\"image-8b4364782e664d76a6ebc8702008e478\" id=\"\" />",
                "ImagePath": "~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg",
                "IsMain": true,
                "IsZoomSize": true,
                "ImageText": "image-8b4364782e664d76a6ebc8702008e478",
                "LastModified": "2021-04-06T03:01:30.747"
              },
              "Offers": [
                {
                  "SellerId": "1",
                  "SellerSkuId": "1070268",
                  "OffersPerSalesChannel": [
                    {
                      "SaleChannel": 1,
                      "Price": 0,
                      "ListPrice": 0,
                      "PriceWithoutDiscount": 0,
                      "AvailableQuantity": 0
                    }
                  ],
                  "AvailableSalesChannels": null
                },
                {
                  "SellerId": "madesacms",
                  "SellerSkuId": "3298",
                  "OffersPerSalesChannel": [
                    {
                      "SaleChannel": 0,
                      "Price": 1200,
                      "ListPrice": 1200,
                      "PriceWithoutDiscount": 1200,
                      "AvailableQuantity": 10000000
                    }
                  ],
                  "AvailableSalesChannels": null
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}