v1

latestOpenAPI 3.0.02026-07-142517.8 KB
Pricing Hub Prices

Configure External Price Source

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.

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

put/config

Query parameters

anstring
Example:apiexamples

Name of the VTEX account

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

activeboolean

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

appNamestring required

Name of the app that communicates with the external pricing source

Example request

{
  "active": true,
  "appName": "apiexamples_app_name"
}

Response

OK