Calculate a Pricelist

post/pricelistmanager.calculate/{id}

Calculates the Price List specified by id in the path parameter.

Required Permission Roles with the Required Permission
PRICELIST_UPDATE 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 calculate. 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
object (calculatePricelistRequest)
fullListRecalc
boolean
Default: false

Calculates a whole price list. If true then fullCalculationDateTime is set. If false or not set and idsToRecalc are specified, then the partialCalculationDateTime is set.

Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (JobStatusTracker)
Array
processingStart
string or null
targetObject
string <= 255 characters
typedId
string
lastUpdateDate
string <date-time>
trackerType
string <= 255 characters
Possible values: "PRICELIST" "PRICELIST_DIRTY" "SIMULATION" "SIMULATION_DIRTY" "PRICEGRID" "PRICEGRID_DIRTY" "CFS" "REBATERECORD" "PRICEAPI_OBSOLETE" "MASSUPDATE" "IFP_OBSOLETE" "DATAEXPORT" "DATAIMPORT" "OBJREF" "PADATALOAD" "CALCULATIONFLOW" "PRICELIST_MERGE" "DATAARCHIVE" "RAT_CALC" "MOVE_OX" … 26 more
threadId
integer or null
object
calculationContext
string or null <= 255 characters
threadUUID
string or null <= 255 characters
id
integer
calculationResults
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

processingNode
string or null <= 255 characters
createDate
string <date-time>
jobName
string <= 255 characters
concurrencyKey
string <= 255 characters
priority
integer
version
integer
createdBy
integer
processingEnd
string or null
progress
string or null <= 255 characters
messages
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

runNumber
integer
cancelRequested
boolean
parameters
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

status
string <= 255 characters
Possible values: "WAITING_FOR_DISPATCH" "QUEUED_FOR_EXECUTION" "PROCESSING" "FAILED" "FINISHED" "CANCELLED" "INTERRUPTED"
lastUpdateBy
integer
status
integer
Request samples
application/json
No sample
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-85cd8bf896-9x45v",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2148043261.JST",
        • "processingNode": null,
        • "threadId": null,
        • "threadUUID": null,
        • "status": "WAITING_FOR_DISPATCH",
        • "trackerType": "PRICELIST",
        • "targetObject": "2147490405.PL",
        • "jobName": "Price List 2021",
        • "concurrencyKey": "2147490405.PL",
        • "calculationContext": null,
        • "progress": null,
        • "cancelRequested": false,
        • "runNumber": 0,
        • "priority": 0,
        • "messages": null,
        • "jobSettings": {
          },
        • "createDate": "2023-06-01T12:54:44",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2023-06-01T12:54:44",
        • "lastUpdateBy": 2147490696,
        • "parameters": "{\"fullListRecalc\":true}",
        • "calculationResults": null,
        • "processingStart": null,
        • "processingEnd": null,
        • "id": 2148043261
        }
      ],
    • "status": 0
    }
}