v1

latestOpenAPI 3.0.02026-07-142517.8 KB

Pricing Hub Prices

Get Prices

This route retrieves and applies prices for the items that are passed in the request. Pricing Hub will select the pricing method that will be used for each item and will fetch their respective price from the selected pricing method.

ℹ️ > This feature is in closed beta, available only for selected customers. If you have any questions, contact our Support.

post/api/pricing-hub/prices

Query parameters

accountNamestring required

Name of the VTEX account. Used as part of the URL

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand

Content-Typestring required

Describes the type of the content being sent

X-VTEX-API-AppKeystring required

The AppKey configured by the merchant

X-VTEX-API-AppTokenstring required

The AppToken configured by the merchant

Request body

UtmCampaignstring

Campaign name, represented by the utm_campaign value in the URL that led to the order. If there is no value, use null

UtmInternalCampaignstring

Internal campaign name, represented by the utmi_cp value in the URL that led to the order. If there is no value, use null

UtmMediumstring

Medium that indicates what type of traffic the customer originated from, represented by the utm_medium value in the URL that led to the order. If there is no value, use null

UtmSourcestring

Traffic source, indicates where the traffic originated from according to the utm_source value in the URL that led to the order. If there is no value, use null

emailstring required

The customer's email address. If there is no value, use an empty string

salesChannelstring required

Represents Checkout's sales channel

Example request

{
  "UtmCampaign": "summer",
  "UtmInternalCampaign": "sale",
  "UtmMedium": "social",
  "UtmSource": "facebook",
  "email": "customer@email.com",
  "items": [
    {
      "brandId": "2000000",
      "categoriesIds": [
        "1"
      ],
      "index": 0,
      "priceTableIds": [],
      "quantity": 1,
      "sellerId": "1",
      "skuId": "13"
    }
  ],
  "salesChannel": "1"
}

Response

All 2 operations