Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Pricing Hub (DEPRECATED)

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

In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.

In VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.

Pricing hub protocal diagram

Implementation

To connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:

Read the documentation on each repository to learn more about the required steps to use and customize the app.

The app used by Pricing Hub to connect must be a major 0.

Index

Common parameters in the documentation

Parameter name Description
{{accountName}} Store account name.
{{environment}} The environment that will be called.
{{X-VTEX-API-AppKey}} Located in the headers of the requests, user authentication key.
{{X-VTEX-API-AppToken}} Located in the headers of the requests, authentication password.

Endpoints

Pricing Hub Prices

SummaryMethodPath
Retrieve pricesPOST/api/pricing-hub/prices
Configure external price sourcePUT/api/pricing-hub/prices/config

Loading API specification...