Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Update a Manual Price Lis...

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

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Mass Edit a Manual Price List Items

Request

Performs a mass update operation on products in the specified Manual Price List.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List whose products you want to update.

Bodyapplication/json
dataobjectrequired
data.​filterCriteriaobjectrequired
data.​filterCriteria.​_constructorstringnon-emptyrequired
data.​filterCriteria.​operatorstringnon-emptyrequired
data.​filterCriteria.​criteriaArray of objectsnon-emptyuniquerequired
data.​filterCriteria.​criteria[].​fieldNamestringnon-emptyrequired
data.​filterCriteria.​criteria[].​operatorstringnon-emptyrequired
data.​filterCriteria.​criteria[].​valueArray of stringsrequired

Specify ids of the items you want to update.

data.​filterCriteria.​criteria[].​_constructorstringnon-emptyrequired
data.​massEditRecordsArray of objectsnon-emptyuniquerequired
data.​massEditRecords[].​fieldNamestringnon-emptyrequired

The name of the field you want to update.

data.​massEditRecords[].​massEditOperatorstringnon-emptyrequired

Can be either one of these valid operators: + - * If omitted, the provided value is set (= operator). Otherwise the specified operation is applied.

data.​massEditRecords[].​fieldValuestringnon-emptyrequired

The new value of the field. If omitted, the field is set to null.

data.​massEditRecords[].​precisionany
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.massedit/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "filterCriteria": {
        "_constructor": "AdvancedCriteria",
        "operator": "and",
        "criteria": [
          {
            "fieldName": "id",
            "operator": "inSet",
            "value": [
              "94",
              "95"
            ],
            "_constructor": "AdvancedCriteria"
          }
        ]
      },
      "massEditRecords": [
        {
          "fieldName": "currency",
          "massEditOperator": "=",
          "fieldValue": "USD",
          "precision": null
        }
      ]
    }
  }'

Responses

OK

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

Update a Manual Price List Item

Request

Updates an item and recalculates the specified Manual Price List.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List whose item you want to update.

Bodyapplication/json
dataobjectrequired
data.​typedIdstringrequired

typedId of the item (MPLI) you want to update.

data.​currencystring
oldValuesobject(ManualPricelistItem)

The type code is MPLI.

operationTypestring
textMatchStylestring
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.update/{id}/recalculate' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "111.MPLI",
      "currency": "USD"
    },
    "oldValues": {
      "version": 2,
      "typedId": "111.MPLI",
      "sku": "B-0003",
      "label": "Rise of the Phoenix",
      "unitOfMeasure": "",
      "currency": "EUR",
      "comments": null,
      "pricelistId": 226,
      "lastUpdateByName": "admin",
      "createdByName": null,
      "createDate": "2023-06-02T10:29:21",
      "createdBy": 2147490696,
      "lastUpdateDate": "2023-06-02T10:29:21",
      "lastUpdateBy": 2147490696,
      "attribute1": null,
      "attribute2": null,
      "attribute3": null,
      "attribute4": null,
      "attribute5": null,
      "attribute6": null,
      "attribute7": null,
      "attribute8": null,
      "attribute9": null,
      "attribute10": null,
      "attribute11": null,
      "attribute12": null,
      "attribute13": null,
      "attribute14": null,
      "attribute15": null,
      "attribute16": null,
      "attribute17": null,
      "attribute18": null,
      "attribute19": null,
      "attribute20": null,
      "attribute21": null,
      "attribute22": null,
      "attribute23": null,
      "attribute24": null,
      "attribute25": null,
      "attribute26": null,
      "attribute27": null,
      "attribute28": null,
      "attribute29": null,
      "attribute30": null,
      "_key": "111.MPLI",
      "_level": 0
    },
    "operationType": "update",
    "textMatchStyle": "exact"
  }'

Responses

OK

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

Upsert a Product in a Manual Price List

Request

Adds or updates a product in the specified Manual Price List.

To add a new product that does not exist, specify the sku parameter in the request.

To update an existing product, specify the sku or typedId parameter of the existing product. The /integrate method performs a partial update – it does not delete values from fields that have not been specified in the update request.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List whose product you want to create or update.

Bodyapplication/json
dataobjectrequired
data.​skustringnon-emptyrequired
data.​labelstringnon-empty
data.​currencystringnon-empty
data.​commentsstringnon-empty
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.integrate/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "sku": "P00110101",
      "label": "tofu",
      "currency": "USD",
      "comments": "The final version."
    }
  }'

Responses

Returns full record details.

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

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