Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Export an Excel File (XLS...

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Import a Data Load

Request

Imports a list of Data Load definitions. Existing definitions will be updated.

Information: Omitting a property is equivalent to setting it to null. With one exception: a previously existing incLoadDate will be retained.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​dataLoadsArray of objectsnon-emptyuniquerequired
data.​dataLoads[].​typedIdstringnon-emptyrequired
data.​dataLoads[].​typestringnon-emptyrequired
data.​dataLoads[].​targetNamestringnon-emptyrequired
data.​dataLoads[].​sourceNamestringnon-empty
data.​dataLoads[].​continuousboolean
data.​dataLoads[].​incrementalboolean
data.​dataLoads[].​incLoadDatestringnon-empty
data.​dataLoads[].​calculationMessagesArray of objects
data.​dataLoads[].​validstringnon-empty
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.importdataloads \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "dataLoads": [
        {
          "typedId": "string",
          "type": "string",
          "targetName": "string",
          "sourceName": "string",
          "continuous": true,
          "incremental": true,
          "incLoadDate": "string",
          "calculationMessages": [
            {}
          ],
          "valid": "string"
        }
      ]
    }
  }'

Responses

OK

Export an Excel File (XLSX)

Request

Downloads an XLSX file. The returned file contains all definitions (meta) and the data. This is useful for importing the Data Source, Datamart, or Data Feed definitions + data in some other instance or partition.

Security
basic or X-PriceFx-jwt
Query
timeoutstring

Set this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables).

Default "60"
Example: timeout=20
Bodyapplication/json
dataobjectrequired
data.​fieldCollectionsArray of stringsrequired
data.​sanitizebooleanrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.exportdata/xlsx?timeout=20' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "fieldCollections": [
        "DMDS.Transactions"
      ],
      "sanitize": true
    }
  }'

Responses

OK - returns the XLSX file (binary data): Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Export a CSV File

Request

Downloads a ZIP file. The returned ZIP file contains Data Source, Datamart, or Data Feed definitions in the JSON file and data in the CSV file.

Security
basic or X-PriceFx-jwt
Query
timeoutstring

Set this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables).

Default "60"
Example: timeout=20
Bodyapplication/json
dataobjectrequired
data.​fieldCollectionsArray of stringsrequired
data.​sanitizebooleanrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.exportdata?timeout=20' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "fieldCollections": [
        "DMDS.Transactions"
      ],
      "sanitize": true
    }
  }'

Responses

OK - returns the ZIP file (binary data): Content-Type: application/zip

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

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.

otherSchemas

Schemas