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
Uploads CSV, or XLSX file to Product Extensions, Customer Extensions, or Seller Extensions table.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/importfile/{TypeCode}/{target}/{uploadSlotId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/importfile/{TypeCode}/{target}/{uploadSlotId}
- 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/importfile/PX/{target}/5000?truncate=false' \
-H 'Content-Type: multipart/form-data' \
-F file=stringResponse
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
Request
Extended fetch command to retrieve product attribute meta data.
Unlike the general fetch/{typeCode} endpoint, this extended endpoint also handles global metadata configurations.
For example, if product metadata is configured to originate from the global partition, this command will automatically retrieve it from there. In contrast, the general fetch endpoint is limited to returning data exclusively from the local partition.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productmanager.fetchpxam
- URL:https://companynode.pricefx.com/pricefx/companypartition/productmanager.fetchpxam
- 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.fetchpxam \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7bcc977f5c-h5m76", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "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