VTEX · Example Payload

Vtex Post Apipricing Hubprices Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Apipricing Hubprices 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": "post-apipricing-hubprices",
  "method": "POST",
  "path": "/api/pricing-hub/prices",
  "summary": "VTex Retrieve prices",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "items": [
          {
            "index": 0,
            "skuId": "13",
            "quantity": 1,
            "brandId": "2000000",
            "sellerId": "1",
            "priceTableIds": [],
            "categoriesIds": [
              "1"
            ]
          }
        ],
        "UtmSource": "facebook",
        "UtmMedium": "social",
        "UtmCampaign": "summer",
        "UtmInternalCampaign": "sale",
        "salesChannel": "1",
        "email": "customer@email.com"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "items": [
          {
            "index": 0,
            "skuId": "14",
            "price": 1875,
            "costPrice": 750,
            "listPrice": 2500,
            "priceTable": "1",
            "priceValidUntil": "2022-03-24T14:57:19Z"
          },
          {
            "index": 0,
            "skuId": "14",
            "price": 200,
            "costPrice": 200,
            "listPrice": 200,
            "priceTable": "1",
            "priceValidUntil": "2022-03-04T20:00:18Z"
          }
        ]
      }
    }
  ]
}