Policies System API
This API will create promotion alarms when selling products with undesired prices and promotions. It will create conditions that will check if the prices and…
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
This API will create promotion alarms when selling products with undesired prices and promotions. It will create conditions that will check if the prices and the promotions are correct. If not, the system will alarm the store with information about the product sold at unexpected prices.
Index
GET Get Policy ListPOST Evaluate PoliciesGET Get Policy by IDPOST Create PolicyPUT Update PolicyDELETE Delete Policy by ID
Endpoints 6
Policy
- POSTEvaluate Policies
/api/policy-engine/evaluateThis endpoint consults all policies and checks the ones that satisfy the request body’s conditions. - GETGet Policy List
/api/policy-engine/policiesRetrieves a list of all policies in the account and general information of each policy. - GETGet Policy by ID
/api/policy-engine/policies/:idRetrieves general information of a policy by its ID. - PUTUpdate Policy
/api/policy-engine/policies/:idUpdates an existing policy at your account. - POSTCreate Policy
/api/policy-engine/policies/:idCreates a new policy from scratch. - DELETEDelete Policy by ID
/api/policy-engine/policies/:idDeletes a specific policy of the account by its ID.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- None declared in the description
- Operations
- 6 operations on 3 pathsGET 2POST 2PUT 1DELETE 1
- Main resources
- Policy 6
- Response formats
application/jsonapplication/octet-stream- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Policies System API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Policies System API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Evaluate Policies” (POST /api/policy-engine/evaluate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Policies System API?
This API will create promotion alarms when selling products with undesired prices and promotions. It will create conditions that will check if the prices and… It is listed under Other and has 6 endpoints.
Who publishes the Policies System 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 Policies System 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 Policies System 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 Policies System API have?
6 operations on 3 paths (2 GET, 2 POST, 1 PUT, 1 DELETE). The largest groups are Policy.
Is forking the Policies System API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.