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}
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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.fetch/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.fetch/{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.fetch/{tableName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"sku": "SKUABCDE12345"
}
}'Response
application/json
[ { "payload": "{}", "record": 1, "sku": "A1", "customer": "B2" }, { "payload": "{}", "record": 1, "sku": "A1", "customer": "83-3126689" }, { "payload": "{}", "record": 1, "sku": "A1", "customer": "45-0245039" } ]
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.putkey/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.putkey/{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.putkey/{tableName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"keys": {
"sku": "sku_123456",
"customer": "cus_123456"
},
"payload": "payload"
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": {}, "status": 0 } }
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code