Skip to content

The Pricefx Backend API

Pricefx REST API Reference

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

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Create a Manual Price List

Request

Creates a Manual Price List object. The Manual Price List is created without products. Use the /manualpricelistmanager.add/{id} (Add Products to a Manual Price List) endpoint to add products.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
operationTypestringnon-emptyrequired
textMatchStylestringnon-emptyrequired
dataobjectrequired
data.​uniqueNamestringnon-emptyrequired
data.​labelstringnon-empty
data.​validAfterstringnon-emptyrequired
data.​statusstringnon-emptyrequired
data.​nodeIdany
oldValuesany
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/MPL \
  -H 'Content-Type: application/json' \
  -d '{
    "operationType": "add",
    "textMatchStyle": "exact",
    "data": {
      "uniqueName": "MPL01",
      "label": "The Manual Price List 1",
      "validAfter": "2021-12-11T14:11:09.060Z",
      "status": "ACTIVE",
      "nodeId": null
    },
    "oldValues": null
  }'

Responses

Example response

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

Add Products to a Manual Pricelist

Request

Adds products to the previously created Manual Price List and recalculates the Manual Price List.

To add items without a recalculation, use the **/manualpricelistmanager.add/{id} ** endpoint.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List where you want to add products to.

Example: 22
Bodyapplication/json
dataobjectrequired
data.​skusArray of stringsrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.add/22/recalculate \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "skus": [
        "P00001",
        "P00002",
        "P00003"
      ]
    }
  }'

Responses

A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null.

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }

Add Products to a Manual Price List (No Recalculation)

Request

Adds products to the previously created Manual Price List. Use to skip recalculation of comments and manualResultPrice (Manual Override).

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List where you want to add products to.

Example: 22
Bodyapplication/json
dataobjectrequired
data.​skusArray of stringsrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.add/22 \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "skus": [
        "P00001",
        "P00002",
        "P00003"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "string", "data": null, "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

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