VTEX - Price Simulations.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "Price Simulations API",
        "description": "> Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). 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. \r\n\r\nThe Price Simulations API allows you to configure custom price selectors for B2B stores, based on the context set by the [Orders Configuration app](https://developers.vtex.com/docs/guides/vtex-order-configuration).\r\n\r\n## Custom Prices\r\n\r\n 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.\r\n \r\n- `GET` [Get custom prices schema](https://developers.vtex.com/docs/api-reference/price-simulations#get-/_v/custom-prices/session/schema) \r\n- `POST` [Create or Update custom prices schema](https://developers.vtex.com/docs/api-reference/price-simulations#post-/_v/custom-prices/session/schema) \r\n\r\n## Session Management \r\n\r\n Every time you edit a configuration value set on the Custom Prices session, you must use this endpoint to update the Order Configuration. \r\n \r\n- `POST` [Update Order Configuration](https://developers.vtex.com/docs/api-reference/price-simulations#post-/sessions/) \r\n\r\n\r\n## Price Association\r\n\r\n Use these routes to associate a shopping scenario, created at the Custom Price session, to a specific price table.\r\n \r\n- `GET` [Get price association by ID](https://developers.vtex.com/docs/api-reference/price-simulations#get-/_v/custom-prices/rules/-priceAssociationId-) \r\n- `POST` [Create price association](https://developers.vtex.com/docs/api-reference/price-simulations#post-/_v/custom-prices/rules) \r\n- `PUT` [Update price association by ID](https://developers.vtex.com/docs/api-reference/price-simulations#put-/_v/custom-prices/rules/-priceAssociationId-) \r\n- `DELETE` [Disassociate price association by ID](https://developers.vtex.com/docs/api-reference/price-simulations#delete-/_v/custom-prices/rules/-priceAssociationId-)",
        "contact": {},
        "version": "1.0"
    },
    "servers": [
        {
            "url": "https://{accountName}.{environment}.com.br",
            "description": "VTEX server URL.",
            "variables": {
                "accountName": {
                    "description": "Name of the VTEX account. Used as part of the URL",
                    "default": "apiexamples"
                },
                 "environment": {
                    "description": "Environment to use. Used as part of the URL.",
                    "enum": [
                        "vtexcommercestable"
                    ],
                    "default": "vtexcommercestable"
                }
            }
        }
    ],
    "paths": {
        "/_v/custom-prices/session/schema": {
            "get": {
                "summary": "Get custom prices schema",
                "tags": [
                    "Custom Prices"
                ],
                "description": "Retrieves all custom price for all shopping scenarios",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "title": "Request body",
                                    "example": {
                                        "fields": [
                                            {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            {
                                                "name": "state",
                                                "type": "string"
                                            }
                                        ],
                                        "useEmail": true
                                    },
                                    "required": [
                                        "fields"
                                    ],
                                    "properties": {
                                        "fields": {
                                            "type": "array",
                                            "title": "fields",
                                            "description": "Order Configuration criteria.",
                                            "example": [
                                                {
                                                    "name": "orderType",
                                                    "type": "string"
                                                },
                                                {
                                                    "name": "state",
                                                    "type": "string"
                                                }
                                            ],
                                            "items": {
                                                "type": "object",
                                                "example": {
                                                    "name": "orderType",
                                                    "type": "string"
                                                },
                                                "required": [
                                                    "name",
                                                    "type"
                                                ],
                                                "properties": {
                                                    "name": {
                                                        "type": "string",
                                                        "title": "name",
                                                        "description": "Criteria name.",
                                                        "example": "orderType"
                                                    },
                                                    "type": {
                                                        "type": "string",
                                                        "title": "type",
                                                        "description": "Criteria type.",
                                                        "example": "string"
                                                    }
                                                }
                                            }
                                        },
                                        "useEmail": {
                                            "type": "boolean",
                                            "title": "useEmail",
                                            "description": "If the custom price should use the user's email to validate it.",
                                            "example": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "summary": "Create or Update custom prices schema",
                "tags": [
                    "Custom Prices"
                ],
                "description": "Creates a new custom price for a shopping scenario or updates an existing one",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "title": "Request body",
                                    "example": {
                                        "fields": [
                                            {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            {
                                                "name": "state",
                                                "type": "string"
                                            }
                                        ],
                                        "useEmail": true
                                    },
                                    "required": [
                                        "fields"
                                    ],
                                    "properties": {
                                        "fields": {
                                            "type": "array",
                                            "title": "fields",
                                            "description": "Order Configuration criteria.",
                                            "example": [
                                                {
                                                    "name": "orderType",
                                                    "type": "string"
                                                },
                                                {
                                                    "name": "state",
                                                    "type": "string"
                                                }
                                            ],
                                            "items": {
                                                "type": "object",
                                                "example": {
                                                    "name": "orderType",
                                                    "type": "string"
                                                },
                                                "required": [
                                                    "name",
                                                    "type"
                                                ],
                                                "properties": {
                                                    "name": {
                                                        "type": "string",
                                                        "title": "name",
                                                        "description": "Criteria name.",
                                                        "example": "orderType"
                                                    },
                                                    "type": {
                                                        "type": "string",
                                                        "title": "type",
                                                        "description": "Criteria type.",
                                                        "example": "string"
                                                    }
                                                }
                                            }
                                        },
                                        "useEmail": {
                                            "type": "boolean",
                                            "title": "useEmail",
                                            "description": "If the custom price should use the user's email to validate it.",
                                            "example": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "description": "",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "title": "Request body",
                                "example": {
                                    "fields": [
                                        {
                                            "name": "orderType",
                                            "type": "string"
                                        },
                                        {
                                            "name": "state",
                                            "type": "string"
                                        }
                                    ],
                                    "useEmail": true
                                },
                                "required": [
                                    "fields"
                                ],
                                "properties": {
                                    "fields": {
                                        "type": "array",
                                        "title": "fields",
                                        "description": "Order Configuration criteria.",
                                        "example": [
                                            {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            {
                                                "name": "state",
                                                "type": "string"
                                            }
                                        ],
                                        "items": {
                                            "type": "object",
                                            "example": {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            "required": [
                                                "name",
                                                "type"
                                            ],
                                            "properties": {
                                                "name": {
                                                    "type": "string",
                                                    "title": "name",
                                                    "description": "Criteria name.",
                                                    "example": "orderType"
                                                },
                                                "type": {
                                                    "type": "string",
                                                    "title": "type",
                                                    "description": "Criteria type.",
                                                    "example": "string"
                                                }
                                            }
                                        }
                                    },
                                    "useEmail": {
                                        "type": "boolean",
                                        "title": "useEmail",
                                        "description": "If the custom price should use the user's email to validate it.",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/sessions/": {
            "post": {
                "summary": "Update Order Configuration",
                "tags": [
                    "Session Management"
                ],
                "description": "Updates the Order Configuration. You should use this route every time you edit a configuration value",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "title": "Request body",
                                    "example": {
                                        "public": [
                                            {
                                                "name": "customSessionKeys",
                                                "type": "object"
                                            }
                                        ]
                                    },
                                    "required": [
                                        "public"
                                    ],
                                    "properties": {
                                        "fields": {
                                            "type": "array",
                                            "title": "public",
                                            "description": "Array containing the object to register session criteria.",
                                            "example": [
                                                {
                                                    "name": "customSessionKeys",
                                                    "type": "object"
                                                }
                                            ],
                                            "items": {
                                                "type": "object",
                                                "example": {
                                                    "name": "orderType",
                                                    "type": "string"
                                                },
                                                "required": [
                                                    "name"
                                                ],
                                                "properties": {
                                                    "customSessionKeys": {
                                                        "type": "object",
                                                        "title": "customSessionKeys",
                                                        "description": "Contains every schema criteria."
                                                    }
                                                }
                                            }
                                        },
                                        "value": {
                                            "type": "string",
                                            "title": "value",
                                            "description": "Order Configuration criteria. This is a serialized JSON object."
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "description": "",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "title": "Request body",
                                "example": {
                                    "fields": [
                                        {
                                            "name": "orderType",
                                            "type": "string"
                                        },
                                        {
                                            "name": "state",
                                            "type": "string"
                                        }
                                    ],
                                    "useEmail": true
                                },
                                "required": [
                                    "fields"
                                ],
                                "properties": {
                                    "fields": {
                                        "type": "array",
                                        "title": "fields",
                                        "description": "Order Configuration criteria.",
                                        "example": [
                                            {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            {
                                                "name": "state",
                                                "type": "string"
                                            }
                                        ],
                                        "items": {
                                            "type": "object",
                                            "example": {
                                                "name": "orderType",
                                                "type": "string"
                                            },
                                            "required": [
                                                "name",
                                                "type"
                                            ],
                                            "properties": {
                                                "name": {
                                                    "type": "string",
                                                    "title": "name",
                                                    "description": "Criteria name.",
                                                    "example": "orderType"
                                                },
                                                "type": {
                                                    "type": "string",
                                                    "title": "type",
                                                    "description": "Criteria type.",
                                                    "example": "string"
                                                }
                                            }
                                        }
                                    },
                                    "useEmail": {
                                        "type": "boolean",
                                        "title": "useEmail",
                                        "description": "If the custom price should use the user's email to validate it.",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/_v/custom-prices/rules/{priceAssociationId}": {
            "get": {
                "summary": "Get price association by ID",
                "tags": [
                    "Price Association"
                ],
                "description": "Retrieves price association for a shopping scenario by its ID.",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "priceAssociationId",
                        "in": "path",
                        "required": true,
                        "description": "Price Association unique identifier",
                        "schema": {
                            "type": "integer",
                            "example": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "example": {
                                        "id": 0,
                                        "orderType": "orderType",
                                        "state": "Rio de Janeiro",
                                        "pricetable": "pricetable1",
                                        "email": "youremail@email.com"
                                      },
                                    "required": [
                                        "id",
                                        "pricetable"
                                    ],
                                    "properties": {
                                        "id": {
                                            "type": "integer",
                                            "title": "id",
                                            "description": "Price association ID",
                                            "example": 1
                                        },
                                        "orderType": {
                                            "type": "string",
                                            "title": "orderType",
                                            "description": "Order type",
                                            "example": "orderType1"
                                        },
                                        "state": {
                                            "type": "string",
                                            "title": "state",
                                            "description": "State of the shipping address.",
                                            "example": "Rio de Janeiro"
                                        },
                                        "pricetable": {
                                            "type": "string",
                                            "title": "pricetable",
                                            "description": "Name of the Price Table associated with the scenario.",
                                            "example": "pricetable1"
                                        },
                                        "email": {
                                            "title": "email",
                                            "type": "string",
                                            "description": "User's email.",
                                            "example": "youremail@email.com"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "put": {
                "summary": "Update price association by ID",
                "tags": [
                    "Price Association"
                ],
                "description": "Updates a price association for a shopping scenario by its ID",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "priceAssociationId",
                        "in": "path",
                        "required": true,
                        "description": "Price Association unique identifier",
                        "schema": {
                            "type": "integer",
                            "example": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "example":{
                                        "id": 0,
                                        "orderType": "orderType",
                                        "state": "Rio de Janeiro",
                                        "pricetable": "pricetable1",
                                        "email": "youraccount@email.com"
                                      },
                                    "required": [
                                        "id",
                                        "pricetable"
                                    ],
                                    "properties": {
                                        "id": {
                                            "type": "integer",
                                            "title": "id",
                                            "description": "Price association ID.",
                                            "example": 0
                                        },
                                        "orderType": {
                                            "type": "string",
                                            "title": "orderType",
                                            "description": "Order type.",
                                            "example": "orderType"
                                        },
                                        "state": {
                                            "type": "string",
                                            "title": "state",
                                            "description": "Delivery location.",
                                            "example": "Rio de Janeiro"
                                        },
                                        "pricetable": {
                                            "type": "string",
                                            "title": "pricetable",
                                            "description": "Name of the Price Table associated with the scenario.",
                                            "example": "pricetable1"
                                        },
                                        "email": {
                                            "type": "string",
                                            "title": "email",
                                            "description": "User's email.",
                                            "example": "youraccount@email.com"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "description": "",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "title": "Request body",
                                "example": {
                                    "orderType": "string",
                                    "state": "string",
                                    "pricetable": "string"
                                  },
                                "required": [
                                    "orderType",
                                    "state",
                                    "pricetable"
                                ],
                                "properties": {
                                    "orderType": {
                                        "type": "string",
                                        "title": "orderType",
                                        "description": "Order type",
                                        "example": "orderType"
                                    },
                                    "state": {
                                        "type": "string",
                                        "title": "state",
                                        "description": "State of the shipping address.",
                                        "example": "RR"
                                    },
                                    "pricetable": {
                                        "type": "string",
                                        "title": "pricetable",
                                        "description": "Name of the Price Table associated with the scenario",
                                        "example": "pricetable1"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "delete": {
                "summary": "Disassociate price association by ID",
                "tags": [
                    "Price Association"
                ],
                "description": "Disassociates a price association from a shopping scenario by its ID",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "example": "application/json"
                        }
                    },
                    {
                        "name": "priceAssociationId",
                        "in": "path",
                        "required": true,
                        "description": "Price Association unique identifier.",
                        "schema": {
                            "type": "integer",
                            "example": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "string",
                                    "example": "Rule deleted with success: custom_prices-5dc4f3d6-dda6-11ea-835b-12d97a7637bf"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/_v/custom-prices/rules": {
            "post": {
                "summary": "Create price association",
                "tags": [
                    "Price Association"
                ],
                "description": "Creates a new price association for a shopping scenario",
                "parameters": [
                    {
                        "name": "Content-Type",
                        "in": "header",
                        "description": "Describes the type of the content being sent",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "default": "application/json"
                        }
                    },
                    {
                        "name": "Accept",
                        "in": "header",
                        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string",
                            "default": "application/json"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "example": {
                                        "id": 0,
                                        "orderType": "orderType",
                                        "state": "Rio de Janeiro",
                                        "pricetable": "pricetable1",
                                        "email": "youremail@email.com"
                                      },
                                    "required": [
                                        "id",
                                        "pricetable"
                                    ],
                                    "properties": {
                                        "id": {
                                            "type": "integer",
                                            "title": "id",
                                            "description": "Price association ID",
                                            "example": 1
                                        },
                                        "orderType": {
                                            "type": "string",
                                            "title": "orderType",
                                            "description": "Order type.",
                                            "example": "orderType"
                                        },
                                        "state": {
                                            "type": "string",
                                            "title": "state",
                                            "description": "State of the shipping address.",
                                            "example": "RJ"
                                        },
                                        "pricetable": {
                                            "type": "string",
                                            "title": "pricetable",
                                            "description": "Name of the Price Table associated with the scenario.",
                                            "example": "pricetable1"
                                        },
                                        "email": {
                                            "type": "string",
                                            "title": "email",
                                            "description": "User's email.",
                                            "example": "youremail@email.com"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "description": "",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "example": {
                                    "orderType": "string",
                                    "state": "Rio de Janeiro",
                                    "pricetable": "pricetable1",
                                    "email": "youremail@email.com"
                                  },
                                "required": [
                                    "pricetable"
                                ],
                                "properties": {
                                    "orderType": {
                                        "type": "string",
                                        "title": "orderType",
                                        "description": "Order type",
                                        "example": "orderType1"
                                    },
                                    "state": {
                                        "type": "string",
                                        "title": "state",
                                        "description": "State of the shipping address.",
                                        "example": "Rio de Janeiro"
                                    },
                                    "pricetable": {
                                        "type": "string",
                                        "title": "pricetable",
                                        "description": "Name of the Price Table associated with the scenario",
                                        "example": "pricetable1"
                                    },
                                    "email": {
                                        "type": "string",
                                        "title": "email",
                                        "description": "User's email.",
                                        "example": "youremail@email.com"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "tags": [
        {
            "name": "Session Management"
        },
        {
            "name": "Custom Prices"
        },
        {
            "name": "Price Association"
        }
    ]
}