Page Comparison

...

Action

Description

Request

Response

Get a list of Price Lists

Fetches a list of Price Lists existing in the partition.

/pricefx/{partition}/fetch/PL

Code Block

title	Payload
collapse	true

{
  "startRow": 0,
  "endRow": 300,
  "data": {}
}

Code Block

title	Response
collapse	true

{
  "response": {
    "node": "user1",
    "startRow": 0,
    "data": [
      {
        "version": 6,
        "typedId": "14239.PL",
        "targetDate": "2015-08-24",
        "label": "TC based Price List",
        "locale": "en",
        "calculationMessages": "[\"(10) Formula not found for 10\"]",
        "numberOfItems": 49,
        "keepManualOverrides": false,
        "writeOnlyChangedItems": false,
        "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Rebate\",\"Target_Discount\",
         \"Base\",\"Prod_Class_Adj\",\"StandardDiscount\",\"Volume_Discount\",\"Invoice_Price\"],\"hiddenElementNames\":[],
         \"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"TC_Logic\",
         \"formulaParameters\":{\"Customer\":\"CD-00081\"},\"notifyWhenFinished\":\"NONE\"}",
        "errorMode": "ABORT",
        "pricelistType": "SIMPLE",
        "approvalState": "NOT_APPROVED",
        "createdByName": "admin",
        "lastUpdateByName": "admin",
        "updatedBy": 5351,
        "updateDate": "2020-02-27",
        "createDate": "2015-08-24T08:59:11",
        "createdBy": 51,
        "lastUpdateDate": "2020-02-27T14:42:04",
        "lastUpdateBy": 5351,
        "status": "READY",
        "calculationStartDate": "2020-02-27T14:42:04",
        "calculationDate": "2020-02-27T14:42:04",
        "id": 14239
      },
      {
        "version": 11,
        "typedId": "14240.PL",
        "targetDate": "2015-08-24",
        "label": "TEST TO REMOVE",
        "locale": "en",
        "calculationMessages": "[]",
        "numberOfItems": 0,
        "keepManualOverrides": false,
        "writeOnlyChangedItems": false,
        "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Target_Discount\",\"StandardDiscount\",\"Volume_Discount\",
         \"Invoice_Price\"],\"hiddenElementNames\":[],\"productFilterCriteria\":{\"operator\":\"and\",\"_constructor\":\"AdvancedCriteria\",
         \"criteria\":[{\"fieldName\":\"sku\",\"operator\":\"iContainsPattern\",\"value\":\"0001\",\"_constructor\":\"AdvancedCriteria\"}]},
         \"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"TC_Logic\",
         \"formulaParameters\":{\"Customer\":null,\"quantity\":null}}",
        "errorMode": "ABORT",
        "pricelistType": "SIMPLE",
        "approvalState": "NOT_APPROVED",
        "createdByName": "admin",
        "lastUpdateByName": "admin",
        "updatedBy": 5308,
        "updateDate": "2017-07-19",
        "createDate": "2015-08-24T09:05:42",
        "createdBy": 51,
        "lastUpdateDate": "2017-07-19T10:16:58",
        "lastUpdateBy": 5308,
        "status": "READY",
        "calculationStartDate": "2015-10-08T10:50:56",
        "calculationDate": "2015-10-08T10:50:56",
        "id": 14240
      }
    ],
    "endRow": 2,
    "totalRows": 2,
    "status": 0
  }
}

Retrieve a Price List

Fetches basic data about the specified Price List (not its content).

/pricefx/{partition}/fetch/PL/{PriceListID}

Code Block

title	Response
collapse	true

{
    "response": {
        "node": "user1",
        "data": [
            {
                "version": 6,
                "typedId": "14239.PL",
                "targetDate": "2015-08-24",
                "label": "My Price List",
                "locale": "en",
                "calculationMessages": "[\"(10) Formula not found for 10\"]",
                "numberOfItems": 49,
                "keepManualOverrides": false,
                "writeOnlyChangedItems": false,
                "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Rebate\",
                \"Target_Discount\",\"Base\",\"Prod_Class_Adj\",
                \"StandardDiscount\",\"Volume_Discount\",\"Invoice_Price\"],
                \"hiddenElementNames\":[],\"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false,
                \"defaultFormulaOverride\":\"TC_Logic\",
                \"formulaParameters\":{\"Customer\":\"CD-00081\"},\"notifyWhenFinished\":\"NONE\"}",
                "errorMode": "ABORT",
                "pricelistType": "SIMPLE",
                "approvalState": "NOT_APPROVED",
                "createdByName": "admin",
                "lastUpdateByName": "admin",
                "updatedBy": 5351,
                "updateDate": "2020-02-27",
                "createDate": "2015-08-24T08:59:11",
                "createdBy": 51,
                "lastUpdateDate": "2020-02-27T14:42:04",
                "lastUpdateBy": 5351,
                "status": "READY",
                "calculationStartDate": "2020-02-27T14:42:04",
                "calculationDate": "2020-02-27T14:42:04",
                "id": 14239
            }
        ],
        "status": 0
    }
}

