Get a Price List

post/fetch/PL/{id}

Retrieves Price List details.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
id
required
string

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

Responses
200

OK

Response Schema: application/json
object
node
string non-empty
csrfToken
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
calculationMessages
string non-empty
numberOfItems
number
keepManualOverrides
boolean
writeOnlyChangedItems
boolean
configuration
string non-empty
errorMode
string non-empty
pricelistType
string non-empty
approvalState
string non-empty
createdByName
string non-empty
lastUpdateByName
string non-empty
updatedBy
number
updateDate
string non-empty
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
calculationDate
string non-empty
id
number
status
number
Request samples 
Response samples 
application/json
{
  • "response": {
    • "node": "<node>",
    • "csrfToken": "<token>",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2147490401.PL",
        • "targetDate": "2021-11-10",
        • "label": "Test PL",
        • "locale": null,
        • "calculationMessages": "[]",
        • "numberOfItems": 6,
        • "keepManualOverrides": false,
        • "writeOnlyChangedItems": false,
        • "configuration": "{\"elementNames\":[\"ListPrice\"],\"resultElementName\":\"ListPrice\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"PriceList\",\"formulaParameters\":{}}",
        • "errorMode": "SKIP",
        • "pricelistType": "SIMPLE",
        • "nodeId": null,
        • "previousPricelistId": null,
        • "expiryDate": null,
        • "approvalState": "NOT_APPROVED",
        • "description": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "workflowStatus": null,
        • "submittedByName": null,
        • "integrationStatus": null,
        • "createdByName": "admin",
        • "lastUpdateByName": "admin",
        • "jstId": null,
        • "updateDate": "2021-11-10",
        • "updatedBy": 2147490696,
        • "approvedByName": null,
        • "deniedByName": null,
        • "approvalRequiredEmailAttachments": null,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-11-10T12:38:30",
        • "lastUpdateBy": 2147490696,
        • "status": "READY",
        • "calculationStartDate": null,
        • "calculationDate": "2021-11-09T17:38:47",
        • "approvalDate": null,
        • "submitDate": null,
        • "exportDate": null,
        • "id": 2147490401
        }
      ],
    • "status": 0
    }
}