Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Undo Rebate Agreement Revocation
List Rebate Agreements
Upsert a Rebate Agreement
List Rebate Agreement Items
Get a Rebate Agreement
Add Rebate Agreement Items
Delete a Rebate Agreement
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
List CLIC Objects
Update CLIC Line Items
Delete All Line Items
Import Line Items (w/o Input Types)
Undo Rebate Record Revocation
Undo Rebate Agreement Rev...
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
Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.importlineitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.importlineitems/{typedId}
- 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/clicmanager.importlineitems/{typedId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"parent": "ROOT",
"skus": [
{
"inputs": [
{
"name": "Integer Input",
"value": "123"
}
],
"label": "TEST",
"sku": "B-0006",
"folder": false
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-79df676dd9-lr6pk", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebateagreement.undorevoke/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebateagreement.undorevoke/{typedId}
- 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/rebateagreement.undorevoke/{typedId}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecord.undorevoke/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecord.undorevoke/{typedId}
- 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/rebaterecord.undorevoke/{typedId}'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