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
Executes a logic that is assigned to the given product (specified by sku or typedId) and calculates the result. The result content is defined partially by the visibility flags that are part of the logic master data.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.execute/{sku}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.execute/{sku}
- 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/formulamanager.execute/{sku}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"priority": "high",
"quantity": 14,
"map": {
"key": "value"
}
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Executes a logic (specified by uniqueName) that is assigned to the given product (specified by sku or typedId) and calculates the result. The result content is defined partially by the visibility flags that are part of the logic master data.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.execute/{sku}/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.execute/{sku}/{uniqueName}
- 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/formulamanager.execute/{sku}/{uniqueName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"priority": "high",
"quantity": 14,
"map": {
"key": "value"
}
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Retrieves recommended Quote items for a customer, segment, or a product.
See also: Configure Recommended Items Knowledge base article.
If the endpoint receives a request data containing a Quote typedId and a QuoteProductFilter logic is configured in the partition (see Quote Product Picker Filter Logic), then the endpoint will evaluate this logic with the corresponding Quote and gives the resulting Filter object to the recommendation model evaluation.
Security
basic or X-PriceFx-jwt
Specify SKUs that have been already added to the Quote to exclude them from recommendations. Use the /clicmanager.fetchitemuniquetypes/{typedId} endpoint to retrieve these SKUs.
Specify any products (SKUs) you want to explicitly exclude from recommendations.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/recommendations.recommend
- URL:https://companynode.pricefx.com/pricefx/companypartition/recommendations.recommend
- 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/recommendations.recommend \
-H 'Content-Type: application/json' \
-d '{
"data": {
"customers": [
"CD-0001"
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-844d685f8b-8hn7d", "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