Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Update a Data Change Requ...

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

Get a Data Change Request (changes only)

Request

Retrieves changed items of the specified Data Change Request.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

id of the Data Change Request you want to retrieve changed items for.

Bodyapplication/json
endRowintegerrequired
operationTypestringrequired
startRowintegerrequired
textMatchStylestringrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/dcrmanager.fetch/{id}/changesOnly' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact"
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "pricefx-cluster-app-frontend-7577dc88d5-pztr7",
    "startRow": 0,
    "data": [ … ],
    "endRow": 1,
    "totalRows": 1,
    "status": 0
  }
}

Update a Data Change Request Item

Request

Updates a Data Change Request Item (DCRI).

Security
basic or X-PriceFx-jwt
Path
idstringrequired

id of the Data Change Request whose item you want to update.

Bodyapplication/json
dataobjectrequired
data.​typedIdstringrequired

typedId of the item you want to update.

data.​currencystring
oldValuesobject(DataChangeRequestItem)required

The type code is DCRI.

oldValues.​key1string or null<= 255 characters
oldValues.​changeRequestIdinteger
oldValues.​key2string or null<= 255 characters
oldValues.​typedIdstring
oldValues.​key5string or null<= 100 characters
oldValues.​key6string or null<= 100 characters
oldValues.​key3string or null<= 255 characters
oldValues.​lastUpdateDatestring(date-time)
oldValues.​key4string or null<= 150 characters
oldValues.​approvalReasonstring or null<= 255 characters
oldValues.​skustring<= 255 characters
oldValues.​unitOfMeasurestring or null<= 255 characters
oldValues.​versioninteger
oldValues.​attribute9any
oldValues.​deleteRowboolean
oldValues.​attribute8any
oldValues.​attribute5any
oldValues.​attribute4any
oldValues.​attribute7any
oldValues.​attribute6any
oldValues.​namestring or null<= 255 characters
oldValues.​attribute1any
oldValues.​attribute14any
oldValues.​attribute13any
oldValues.​attribute3any
oldValues.​attribute12any
oldValues.​attribute2any
oldValues.​attribute11any
oldValues.​attribute10any
oldValues.​attribute19any
oldValues.​attribute18any
oldValues.​attribute17any
oldValues.​itemTypedIdany
oldValues.​attribute16any
oldValues.​attribute15any
oldValues.​oldValuesobject or null
oldValues.​ignoreChangeboolean
oldValues.​customerIdstring or null<= 255 characters
oldValues.​attribute25any
oldValues.​attribute24any
oldValues.​currencystring or null<= 255 characters
oldValues.​attribute23any
oldValues.​attribute22any
oldValues.​attribute21any
oldValues.​valuestring or null<= 255 characters
oldValues.​attribute20any
oldValues.​createDatestring(date-time)
oldValues.​commentsstring or null<= 255 characters
oldValues.​attribute29any
oldValues.​attribute28any
oldValues.​attribute27any
oldValues.​attribute26any
oldValues.​labelstring or null<= 255 characters
oldValues.​createdByinteger
oldValues.​changeRefobject or null
oldValues.​attribute30any
oldValues.​lastUpdateByinteger
operationTypestring
textMatchStylestring
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/dcrmanager.update/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "string",
      "currency": "string"
    },
    "oldValues": {
      "key1": "string",
      "changeRequestId": 0,
      "key2": "string",
      "typedId": "string",
      "key5": "string",
      "key6": "string",
      "key3": "string",
      "lastUpdateDate": "2019-08-24T14:15:22Z",
      "key4": "string",
      "approvalReason": "string",
      "sku": "string",
      "unitOfMeasure": "string",
      "version": 0,
      "attribute9": null,
      "deleteRow": true,
      "attribute8": null,
      "attribute5": null,
      "attribute4": null,
      "attribute7": null,
      "attribute6": null,
      "name": "string",
      "attribute1": null,
      "attribute14": null,
      "attribute13": null,
      "attribute3": null,
      "attribute12": null,
      "attribute2": null,
      "attribute11": null,
      "attribute10": null,
      "attribute19": null,
      "attribute18": null,
      "attribute17": null,
      "itemTypedId": null,
      "attribute16": null,
      "attribute15": null,
      "oldValues": {
        "property1": {
          "oldValue": "string",
          "newValue": "string"
        },
        "property2": {
          "oldValue": "string",
          "newValue": "string"
        }
      },
      "ignoreChange": true,
      "customerId": "string",
      "attribute25": null,
      "attribute24": null,
      "currency": "string",
      "attribute23": null,
      "attribute22": null,
      "attribute21": null,
      "value": "string",
      "attribute20": null,
      "createDate": "2019-08-24T14:15:22Z",
      "comments": "string",
      "attribute29": null,
      "attribute28": null,
      "attribute27": null,
      "attribute26": null,
      "label": "string",
      "createdBy": 0,
      "changeRef": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "attribute30": null,
      "lastUpdateBy": 0
    },
    "operationType": "string",
    "textMatchStyle": "string"
  }'

Responses

OK

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

Delete a Data Change Request Item

Request

Removes the item from the specified Data Change Request.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

id of the Data Change Request whose item you want to delete.

Bodyapplication/json
dataobjectrequired
data.​typedIdstringrequired
operationTypestringrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/dcrmanager.delete/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "string"
    },
    "operationType": "string"
  }'

Responses

OK

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

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

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