Pricefx REST API Reference
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
Request
Retrieves the payload from the table with the specified key. The request must contain key/value pairs for all primary keys as defined in table.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.fetchkey/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.fetchkey/{tableName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.fetchkey/{tableName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"keys": {
"sku": "A1",
"customer": "B2"
}
}
}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.count/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.count/{tableName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.count/{tableName}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.truncate/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.truncate/{tableName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.truncate/{tableName}'Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.
Comments