v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-122521.1 KB

Pricing Hub Prices

Retrieve prices

⚠️ This API has been deprecated. If you need to associate prices with specific customers, we recommend using the Audience API.

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.

post/api/pricing-hub/prices

Query parameters

anstring required

Example:apiexamples

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.

Request body

UtmSourcestring nullable

Traffic source, which 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.

UtmMediumstring nullable

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.

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 nullable

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

salesChannelstring required

Represents Checkout's sales channel.

emailstring required

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

Example request

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

Response

All 2 operations