vtex.local – Price-Simulations

OpenAPI apis-guru

Check the new . We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey

The Price Simulations API allows you to configure custom price selectors for B2B stores, based on the context set by the .

Custom Prices

In this section, you can create a specific shopping scenario with the criteria you want. For explaining purpose, we used the orderType and state as default values, but it can be others too.

GET POST

Session Management

Every time you edit a configuration value set on the Custom Prices session, you must use this endpoint to update the Order Configuration.

POST

Price Association

Use these routes to associate a shopping scenario, created at the Custom Price session, to a specific price table.

GET POST PUT DELETE

Homepage: https://api.apis.guru/v2/specs/vtex.local:Price-Simulations/1.0.json
Provider: vtex.local:Price-Simulations / Price-Simulations
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Price-Simulations/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Price-Simulations/1.0/openapi.yaml

Tools (9)

Extracted live via the executor SDK.

customPrices.getVCustomPricesSessionSchema

Retrieves all custom price for all shopping scenarios
customPrices.postVCustomPricesSessionSchema

Creates a new custom price for a shopping scenario or updates an existing one
priceAssociation.deleteVCustomPricesRulesPriceAssociationId

Disassociates a price association from a shopping scenario by its ID
priceAssociation.getVCustomPricesRulesPriceAssociationId

Retrieves price association for a shopping scenario by its ID
priceAssociation.postVCustomPricesRules

Creates a new price association for a shopping scenario
priceAssociation.putVCustomPricesRulesPriceAssociationId

Updates a price association for a shopping scenario by its ID
sessionManagement.postSessions

Updates the Order Configuration. You should use this route every time you edit a configuration value
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools