Pricefx REST API Reference
Pricefx REST API
/Metadata
Master
General
Products
Product Extensions
Product Image
Customers
Customer Extensions
Sellers
Seller Extensions
Condition Records
Competition Data
Imports
Data Change Requests
Lookup Tables / Company Parameters
User Admin
Authentication
Admin Tools
Logics
Logs
Custom Forms
Calculated Field Sets
Jobs & Tasks
Data Manager
Actions
Action Types
Price Lists
Manual Price Lists
Live Price Grids
Calculation Grids
Visual Configuration
Quotes
Contracts (Agreements & Promotions)
Visual Configuration
Rebate Agreements
Rebate Calculations
Rebate Record Group
Sales Compensations
Claim Types
Claims
Optimization
Workflow
Workflow Delegation
Attachments
Product Image
Configuration
Internationalization
Clicmanager
Comments
Notifications
Heartbeat
Key-Value Store
Entities
otherSchemas
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
Retrieves information (data type, maximum length, possible values, whether the field is required, etc.) about fields of the specified entity.
Security
basic or X-PriceFx-jwt
Path
Enter the type code of the entity you want to retrieve information for. See the list of Type Codes in the Pricefx Knowledge Base article.
Enum"ACTT""AI""AP""APIK""BD""BPT""BR""C""CA""CAM"
Example: P
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/metadata.describe/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/metadata.describe/{TypeCode}
- 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/metadata.describe/P?name=string&lookupTableId=string'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Path
Enter the type code of the entity you want to retrieve information for. See the list of Type Codes in the Pricefx Knowledge Base article.
Enum"ACTT""AI""AP""APIK""BD""BPT""BR""C""CA""CAM"
Example: P
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/metadata.fetch/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/metadata.fetch/{TypeCode}
- 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/metadata.fetch/P?name=string&lookupTableId=string'Response
application/json
{ "response": { "node": "string", "csrfToken": "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