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
Adds products to the Competition Data table. Returns the number of updated, inserted, and failed records during the import. Creates a new row for each product.
Security
basic or X-PriceFx-jwt
The competition product details.
INSERT - always inserts new records, even duplicates. UPDATE - data is always overridden.
Enum"INSERT""UPDATE"
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.importproductcompetition
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.importproductcompetition
- 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/productmanager.importproductcompetition \
-H 'Content-Type: application/json' \
-d '{
"data": {
"importStrategy": "INSERT",
"products": [
{
"sku": "01",
"label": "Product01",
"price": 10,
"currency": "EUR",
"competitor": "COMP",
"competitorSku": "P001",
"competitionType": "string",
"country": "Spain",
"priceUnit": 1,
"unitOfMeasure": "string",
"infoDate": "2021-10-25T12:14:28.646Z",
"additionalInfo1": 0,
"additionalInfo2": 100,
"additionalInfo4": "test"
},
{
"sku": "02",
"label": "Product02",
"price": 10,
"currency": "EUR",
"competitor": "COMP",
"competitorSku": "P002",
"competitionType": "string",
"country": "Italy",
"priceUnit": 1,
"unitOfMeasure": "string",
"infoDate": "2021-10-25T12:16:28.646Z",
"additionalInfo1": 0,
"additionalInfo2": 100,
"additionalInfo4": "test"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "data": { … }, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.bomtree/{sku}
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.bomtree/{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/productmanager.bomtree/{sku}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "status": 0 } }
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 } }
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