VTEX

Price Simulations API

> Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). We created this guide to improve the onboarding…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

> Check the new Pricing onboarding guide. 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 Orders Configuration app.

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 Get custom prices schema
POST Create or Update custom prices schema

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 Update Order Configuration

Price Association

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

GET Get price association by ID
POST Create price association
PUT Update price association by ID
DELETE Disassociate price association by ID

Endpoints 7

Session Management

  • POSTUpdate Order Configuration/sessions/Updates the Order Configuration. You should use this route every time you edit a configuration value

Custom Prices

  • GETGet custom prices schema/_v/custom-prices/session/schemaRetrieves all custom price for all shopping scenarios
  • POSTCreate or Update custom prices schema/_v/custom-prices/session/schemaCreates a new custom price for a shopping scenario or updates an existing one

Price Association

  • POSTCreate price association/_v/custom-prices/rulesCreates a new price association for a shopping scenario
  • GETGet price association by ID/_v/custom-prices/rules/:priceAssociationIdRetrieves price association for a shopping scenario by its ID
  • PUTUpdate price association by ID/_v/custom-prices/rules/:priceAssociationIdUpdates a price association for a shopping scenario by its ID
  • DELETEDisassociate price association by ID/_v/custom-prices/rules/:priceAssociationIdDisassociates a price association from a shopping scenario by its ID

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br
Authentication
None declared in the description
Operations
7 operations on 4 pathsPOST 3GET 2PUT 1DELETE 1
Main resources
Price Association 4Custom Prices 2Session Management 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Price Simulations API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Price Simulations API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Update Order Configuration” (POST /sessions/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Price Simulations API?

> Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). We created this guide to improve the onboarding… It is listed under Other and has 7 endpoints.

Who publishes the Price Simulations API?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Price Simulations API?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Price Simulations API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Price Simulations API have?

7 operations on 4 paths (3 POST, 2 GET, 1 PUT, 1 DELETE). The largest groups are Price Association, Custom Prices, Session Management.

Is forking the Price Simulations API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.