Retrieve time plans, time policies, and adjustment codes. The Price Adjustment dialog box enables a user to pick a time plan and time policy to associate with a recurring adjustment or to pick a code that defines an adjustment for a specific price, such as a recurring charge, one-time charge, one-time total, and so on.
GET /v2/listsofvalues?listkeys={type_of_list}&cartId={cart_ID}&id={line_item_ID}&fields={field_name}&PricingVariableCode={price_variable_code}
Remote Method
getListsOfValues
Package
Communication (vlocity_cmt)
API Parameters and Response Format
For API parameter names and descriptions, see Cart-Based API Swagger Reference.
Resource Information
| Response Format | JSON |
|---|---|
| Resource URL | /services/apexrest/{namespace}/v2/listsofvalues |
Example Request
GET
/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000goGvAAI&id=80246000000gaR9AAI&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC
Example Response
{
"totalSize": 1,
"messages": [],
"records": [
{
"messages": [],
"displaySequence": -1,
"id": "80246000000gZfOAAU",
"vlocity_cmt__OneTimeCharge__c": {
"pricedetail": [
{
"actions": {},
"DetailType": "PRICE",
"Description": "$50 One Time Standard Price",
"StartValue": 50,
"EndValue": 50,
"AdjustmentType": "None",
"AdjustmentMethod": null,
"AdjustmentValue": 0
},
{
"actions": {},
"DetailType": "ADJUSTMENT",
"Description": "5% Discount on OT Std Price due to Bundle A...",
"StartValue": 50,
"EndValue": 47.5,
"AdjustmentType": "Discount",
"AdjustmentMethod": "Percent",
"AdjustmentValue": -5
},
{
"actions": {},
"DetailType": "ADJUSTMENT",
"Description": "10% Discount on OT Std Price due to Promotion 'Add Bundle A'",
"StartValue": 47.5,
"EndValue": 42.5,
"AdjustmentType": "Discount",
"AdjustmentMethod": "Percent",
"AdjustmentValue": -10
},
{
"actions": {},
"DetailType": "ADJUSTMENT",
"Description": "Additional 10% - Add Child 2 Promo",
"StartValue": 42.5,
"EndValue": 37.5,
"AdjustmentType": "Discount",
"AdjustmentMethod": "Percent",
"AdjustmentValue": -10
}
]
}
}
]
}
Example Request
GET
/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=TimePlans,TimePolicies
Example Response
{
"totalSize": 2,
"messages": [],
"records": [
{
"messages": [],
"displaySequence": -1,
"listkey": "TimePlans",
"listvalues": [
{
"uiStates": {},
"nameResult": {},
"messages": [],
"fields": {
"valuekey": "a2l460000005J5xAAE",
"label": "One Year"
},
"displaySequence": -1,
"actions": {}
},
{
"uiStates": {},
"nameResult": {},
"messages": [],
"fields": {
"valuekey": "a2l460000005J1ZAAU",
"label": "60 Days"
},
"displaySequence": -1,
"actions": {}
},
{
"uiStates": {},
"nameResult": {},
"messages": [],
"fields": {
"valuekey": "a2l460000005J1UAAU",
"label": "6 months"
},
"displaySequence": -1,
"actions": {}
}
]
},
{
"messages": [],
"displaySequence": -1,
"listkey": "TimePolicies",
"listvalues": [
{
"uiStates": {},
"nameResult": {},
"messages": [],
"fields": {
"valuekey": "a2m460000004xcvAAA",
"label": "First Day of the Month"
},
"displaySequence": -1,
"actions": {}
},
{
"uiStates": {},
"nameResult": {},
"messages": [],
"fields": {
"valuekey": "a2m460000004xbfAAA",
"label": "Time Policy Purchase Date"
},
"displaySequence": -1,
"actions": {}
}
]
}
]
}