Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Get a DM Object

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

Advanced Configuration Options

Operations

Data Manager

Operations

Get a DM Object

Request

Retrieves the object's (Data Feed, Data Source, Datamart) row level data. A filter can be applied.

If you want to achieve better performance when fetching large data sets and if you do not need the total number of items in the table – use the /datamart.fetchnocount/{typedId} endpoint instead.

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 Product's listProductsResponseExample_resultFields response example.

valueFields: returns just an array of values. Use this option if a better performance is required. See the List Product's listProductsResponseExample_valueFields response example.

When distinctResults is set to true, it applies only to the first column specified in the valueFields array. For example, if "valueFields": ["ConditionType", "TableNumber"] is used, only distinct values for ConditionType are returned.

Please note: When paging is applied, use a deterministic sort (for example, "sortBy":["InvoiceLineID"]). If no sorting is defined when paging, you may get duplicates in the response.

Security
basic or X-PriceFx-jwt
Path
objectIdstringrequired

Use one of the following object identifiers:

  • typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
  • typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)'
  • "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body
Example: 123456.DMDS || DMDS.Transactions || DM.TxDM || *
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
endRownumber
oldValuesany
operationTypestringnon-empty
startRownumber
textMatchStylestringnon-empty
dataobject
sortByArray of strings
resultFieldsArray of strings

The list of fields you want to return.

valueFieldsArray of objects
distinctResultsboolean

set to true to return only unique values.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.fetch/123456.DMDS  || DMDS.Transactions || DM.TxDM || *?timeout=20' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "currency",
          "operator": "iEquals",
          "value": "EUR"
        }
      ]
    },
    "sortBy": [
      "InvoiceLineID"
    ],
    "resultFields": [
      "ProductID",
      "label",
      "unitOfMeasure",
      "currency",
      "formulaName",
      "lastUpdateDate"
    ]
  }'

Responses

OK

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

Get a DM Object

Request

Streams the content of a Data Manager object (e.g. Datamart, Data Source export) as a file. GET variant of the existing POST /datamart.fetch/{objectId}.

Security
basic or X-PriceFx-jwt
Path
objectIdstringrequired

Use one of the following object identifiers:

  • typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
  • typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)'
  • "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body
Example: 123456.DMDS || DMDS.Transactions || DM.TxDM || *
Query
outputstring

Output format.

streamboolean

If true, stream the response.

dataLocalestring

Optional locale for formatted output (e.g. en, de).

typedUniquenamestring

Use the following format: (e.g., DM.TransactionsDM)

curl -i -X GET \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.fetch/123456.DMDS  || DMDS.Transactions || DM.TxDM || *?output=string&stream=true&dataLocale=string&typedUniquename=string'

Responses

Exported data.

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "status": 0,
    "startRow": 0,
    "data": [ … ],
    "endRow": 2
  }
}

Get a DM Object (no count)

Request

Retrieves the object's (Data Feed, Data Source, Datamart) row level data and skips the count() query - it does not return a total number of rows in the entire table when the filter is applied, it returns just the total number of rows in the response.

Information: Use this endpoint when you need a better performance when fetching large data sets and when you do not need to fetch a total number of items in the table. Usually used for integration purposes.

Security
basic or X-PriceFx-jwt
Path
objectIdstringrequired

Use one of the following object identifiers:

  • typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
  • typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)
  • "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body
Bodyapplication/json
endRownumber
oldValuesany
operationTypestringnon-empty
startRownumber
textMatchStylestringnon-empty
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.fetchnocount/{objectId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "attribute4",
          "operator": "iEquals",
          "value": "EUR"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "startRow": 0,
    "data": [ … ],
    "endRow": 0,
    "totalRows": 0,
    "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

Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

MCP

Operations

Clicmanager

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas