The Pricefx Backend API

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/PGTT \
  -H 'Content-Type: application/json' \
  -d '{
    "operationType": "remove",
    "textMatchStyle": "exact",
    "data": {
      "typedId": "9.PGTT"
    }
  }'

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/PGTT \
  -H 'Content-Type: application/json' \
  -d '{
    "operationType": "add",
    "textMatchStyle": "exact",
    "data": {
      "uniqueName": "Price Grid Type 1",
      "label": "Price Grid Type 1 Label",
      "targetDate": "2030-01-01",
      "userGroupViewDetails": "Group A",
      "userGroupEdit": "Group B",
      "userGroupCanUseType": "Group C",
      "headerFormulaName": "Header Formula",
      "dimensionType": "MATRIX",
      "calculationFormulaName": "Formula A",
      "matrixFormulaName": "Matrix Keys Generation Formula",
      "matrixFormulaElementName": "Element 123",
      "typeConfiguration": {
        "relativeTargetDateDays": 3,
        "preferencesSource": "123",
        "headerInputs": [
          {
            "name": "input",
            "label": "input",
            "type": "INTEGERUSERENTRY",
            "value": 10,
            "inputs": []
          }
        ],
        "shotgunModeEnabled": false,
        "allowColumnTypeChange": false,
        "resultElementName": "resultPrice",
        "dynamicItemMode": "ADD_ONLY",
        "productFilterCriteria": {
          "_constructor": "AdvancedCriteria",
          "operator": "and",
          "criteria": [
            {
              "fieldName": "sku",
              "operator": "inSet",
              "value": [
                "B-0001",
                "B-0002"
              ]
            }
          ]
        },
        "uomOverrideElementName": "SecretFormula",
        "currencyOverrideElementName": "currencyElement",
        "autoApproveElementName": "resultPrice",
        "manualResultExpiryElementName": "ElementB",
        "maxIncreasePct": 1,
        "maxDecreasePct": 2,
        "calculationLogicInputs": [
          {
            "name": "Configuration",
            "label": "Configuration",
            "url": "ConfiguratorWithOptionsInputEntries",
            "type": "CONFIGURATOR",
            "value": {},
            "inputs": [],
            "parameterConfig": {},
            "formattingOptions": {}
          },
          {
            "name": "warning",
            "label": "Add Warning?",
            "type": "BOOLEANUSERENTRY",
            "value": false,
            "inputs": []
          },
          {
            "name": "Quantity",
            "label": "Quantity",
            "type": "USERENTRY",
            "value": 100,
            "inputs": [],
            "parameterConfig": {
              "dataType": "float"
            }
          },
          {
            "name": "MassiveDiscount",
            "label": "MassiveDiscount",
            "lookupTableId": "2147483653",
            "url": "/lookuptablemanager.fetch/2147483653",
            "type": "LOOKUP",
            "inputs": [],
            "parameterConfig": {},
            "formattingOptions": {}
          },
          {
            "name": "Customer",
            "label": "Customer",
            "lookupTableId": "2147483653",
            "url": "/fetch/C/",
            "type": "CUSTOMER",
            "inputs": [],
            "parameterConfig": {},
            "formattingOptions": {}
          },
          {
            "name": "Decimal Places",
            "label": "Decimal Places?",
            "type": "OPTION",
            "inputs": [],
            "parameterConfig": {
              "dataType": "integer",
              "inputType": "drop-down"
            },
            "formattingOptions": {},
            "valueOptions": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5"
            ]
          },
          {
            "name": "Surcharge",
            "label": "Surcharge",
            "type": "MULTITIERENTRY",
            "valueHint": "each^^^€",
            "inputs": [],
            "parameterConfig": {},
            "formattingOptions": {}
          }
        ],
        "elementNames": [
          "testFormula",
          "ElementB",
          "resultPrice",
          "SecretFormula",
          "currencyElement"
        ],
        "hiddenElementNames": [
          "SecretFormula"
        ],
        "approvalTriggerFields": [
          "SecretFormula"
        ],
        "userCanToggleVisibility": [
          "SecretFormula"
        ],
        "approvalMappings": [
          "testFormula"
        ],
        "overridableFields": [
          "calculationLogic"
        ],
        "calcLogicInputsOverridableFields": [
          "Input A"
        ]
      },
      "customActionLogics": {
        "key1": "value"
      },
      "contextualActions": {
        "key2": "value"
      },
      "buttonsConfiguration": {
        "key3": "value"
      }
    }
  }'

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/PGTT \
  -H 'Content-Type: application/json' \
  -d '{
    "operationType": "update",
    "textMatchStyle": "exact",
    "data": {
      "typedId": "7.PGTT",
      "uniqueName": "Simple Price Grid Type 1 - New Name",
      "label": "Simple Price Grid Type 1 Label",
      "createdByName": "john.doe",
      "lastUpdateByName": "john.doe",
      "targetDate": "2030-01-01",
      "userGroupEdit": "Group B",
      "userGroupViewDetails": "Group A",
      "userGroupCanUseType": "Group C",
      "typeConfiguration": {
        "elementNames": [
          "testFormula",
          "ElementB",
          "resultPrice"
        ],
        "dynamicItemMode": "ADD_ONLY",
        "resultElementName": "resultPrice"
      },
      "buttonsConfiguration": {},
      "headerFormulaName": "Header Formula",
      "dimensionType": "SIMPLE",
      "calculationFormulaName": "Formula A",
      "matrixFormulaName": "Matrix Keys Generation Formula",
      "matrixFormulaElementName": "Element",
      "customActionLogics": "{key1=value}",
      "contextualActions": {},
      "createDate": "2024-10-08T12:21:41",
      "createdBy": 2147492568,
      "lastUpdateDate": "2024-10-08T12:21:41",
      "lastUpdateBy": 2147492568,
      "id": 7
    },
    "oldValues": {
      "version": 0,
      "typedId": "7.PGTT",
      "uniqueName": "Simple Price Grid Type 1",
      "label": "Simple Price Grid Type 1 Label",
      "createdByName": "john.doe",
      "lastUpdateByName": "john.doe",
      "targetDate": "2030-01-01",
      "userGroupEdit": "Group B",
      "userGroupViewDetails": "Group A",
      "userGroupCanUseType": "Group C",
      "typeConfiguration": {
        "elementNames": [
          "testFormula",
          "ElementB",
          "resultPrice"
        ],
        "dynamicItemMode": "ADD_ONLY",
        "resultElementName": "resultPrice"
      },
      "buttonsConfiguration": {},
      "headerFormulaName": "Header Formula",
      "dimensionType": "SIMPLE",
      "calculationFormulaName": "Formula A",
      "matrixFormulaName": "Matrix Keys Generation Formula",
      "matrixFormulaElementName": "Element",
      "customActionLogics": "{key1=value}",
      "contextualActions": {},
      "createDate": "2024-10-08T12:21:41",
      "createdBy": 2147492568,
      "lastUpdateDate": "2024-10-08T12:21:41",
      "lastUpdateBy": 2147492568,
      "id": 7
    }
  }'