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

Changes

Changed in 7 of the 52 revisions of this API.4327

Nov 30, 20230e615612e91e11See the full diff
- ▲
  added the new required query request parameter an
  new-required-request-parameter
- ●
  deleted the query request parameter accountName
  request-parameter-removed
Nov 13, 2023fef4a273ea9d216See the full diff
- ●
  deleted the header request parameter X-VTEX-API-AppKey
  request-parameter-removed
- ●
  deleted the header request parameter X-VTEX-API-AppToken
  request-parameter-removed
- ○
  the request property UtmInternalCampaign became nullable
  request-property-became-nullable
- ○
  the request property UtmMedium became nullable
  request-property-became-nullable
- ○
  the request property UtmSource became nullable
  request-property-became-nullable
- ○
  the request property default value 1 was removed
  request-property-default-value-removed
- ○
  the request property default value 1 was removed
  request-property-default-value-removed
- ○
  the UtmCampaign request property default value summer was removed
  request-property-default-value-removed
- ○
  the UtmInternalCampaign request property default value sale was removed
  request-property-default-value-removed
- ○
  the UtmMedium request property default value social was removed
  request-property-default-value-removed
- ○
  the UtmSource request property default value facebook was removed
  request-property-default-value-removed
- ○
  the brandId request property default value 2000000 was removed
  request-property-default-value-removed
- ○
  the email request property default value customer@email.com was removed
  request-property-default-value-removed
- ○
  the index request property default value 0 was removed
  request-property-default-value-removed
- ○
  the quantity request property default value 1 was removed
  request-property-default-value-removed
- ○
  the salesChannel request property default value 1 was removed
  request-property-default-value-removed
- ○
  the sellerId request property default value 1 was removed
  request-property-default-value-removed
- ○
  the skuId request property default value 13 was removed
  request-property-default-value-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 20227cfa999b9dcd11See the full diff
- ▲
  the items/items/quantity request property type/format changed from string/ to integer/
  request-property-type-changed
- ○
  the quantity request property default value changed from 1 to 1
  request-property-default-value-changed
Feb 4, 202255acf28f811721See the full diff
- ▲
  the items/items/index request property type/format changed from string/ to integer/
  request-property-type-changed
- ▲
  the items/items/index response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ○
  the index request property default value changed from 0 to 0
  request-property-default-value-changed
Feb 4, 20227faf4d413a591See the full diff
- ○
  the quantity request property default value changed from 1 to 1
  request-property-default-value-changed
Feb 4, 20220846725755fb7See the full diff
- ○
  the request property UtmCampaign became optional
  request-property-became-optional
- ○
  the request property UtmInternalCampaign became optional
  request-property-became-optional
- ○
  the request property UtmMedium became optional
  request-property-became-optional
- ○
  the request property UtmSource became optional
  request-property-became-optional
- ○
  the categoriesIds request property default value changed from 1 to 1
  request-property-default-value-changed
- ○
  the index request property default value changed from 0 to 0
  request-property-default-value-changed
- ○
  the priceTableIds request property default value changed from to 1
  request-property-default-value-changed
Feb 2, 202265e6e50043d41See the full diff
- ○
  endpoint added
  endpoint-added

Full history