Create a Price List

post/pricelistmanager.add

Creates a new 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
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

OK

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
targetDate
string non-empty
label
string non-empty
locale
string non-empty
calculationMessages
any
numberOfItems
number
keepManualOverrides
boolean
writeOnlyChangedItems
boolean
configuration
string non-empty
errorMode
string non-empty
pricelistType
string non-empty
nodeId
any
previousPricelistId
any
expiryDate
any
approvalState
string non-empty
description
any
userGroupEdit
any
userGroupViewDetails
any
workflowStatus
any
submittedByName
any
integrationStatus
any
createdByName
string non-empty
lastUpdateByName
string non-empty
jstId
number
approvedByName
any
deniedByName
any
approvalRequiredEmailAttachments
any
updatedBy
number
updateDate
string non-empty
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
calculationStartDate
any
calculationDate
any
approvalDate
any
submitDate
any
exportDate
any
id
number
status
number
Request samples
application/json
{
  • "data": {
    • "priceListName": "Price List 2021",
    • "targetDate": "2021-11-10",
    • "errorMode": "ABORT",
    • "keepManualOverrides": null,
    • "useFilter": null,
    • "writeOnlyChangedItems": null,
    • "configuration": {
      • "shotgunModeEnabled": false,
      • "notifyWhenFinished": "NONE",
      • "productFilterCriteria": {
        • "_constructor": "AdvancedCriteria",
        • "operator": "and",
        • "criteria": [
          ]
        },
      • "sortKeys": null,
      • "resultElementName": "ListPrice",
      • "matrixFormulaName": null,
      • "matrixElementName": null,
      • "uomOverrideElementName": null,
      • "elementNames": [
        • "BasePrice"
        ],
      • "hiddenElementNames": [ ]
      },
    • "override": null,
    • "nodeId": null
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "targetDate": "string",
        • "label": "string",
        • "locale": "string",
        • "calculationMessages": null,
        • "numberOfItems": 0,
        • "keepManualOverrides": true,
        • "writeOnlyChangedItems": true,
        • "configuration": "string",
        • "errorMode": "string",
        • "pricelistType": "string",
        • "nodeId": null,
        • "previousPricelistId": null,
        • "expiryDate": null,
        • "approvalState": "string",
        • "description": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "workflowStatus": null,
        • "submittedByName": null,
        • "integrationStatus": null,
        • "createdByName": "string",
        • "lastUpdateByName": "string",
        • "jstId": 0,
        • "approvedByName": null,
        • "deniedByName": null,
        • "approvalRequiredEmailAttachments": null,
        • "updatedBy": 0,
        • "updateDate": "string",
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "status": "string",
        • "calculationStartDate": null,
        • "calculationDate": null,
        • "approvalDate": null,
        • "submitDate": null,
        • "exportDate": null,
        • "id": 0
        }
      ],
    • "status": 0
    }
}