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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/SX
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/SX
- 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/add/SX \
-H 'Content-Type: application/json' \
-d '{
"data": {
"name": "SXTest",
"sellerId": "Seller023"
},
"operation": "add"
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/sellermanager.fetch/{SellerId}/SX/{SXCategory}
- URL:https://companynode.pricefx.com/pricefx/companypartition/sellermanager.fetch/{SellerId}/SX/{SXCategory}
- 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/sellermanager.fetch/SC-001/SX/SalesOrganizationResponse
application/json
{ "repsonse": { "status": 0, "node": "node", "data": [ … ], "endRow": 1 } }
Request
Retrieves all Seller Extensions.
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 List Customers' listCustomersResponseExample_resultFields response example.
valueFields: returns just an array of values. Use this option if a better performance is required. See the List Customers' listCustomersResponseExample_valueFields response example.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/sellermanager.fetch/*/SX/{SXCategory}
- URL:https://companynode.pricefx.com/pricefx/companypartition/sellermanager.fetch/*/SX/{SXCategory}
- 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/sellermanager.fetch/*/SX/SalesOrganization'Response
application/json
{ "response": { "status": 0, "node": "node", "data": [ … ], "endRow": 1 } }
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