Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Add a Condition Record Item Attribute Meta
Update a Condition Record Set
Add a Condition Record Set
List Condition Record Sets
Delete a Condition Records Set
Get a Condition Record Item
Update a Condition Record Item Attribute Meta
Get a Condition Record Item Attribute Meta
Delete a Condition Record Item Attribute Meta
Get Condition Record Set Items With Set Id Validation
Add a Condition Record It...
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
Retrieves a Condition Record Item with 12 keys.
You can use the
CRCI1..CRCI12type codes in the path to retrieve Condition Record Items with different number of keys.
It is not possible to edit or delete the
CRCItype codes.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CRCI12
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CRCI12
- 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/fetch/CRCI12 \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-7b7fdd5759-6h6mr", "data": [ … ], "endRow": 1 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CRCIM
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/CRCIM
- 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/add/CRCIM \
-H 'Content-Type: application/json' \
-d '{
"data": {
"conditionRecordSetId": "7",
"hidden": "false",
"fieldName": "attribute5",
"label": "Attribute 5",
"cssProperties": "",
"description": "",
"entityRefTypeCode": null,
"fieldType": 1,
"fieldValueOptions": null,
"formatType": "INTEGER",
"labelTranslations": "{\"\":\"My Super Att 5\"}",
"readOnly": false
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-54764b46f4-s7h4l", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CRCIM
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/CRCIM
- 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/update/CRCIM \
-H 'Content-Type: application/json' \
-d '{
"data": {
"label": "string",
"fieldType": 0
},
"oldValues": {
"version": 0,
"typedId": "string"
},
"operationType": "string",
"textMatchStyle": "string"
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7599bbd56-75vcd", "data": [ … ], "status": 0 } }
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
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