Create a Revision

post/pricelistmanager.add/{id}

Creates a revision of the Price List.

Required Permission Roles with the Required Permission
PRICELIST_ADD Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR)
Securitybasic or X-PriceFx-jwt
Request
path Parameters
id
required
string

The ID of the Price List you want to create a revision for. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837.

Request Body schema: application/json
required
object
priceListName
required
string non-empty

Specifies parameter names and values used for formula computation.

targetDate
required
string non-empty

Set the validity date of the price list.

errorMode
required
string non-empty
keepManualOverrides
any

A flag to indicate if manual overrides should be preserved in the revision.

useFilter
any

Specifies whether the original product filter criteria (if still available/applicable) should be used.

writeOnlyChangedItems
any

A flag to indicate if only items with price changes should be written to the revision.

object
shotgunModeEnabled
boolean
notifyWhenFinished
string non-empty
plTypeTypeId
any
preferencesSource
number
sortKeys
any
defaultFormulaOverride
string non-empty
resultElementName
string non-empty
matrixFormulaName
any
matrixElementName
any
uomOverrideElementName
any
currencyOverrideElementName
any
elementNames
Array of strings
hiddenElementNames
Array of objects
formulaParameters
object
override
any

If set to true, adds products from products selection criteria to the price list and will override existing results if present. If set to false, adds products, but will not override results. If this value is null, then a revision of the entire Price List is triggered.

Responses
200

Example response

Response Schema: application/json
object
node
string non-empty
startRow
number
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
sku
string non-empty
label
string non-empty
unitOfMeasure
string non-empty
currency
string non-empty
comments
string non-empty
resultPrice
number
allowedOverrides
string
calculatedResultPrice
number
pricelistId
number
createDate
string non-empty
createdBy
number
attribute1
number
completeResultsAvailable
boolean
itemExtensions
object
endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

totalRows
number
status
number
Request samples
application/json
{
  • "data": {
    • "priceListName": "PriceList01",
    • "targetDate": "2021-11-10T14:46:08.508Z",
    • "errorMode": "SKIP",
    • "keepManualOverrides": true,
    • "useFilter": true,
    • "writeOnlyChangedItems": true,
    • "configuration": {
      • "shotgunModeEnabled": false,
      • "notifyWhenFinished": "EMAIL",
      • "plTypeTypeId": null,
      • "preferencesSource": 2147490401,
      • "sortKeys": null,
      • "defaultFormulaOverride": "PriceList",
      • "resultElementName": "ListPrice",
      • "matrixFormulaName": null,
      • "matrixElementName": null,
      • "uomOverrideElementName": null,
      • "currencyOverrideElementName": null,
      • "elementNames": [
        • "ListPrice"
        ],
      • "hiddenElementNames": [ ],
      • "formulaParameters": { }
      },
    • "override": null
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "<node>",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2147563138.PLI",
        • "sku": "11111",
        • "label": "Label One",
        • "unitOfMeasure": "EA",
        • "currency": "USD",
        • "resultPrice": 100,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 100,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 100,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563139.PLI",
        • "sku": "22222",
        • "label": "Label Two",
        • "unitOfMeasure": "EA",
        • "currency": "EUR",
        • "comments": "a comment",
        • "resultPrice": 200,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 200,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 200,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563140.PLI",
        • "sku": "33333",
        • "label": "Label Three",
        • "unitOfMeasure": "EA",
        • "currency": "CZK",
        • "resultPrice": 300,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 300,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 300,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563142.PLI",
        • "sku": "123456789",
        • "label": "The Label24",
        • "unitOfMeasure": "EA",
        • "currency": "USD",
        • "warnings": "{\"MarginPct\":[\"WTF?! Margin!\"],\"ListPrice\":[\"WTF?!\"],\"CompetitivePositioning\":[\"Product attribute BusinessUnit not found\",\"VLookup table CompetitionStrategy not found\"]}",
        • "allowedOverrides": "",
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        }
      ],
    • "endRow": 4,
    • "totalRows": 4,
    • "status": 0
    }
}