Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Create a Data Manager Ent...

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

Update a Data Manager Entity

Request

Updates and deploys a field collection (FC) definition - Data Feed (DMF), Datamart (DM), or Data Source (DMDS).

Information: If Data Source (DMDS) is added or updated, then a Data Feed (DMF) is created for the corresponding Data Source.

Security
basic or X-PriceFx-jwt
Path
TypeCodestringrequired

The type code of the Field Collection you want to update.

Enum"DMF""DM""DMDS"
Example: DM
Bodyapplication/json

Either uniqueName or typedId must be provided in the request.

operationTypestringnon-empty
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.updatefc/DM \
  -H 'Content-Type: application/json' \
  -d '{
    "operationType": "update",
    "data": {
      "version": 4,
      "typedId": "2147483684.DMF",
      "uniqueName": "Meatball_transaction",
      "label": "Meatball_transaction",
      "sourceFile": null,
      "fields": [
        {
          "name": "attribute1",
          "label": "InvoiceDate",
          "labelTranslations": {},
          "rank": 1,
          "format": null,
          "measureType": null,
          "functionalType": null,
          "visibility": 1,
          "defaultValue": null,
          "sourceField": null,
          "expression": "attribute1",
          "function": null,
          "formulaElement": null,
          "messages": null,
          "key": false,
          "system": false,
          "numeric": false,
          "deleted": false,
          "persisted": true,
          "dimension": false,
          "calculated": false,
          "dbColumn": "attribute1",
          "aggregation": false,
          "time": false,
          "partitioningKey": false,
          "queryable": true,
          "auxiliary": false,
          "deployed": true,
          "dbTable": "seeddata_DMF_Meatball_transaction",
          "type": "TEXT",
          "source": "DMF.Meatball_transaction",
          "owningFC": "Meatball_transaction",
          "hidden": false
        },
        {
          "name": "completeResultsAvailable",
          "label": "Details",
          "labelTranslations": {},
          "rank": 36,
          "format": null,
          "measureType": null,
          "functionalType": null,
          "visibility": 0,
          "defaultValue": null,
          "sourceField": null,
          "expression": "NOT ISNULL(formulaDetailedResults)",
          "function": null,
          "formulaElement": null,
          "messages": null,
          "key": false,
          "system": true,
          "numeric": false,
          "deleted": false,
          "persisted": false,
          "dimension": false,
          "calculated": true,
          "dbColumn": "attribute1",
          "aggregation": false,
          "time": false,
          "partitioningKey": false,
          "queryable": true,
          "auxiliary": true,
          "deployed": false,
          "dbTable": "seeddata_DMF_Meatball_transaction",
          "type": "BOOLEAN",
          "source": "DMF.Meatball_transaction",
          "owningFC": "[System]",
          "hidden": true
        }
      ],
      "keyFields": [],
      "formulaName": null,
      "reload": false,
      "messages": null,
      "reservedWords": null,
      "rowCount": null,
      "lastUpdateByName": "ondrej.tesar",
      "defaultDataSourceName": "DMDS.Meatball_transaction",
      "lineSeperator": null,
      "fieldSeperator": null,
      "quoteChar": null,
      "fetchVerb": "datamart.fetch/2147483684.DMF",
      "integrateVerb": null,
      "bulkloadVerb": "datamart.loaddata/Meatball_transaction",
      "identikitCriteria": null,
      "draft": false,
      "queryable": true,
      "view": false,
      "sourceName": "DMF.Meatball_transaction",
      "type": "FEED",
      "valid": true,
      "status": null,
      "targetDate": null,
      "calculationMessages": null,
      "loadableFields": [
        "attribute1",
        "attribute2",
        "attribute3",
        "attribute4",
        "attribute5",
        "attribute6",
        "attribute7",
        "attribute8",
        "attribute9",
        "attribute10",
        "attribute11",
        "attribute12",
        "attribute13",
        "attribute14",
        "attribute15",
        "attribute16",
        "attribute17",
        "attribute18",
        "attribute19",
        "attribute20",
        "attribute21",
        "attribute22",
        "attribute23",
        "attribute24",
        "attribute25",
        "attribute26",
        "attribute27"
      ],
      "auxiliary": false,
      "deployed": true,
      "dbTable": "seeddata_DMF_Meatball_transaction",
      "dbKey": "",
      "dbView": null,
      "locked": false,
      "createDate": "2018-10-04T17:09:00",
      "createdBy": 2147483649,
      "lastUpdateDate": "2021-12-03T13:34:00",
      "lastUpdateBy": 2147490187,
      "query": null,
      "lastDataModificationDate": "2021-12-02T00:09:03",
      "typeCode": null,
      "isPlasma": false,
      "calculationStartDate": null,
      "calculationDate": null
    }
  }'

Responses

Example response

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "node",
    "csrfToken": "tkn",
    "data": [ … ],
    "endRow": 1,
    "status": 0
  }
}

Create a Data Manager Entity

Request

Creates a field collection (FC) definition - Data Feed (DMF), Datamart (DM), or Data Source (DMDS).

Security
basic or X-PriceFx-jwt
Path
TypeCodestringrequired

The type code of the Field Collection you want to update.

Enum"DMF""DM""DMDS"
Example: DM
Bodyapplication/json

Either uniqueName or typedId must be provided in the request.

dataobjectrequired
data.​uniqueNamestringnon-emptyrequired

The name of the field collection. Special characters are not allowed, except the underscore ("_").

data.​labelstringnon-emptyrequired

The label for the new Datamart, Data Source, or Data Feed.

data.​persistedObjectClassstringnon-empty

Fully qualified name of the domain class whose persisted objects the Data Source is based on.

data.​sourceLabelstringnon-empty

Label of the source master object or template from which the Data Source was created.

data.​sourceTypeCodestringnon-empty

Short type code identifying the kind of master object the Data Source is based on.

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.newfc/DM \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "uniqueName": "DataSource01",
      "label": "Data Source 1"
    }
  }'

Responses

Example response

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "node",
    "csrfToken": "tkn",
    "data": [ … ],
    "endRow": 1,
    "status": 0
  }
}

Upload a Bulk Data to Data Source

Request

Uploads a chunk (batch) of data from a client resource to the storage reserved for a particular Data Source.

The uploaded data is not immediately transfered to the Data Source database table. Instead it is held (‘buffered’) in a staging area, until an explicit flush command is issued (refer to the /datamart.rundataload endpoint, "type": "DS_FLUSH"), or a Datamart dependent on the Data Source data is refreshed.

Security
basic or X-PriceFx-jwt
Path
datasourceUniqueNamestringrequired

The unique name of the Data Source where you want to upload the data to. You can also use typedId or the source name.

Bodyapplication/json
dataobjectrequired
data.​headerArray of stringsrequired

Specify header field names (table columns) of the record in the target Data Source.

data.​optionsobject

Specify options of the bulk data insertion.

data.​dataArray of anyrequired

The data as a list of lists, with the inner lists representing rows, its field values appearing in the same order as specified in the header list.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.loaddata/{datasourceUniqueName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "header": [
        "sku",
        "label",
        "attribute1",
        "attribute2"
      ],
      "options": {
        "detectJoinFields": true
      },
      "data": [
        [
          "11111",
          "Label One",
          "EA",
          "USD"
        ],
        [
          "22222",
          "Label Two",
          "EA",
          "EUR"
        ],
        [
          "33333",
          "Label Three",
          "EA",
          "CZK"
        ]
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": [ … ],
    "status": 0
  }
}

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