Delete a Price List

post/pricelistmanager.delete

Deletes a Price List specified by typedId.

Required Permission Roles with the Required Permission
PRICELIST_REMOVE Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR)
Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
typedId
required
string non-empty
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
string non-empty
numberOfItems
number
keepManualOverrides
boolean
writeOnlyChangedItems
boolean
configuration
string non-empty
errorMode
string non-empty
pricelistType
string non-empty
nodeId
any
previousPricelistId
number
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
any
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
string non-empty
calculationDate
string non-empty
approvalDate
any
submitDate
string non-empty
exportDate
any
id
number
status
number
Request samples
application/json
{
  • "data": {
    • "typedId": "2147490403.PL"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "targetDate": "string",
        • "label": "string",
        • "locale": "string",
        • "calculationMessages": "string",
        • "numberOfItems": 0,
        • "keepManualOverrides": true,
        • "writeOnlyChangedItems": true,
        • "configuration": "string",
        • "errorMode": "string",
        • "pricelistType": "string",
        • "nodeId": null,
        • "previousPricelistId": 0,
        • "expiryDate": null,
        • "approvalState": "string",
        • "description": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "workflowStatus": null,
        • "submittedByName": null,
        • "integrationStatus": null,
        • "createdByName": "string",
        • "lastUpdateByName": "string",
        • "jstId": null,
        • "approvedByName": null,
        • "deniedByName": null,
        • "approvalRequiredEmailAttachments": null,
        • "updatedBy": 0,
        • "updateDate": "string",
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "status": "string",
        • "calculationStartDate": "string",
        • "calculationDate": "string",
        • "approvalDate": null,
        • "submitDate": "string",
        • "exportDate": null,
        • "id": 0
        }
      ],
    • "status": 0
    }
}