Retrieve a complete Price List

Fetches the full content of the Price List, which can be thousands of rows. The PL is specified by the PriceListID path parameter.

If there are no products in the PL (numberOfItems = 0), an empty array is returned.

/pricefx/{partition}/pricelistmanager.fetch/{PriceListID}

Code Block

title	Payload
collapse	true

{
  "startRow": 0,
  "endRow": 300,
  "data": {}
}

Code Block

title	Response
collapse	true

{
  "response": {
    "node": "user1",
    "startRow": 0,
    "data": [
      {
        "version": 0,
        "typedId": "1851850.PLI",
        "sku": "MB-0034",
        "label": " Sausage LS",
        "unitOfMeasure": "1 EA",
        "currency": "EUR",
        "resultPrice": 16.34763,
        "alerts": "{}",
        "warnings": "{\"Volume_Discount\":[\"UserEntry parameter not found: quantity\",\"VLookup - Volume - called without key\"]}",
        "allowedOverrides": "",
        "calculatedResultPrice": 16.34763,
        "tainted": false,
        "pricelistId": 14239,
        "updateDate": "2015-08-24",
        "createDate": "2015-08-24T08:59:21",
        "lastUpdateDate": "2015-08-24T08:59:21",
        "attribute1": 12.25,
        "attribute2": 5.7575,
        "attribute3": 19.2325,
        "attribute4": 0.1,
        "attribute5": 2.884875,
        "attribute6": 0,
        "attribute7": 16.347625,
        "attribute8": 1.6347625,
        "attribute9": 0.3345,
        "completeResultsAvailable": true,
        "itemExtensions": {}
      },
      {
        "version": 0,
        "typedId": "1851851.PLI",
        "sku": "MB-0028",
        "label": " Sausage BS",
        "unitOfMeasure": "1 EA",
        "currency": "EUR",
        "resultPrice": 11.7453,
        "alerts": "{}",
        "warnings": "{\"Volume_Discount\":[\"UserEntry parameter not found: quantity\",\"VLookup - Volume - called without key\"]}",
        "allowedOverrides": "",
        "calculatedResultPrice": 11.7453,
        "tainted": false,
        "pricelistId": 14239,
        "updateDate": "2015-08-24",
        "createDate": "2015-08-24T08:59:21",
        "lastUpdateDate": "2015-08-24T08:59:21",
        "attribute1": 9.8,
        "attribute2": 2.45,
        "attribute3": 13.818,
        "attribute4": 0.1,
        "attribute5": 2.0727,
        "attribute6": 0,
        "attribute7": 11.7453,
        "attribute8": 1.17453,
        "attribute9": 0.1985,
        "completeResultsAvailable": true,
        "itemExtensions": {}
      }
    ],
    "endRow": 2,
    "totalRows": 2,
    "status": 0
  }
}

Get a (filtered) list of LPGs

Fetches a list of LPGs. The payload example applies a filter to fetch only LPGs with the status "Ready" and last updated by admin.

/pricefx/{partition}/fetch/PG

Code Block

title	Payload
collapse	true

// filtered by Status - fetch only LPGs whose status is Ready
{
  "data": {
    "criteria": [
      { "fieldName": "status", "operator": "equals", "value": "READY" },{"fieldName": "lastUpdateByName",  "operator": "equals", "value": "admin"}
    ]
  }
}

Code Block

title	Response
collapse	true

