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
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.droptable/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.droptable/{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.droptable/{tableName}' \
-H 'Content-Type: application/json' \
-d '{}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.listtables
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.listtables
- 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.listtablesResponse
application/json
{ "response": { "node": "node", "csrfToken": "token", "data": [ … ], "status": 0 } }
Request
Inserts bulk data to the Key-Value Store.
Existing Primary Key combos are overwritten automatically. This is the only command where you explicitly have to specify the automatic “payload” column. While technically you could put any text into that column, other endpoints and Groovy perform JSON conversions (e.g. return a proper map) when you perform key lookups. So inserting a valid JSON into payload is highly recommended!
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.loaddata/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.loaddata/{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.loaddata/{tableName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"header": [
"sku",
"customer",
"record",
"payload"
],
"data": [
[
"A1",
"83-3126689",
1,
"{ ... JSON ... }"
],
[
"A1",
"45-0245039",
1,
"{ ... JSON ... }"
],
[
"A2",
"02-0995855",
1,
"{ ... JSON ... }"
]
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
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