Defines if the external price source is active (`true`) or not (`false`). If not set, the default value will be `false`.

Name of the app that communicates with the external pricing source.

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

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

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`.

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`.

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

List of items to be priced by Pricing Hub.

The cost price returned by the pricing API that was used by Pricing Hub. It is measured in cents, so 5000 means 50,00 in local currency.

The same index referring to Checkout's cart that was passed to the API.

The list price returned by the pricing API that was used by Pricing Hub. It is measured in cents, so 5000 means 50,00 in local currency.

The price returned by the pricing API that was used by Pricing Hub. It is measured in cents, so 5000 means 50,00 in local currency.

The price table that was used to price the item.

The moment up until the price is valid. After that moment, it will be necessary to call the pricing API again. The format of the string is in RFC3339.

The same skuId that was passed to the API.

ID of the categories that will be used to compute the price.

ID of a category that will be used to compute the price.

Index of the item at Checkout's cart. It has to be unique in the items array.

IDs of the price tables that will be used to compute the price. More than one price table might be passed to the array. The final price rule might be more complex than the lowest or the highest price.

ID of a price table that will be used to compute the price.

This is the amount of items that will be priced. It is possible to have a volume discount for many repeated items. Hence, the price may not be the quantity of the item multiplied by the unitary price.

List of items and their respective prices applied by Pricing Hub.

[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

VtexIdclientAutCookie

Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).

X-VTEX-API-AppKey

Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).

X-VTEX-API-AppToken

>⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https://developers.vtex.com/docs/api-reference/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](https://user-images.githubusercontent.com/77292838/211634260-e4f7a516-91df-416e-ab43-d9c79d56bc91.png)

## 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:

- [C# template](https://github.com/vtex-apps/external-prices-app)
- [Node template](https://github.com/vtex-apps/external-prices-node)

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
- [POST - Retrieve prices](https://developers.vtex.com/docs/api-reference/pricing-hub#post-/api/pricing-hub/prices?endpoint=post-/api/pricing-hub/prices)
- [PUT - Configure External Price Source](https://developers.vtex.com/docs/api-reference/pricing-hub#put-/api/pricing-hub/prices/config)

## 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. |

Pricing Hub (DEPRECATED)

>⚠️ This API has been deprecated. If you need to associate prices with specific customers, we recommend using the [Audience API](https://developers.vtex.com/docs/api-reference/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.

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

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

Accept

Describes the type of the content being sent.

Content-Type

>⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https://developers.vtex.com/docs/api-reference/audience-api).

This route facilitates setting up an external price source in Pricing Hub. It also allows you to activate or deactivate that source in a given account.

Environment to use. Used as part of the URL.

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.

Retrieve prices

This route facilitates setting up an external price source in Pricing Hub. It also allows you to activate or deactivate that source in a given account.

Configure external price source

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.