{
  "response": {
    "node": "user1",
    "startRow": 0,
    "data": [
      {
        "version": 8,
        "typedId": "2147483791.PG",
        "label": "CurrentContextTest",
        "calculationMessages": "[]",
        "numberOfItems": 1,
        "keepManualOverrides": false,
        "writeOnlyChangedItems": false,
        "configuration": "{\"elementNames\":[\"Number2\",\"Number1\",\"Result\"],\"hiddenElementNames\":[],\"hiddenDefaultFields\":[],
         \"productFilterCriteria\":{\"operator\":\"and\",\"_constructor\":\"AdvancedCriteria\",\"criteria\":[{\"fieldName\":\"sku\",
         \"operator\":\"iContains\",\"value\":\"1234567\",\"_constructor\":\"AdvancedCriteria\"}]},\"resultElementName\":\"Result\",
         \"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"CurrentContextTest\",\"inputs\":[],
         \"approvalTriggerFields\":[],\"productFilterMode\":\"auto\",\"allowFieldTypeChange\":false}",
        "nodeId": 9,
        "numberOfApprovedItems": 0,
        "numberOfOpenItems": 1,
        "numberOfDeniedItems": 0,
        "numberOfSubmittedItems": 0,
        "numberOfAutoApprovedItems": 0,
        "priceGridType": "SIMPLE",
        "createdByName": "root",
        "lastUpdateByName": "admin",
        "updatedBy": 51,
        "updateDate": "2019-10-15",
        "createDate": "2019-04-03T09:46:38",
        "createdBy": 3,
        "lastUpdateDate": "2019-10-15T12:26:07",
        "lastUpdateBy": 51,
        "status": "READY",
        "calculationStartDate": "2019-04-03T09:48:22",
        "calculationDate": "2019-04-03T09:48:22",
        "id": 2147483791
      },
      {
        "version": 21,
        "typedId": "2147483802.PG",
        "label": "GRT PTACB.ACB MTZ1 IEC.MAIN DEVICE MASTERPACT MTZ1 IEC",
        "calculationMessages": "[]",
        "numberOfItems": 0,
        "keepManualOverrides": false,
        "writeOnlyChangedItems": false,
        "configuration": "{\"elementNames\":[\"color\",\"size\"],\"shotgunModeEnabled\":false,\"outputs\":[{\"name\":\"testOutput1\",
         \"label\":\"Activity\",\"value\":\"PTXXX\",\"message\":\"\"},{\"name\":\"testOutput2\",\"label\":\"Range\",\"value\":\"XC3\",
         \"message\":\"OK\"},{\"name\":\"testOutput3\",\"label\":\"Cluster\",\"value\":\"1633\",\"message\":\"\"},{\"name\":\"testOutput4\",
         \"label\":\"Global Cluster Sales\",\"value\":\"$44.0M\",\"message\":\"\"}],\"outputChartDefinition\":{\"chart\":{\"type\":\"line\"},
         \"title\":{\"text\":\"Sales\"},\"series\":[{\"name\":\"Results\",\"data\":[[0.1,0.3],[0.2,0.5],[0.3,0.6],[0.4,0.7]]}]},\"inputs\":[],
         \"allowFieldTypeChange\":false,\"headerInputs\":[{\"name\":\"Set price logic\",\"label\":\"Set price logic\",\"type\":\"INPUTMATRIX\",
         \"typedId\":\"2147483802.PG\",\"parameterConfig\":{\"columns\":[\"Value Attribute\",\"Feature\",\"Impact Type\",\"Current Coef\",
         \"New Coef\"]}},{\"name\":\"colorLabel\",\"label\":\"colorLabel\",\"type\":\"STRINGUSERENTRY\",\"typedId\":\"2147483802.PG\",
         \"parameterConfig\":{\"dataType\":\"text\"}}],\"headerFormulaName\":\"PLtest\"}",
        "nodeId": 9,
        "numberOfApprovedItems": 0,
        "numberOfOpenItems": 0,
        "numberOfDeniedItems": 0,
        "numberOfSubmittedItems": 0,
        "numberOfAutoApprovedItems": 0,
        "priceGridType": "SIMPLE",
        "headerTypeUniqueName": "jkTest",
        "createdByName": "admin",
        "lastUpdateByName": "admin",
        "updatedBy": 5351,
        "updateDate": "2019-11-01",
        "createDate": "2019-10-15T11:22:49",
        "createdBy": 5351,
        "lastUpdateDate": "2019-11-01T14:44:25",
        "lastUpdateBy": 5351,
        "status": "READY",
        "calculationStartDate": "2019-10-15T11:23:01",
        "calculationDate": "2019-10-15T11:23:01",
        "id": 2147483802
      }
    ],
    "endRow": 2,
    "totalRows": 2,
    "status": 0
  }
}

Retrieve an LPG

Fetches basic data about the specified LPG (not its content).

/pricefx/{partition}/fetch/PG/{LPGID}

Code Block

title	Response
collapse	true

