Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Mass Update
Insert Bulk Data
Insert Bulk Data From a File
Insert Bulk Data From a File (async)
Upsert an Object
Upsert an Object (and return old data)
Update an Object (and return old data)
Update an Object
Delete an Object
Delete Column Values
Delete Objects
Create an Object
Get an Object
List Objects
List Type Codes
Mass Update
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
Deletes an object.
Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.
Note: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.
Security
basic or X-PriceFx-jwt
Path
Bodyapplication/jsonEnter the type code of the entity you want to delete the object from. See the list of Type Codes in the Pricefx Knowledge Base article.
Enum"ACTT""AP""APIK""BD""BPT""BR""C""CA""CAM""CDESC"
Example: P
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/{TypeCode}
- 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/delete/P \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147501187.P"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Performs a mass update operation on the specified object. This operation is not available for all types of objects – "massEditable" = "true" must be set on the object to allow the mass edit operation.
Set the filter criteria to restrict the scope of the mass edit operation.
Security
basic or X-PriceFx-jwt
Path
Bodyapplication/jsonThe object's type code. See the list of Type Codes.
Can be either one of these valid operators: + - * If omitted, the provided value is set (= operator). Otherwise the specified operation is applied.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/massedit/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/massedit/{TypeCode}
- 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/massedit/{TypeCode}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "id",
"operator": "inSet",
"value": [
"2147501189",
"2147501188"
],
"_constructor": "AdvancedCriteria"
}
]
},
"massEditRecords": [
{
"fieldName": "currency",
"massEditOperator": "=",
"fieldValue": "USD",
"precision": null
}
]
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Path
The object's type code. See the list of Type Codes.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/resetcolumn/{TypeCode}/{columnName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/resetcolumn/{TypeCode}/{columnName}
- 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/resetcolumn/{TypeCode}/{columnName}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": null, "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