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
Performs a search by sku and label fields. Returns all lists containing the search term. Enter the search term in the request body in the q parameter.
Information: Use the /productmanager.quicksearch/{query} (Search a Product (URL)) endpoint to pass the search term in the URL.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.quicksearch
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.quicksearch
- 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.quicksearch \
-H 'Content-Type: application/json' \
-d '{
"data": {
"q": "PROD0001"
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "totalRows": 0, "status": 0 } }
Request
Performs a search by sku and label fields. Returns all lists containing the search term. Enter the search term query URL-encoded to prevent an invalid API call when using special characters in the URL.
Information: Use the /productmanager.quicksearch (Search a Product) endpoint to pass the search term in the request body.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.quicksearch/{query}
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.quicksearch/{query}
- 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.quicksearch/{query}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "totalRows": 0, "status": 0 } }
Request
Retrieves a list of Products. A filter can be applied (see the request example).
You can choose fields to be returned in the response by employing the resultFields or valueFields filter:
resultFields: returns key-value pairs as objects. This is the more friendly response compared to valueFields but the server fetches all fields from the database in the backend which might result in a slower performance. See the listProductsResponseExample_resultFields response example.
valueFields: returns just an array of values. Use this option if a better performance is required. See the listProductsResponseExample_valueFields response example.
Security
basic or X-PriceFx-jwt
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.fetchformulafilteredproducts
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.fetchformulafilteredproducts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- listProductsRequestExample_filter
- listProductsRequestExample_resultFields
- listProductsRequestExample_valueFields
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.fetchformulafilteredproducts \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "currency",
"operator": "iEquals",
"value": "USD"
}
]
}
}'Response
application/json
- listProductsResponseExample_resultFields
- listProductsResponseExample_valueFields
- listProductsResponseExample
{ "response": { "node": "node", "startRow": 0, "data": [ … ], "endRow": 8, "totalRows": 8, "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