{
    "response": {
        "node": "user1",
        "data": [
            {
                "version": 24,
                "typedId": "2147483802.PG",
                "label": "GRT PTACB.ACB MTZ1 IEC.MAIN DEVICE MASTERPACT MTZ1 IEC",
                "calculationMessages": "[]",
                "numberOfItems": 3,
                "keepManualOverrides": false,
                "writeOnlyChangedItems": false,
                "configuration": "{\"elementNames\":[\"color\",\"size\"],
                \"shotgunModeEnabled\":false,\"outputs\":[{\"name\":\"testOutput1\",
                \"label\":\"Activity\",\"value\":\"PTXXX\",\"message\":\"\"}, {\"name\":\"testOutput2\",
                \"label\":\"Range\",\"value\":\"XC3\",
                \"message\":\"OK\"},{\"name\":\"testOutput3\",\"label\":\"Cluster\",\"value\":\"1633\",
                \"message\":\"\"},{\"name\":\"testOutput4\",\"label\":\"Global Cluster Sales\",
                \"value\":\"$44.0M\",\"message\":\"\"}],
                \"outputChartDefinition\":{\"chart\":{\"type\":\"line\"},\"title\":{\"text\":\"Sales\"},
                \"series\":[{\"name\":\"Results\",\"data\":[[0.1,0.3],[0.2,0.5],[0.3,0.6],[0.4,0.7]]}]},
                \"inputs\":[],\"allowFieldTypeChange\":false,\"headerInputs\":[{\"name\":\"Set price logic\",
                \"label\":\"Set price logic\",\"type\":\"INPUTMATRIX\",\"typedId\":\"2147483802.PG\",
                \"parameterConfig\":{\"columns\":[\"Value Attribute\",\"Feature\",\"Impact Type\",\"Current Coef\",
                \"New Coef\"]}},{\"name\":\"colorLabel\",\"label\":\"colorLabel\",
                \"type\":\"STRINGUSERENTRY\",\"typedId\":\"2147483802.PG\",
                \"parameterConfig\":{\"dataType\":\"text\"}}],\"headerFormulaName\":\"PLtest\"}",
                "nodeId": 9,
                "numberOfApprovedItems": 0,
                "numberOfOpenItems": 3,
                "numberOfDeniedItems": 0,
                "numberOfSubmittedItems": 0,
                "numberOfAutoApprovedItems": 0,
                "priceGridType": "SIMPLE",
                "headerTypeUniqueName": "LPGTest",
                "createdByName": "admin",
                "updateDate": "2020-10-26",
                "createDate": "2019-10-15T11:22:49",
                "createdBy": 5351,
                "lastUpdateDate": "2020-10-26T15:47:25",
                "status": "READY",
                "calculationStartDate": "2020-10-26T15:47:21",
                "calculationDate": "2020-10-26T15:47:25",
                "id": 2147483802
            }
        ],
        "status": 0
    }
}

Retrieve a complete LPG

Retrieves the full content of the LPG specified by its ID.

/pricefx/{partition}/pricegridmanager.fetch/{LPGID}

Code Block

title	Payload
collapse	true

{
  "data": {}
}

curl:

Code Block

curl -X POST \
https://{host}/pricefx/{partition}/pricegridmanager.fetch/<PG id> \
-H 'Accept: application/json' \
-H 'Accept-Encoding: gzip, deflate' \
-H 'Authorization: Basic c25iLWRldi9pbnRlZ3JhdGlvbjpTdGFydDEyMw==' \
-H 'Cache-Control: no-cache' \
-H 'Connection: keep-alive' \
-H 'Content-Length: 142' \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"startRow": 0,
"endRow": 1,
"textMatchStyle": "substring",
"data": {},
"oldValues": null
}'

Code Block

title	Response
collapse	true

{
  "response": {
    "status": 0,
    "startRow": 0,
    "node": "user1",
    "data": [
      {
        "version": 2,
        "typedId": "2147973134.PGI",
        "sku": "1234567890",
        "label": "TEST",
        "resultPrice": 5.0,
        "allowedOverrides": "",
        "calculatedResultPrice": 5.0,
        "tainted": false,
        "priceGridId": 2147483791,
        "approvalState": "NOT_APPROVED",
        "manualEditVersion": 0,
        "manualPriceExpired": false,
        "createDate": "2019-04-03T09:47:41",
        "createdBy": 3,
        "lastUpdateDate": "2019-04-03T09:48:22",
        "attribute1": 5,
        "attribute2": 999,
        "attribute3": 123,
        "itemExtensions": {},
        "completeResultsAvailable": true
      }
    ],
    "endRow": 1
  }
}

...

Versions Compared

Old Version 57

New Version 58

Key

Get a list of Price Lists

Retrieve a Price List

Retrieve a complete Price List

Get a (filtered) list of LPGs

Retrieve an LPG

Retrieve a complete LPG