1
Pricevent API Documentation v1.2
1. Release features
a. GET method for all products and concurrent products
b. GET method for all products and concurrent products paginated
c. GET method for all suggested prices (Dynamic Pricing module)
d. API url: https://api.pricevent.com/api/product
2. Configuration
a. To obtain access to the PriceVent API please follow these steps:
- login with your username and password in PriceVent platform, go to
Menu->Settings->API Details. If the API details are not listed, please push the
Generate button found on the page.
- authentication is done through headers, the required data is X-API-TOKEN, X-
API-USERID and Content-Type.
X-API-TOKEN = generated token from your account in PriceVent app (API
Details section)
X-API-USERID = the user id found in your account in PriceVent app (API Details
section)
Content-Type = application/json
If any of that information is wrong API functionality is restricted.
2
3. GET request to the PriceVent API resources
a. Using the API url /read.php you will receive a list with all your user active products
and concurrent products found in PriceVent (JSON format).
Sample:
b. Using the API url /read_paging.php along with the parameter page is showing a
paginated list with all your user active products and concurrent products found in
PriceVent.
The parameter page indicates the page number, if no page number is sent then the
1st page is listed by default.
At the bottom of each query, you will have the following information: two previous
page links and two next page links in relation to the current page, as well as the last
page link. The number of records per page is 100.
3
Sample:
c. Using the API url /read_suggested_prices.php will show a list with all your generated
suggested prices by the Dynamic Pricing module.
4
Sample:
4. Download PHP files for accessing API
In order to make it easier to access the API with PHP we have created the files needed to
access the resources presented above.
- getAllProducts.php = read all products
- getPageProducts.php = read all products paginated
- getSuggestedPrices.php = read all suggested prices, generated by the Dynamic
Pricing module
- settings.php = set the required data for accessing the API
DOWNLOAD PHP FILES
