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 a customer to the Master Data - Customers table.
Please note: The data sent in your request might be different from our sample request schema. The custom fields (attribute1..attribute30) can be retrieved using the /fetch/CAM operation.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/C
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/C
- 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/C \
-H 'Content-Type: application/json' \
-d '{
"data": {
"customerId": "123456",
"name": "Acme",
"attribute1": "High Street 23",
"attribute2": "+44 12345678",
"userGroupEdit": "Administrators"
},
"operation": "add"
}'Response
application/json
- listCustomerResponseExample
- listCustomerResponseExample_resultFields
- listCustomerResponseExample_valueFields
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/C
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/C
- 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/C \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attribute1": "Derry Lane 11",
"attribute2": "+44123456789",
"typedId": "2147492216.C"
},
"oldValues": {
"version": 0,
"typedId": "2147492216.C",
"customerId": "00003",
"name": "Kate Smith",
"parentId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"nodeId": 2147492216,
"createDate": "2021-09-22T12:56:16",
"createdBy": 2147490696,
"lastUpdateDate": "2021-09-22T12:56:16",
"lastUpdateBy": 2147490696,
"attribute1": "Derry Lane",
"attribute2": "123456789",
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"isParent": false
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
- listCustomerResponseExample
- listCustomerResponseExample_resultFields
- listCustomerResponseExample_valueFields
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Deletes a customer.
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
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/C
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/C
- 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/C \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147492214.C"
}
}'Response
application/json
{ "response": { "node": "string", "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