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.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 } }
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.describetable/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.describetable/{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.describetable/{tableName}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 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