Start a configuration session for a particular product.
post
/ccstore/v1/cpq/configurations
This endpoint initializes a new configuration session for a product and returns its state, layout data, and arraySetAttributes data if present.
Request
Supported Media Types
- application/json
Root Schema : ConfigureRequest
Type:
Show Source
object-
arraySetLimit:
number
The number of results to return per page for any array sets that may be present in the response.
-
cacheInstanceId:
string
When the action is to obtain the next or previous page, the request must contain the cacheInstanceId
-
configId:
integer
When the action is to be a reconfigure, the request must contain a configId parameter.
-
criteria:
object criteria
This is being used as filter to be used on the CPQ payload
-
expand:
string
It can be layoutCache or layout. Default value is layout.
-
locale:
string
The locale of the data to be retrieved from CPQ. When this isn't supplied, the value will be retrieved from the request header. Default value is 'us'.
-
model(required):
string
The model to be configured.
-
productFamily(required):
string
The productFamily of the model to be configured.
-
productLine(required):
string
The productLine of the model to be configured.
Example:
{
"productFamily":"test1",
"productLine":"productLine1",
"excludeLayoutProperties":[
"labelAlignment",
"labelSeparator",
"showLabel",
"labelWidth",
"labelWidthUnits",
"valuePosition",
"valueWidth",
"valueWidthUnits",
"valueAlignment",
"helpIconAlignment",
"msgPlacement",
"msgWidthUnits",
"msgWidth",
"menuImagePosition",
"pricePosition",
"language",
"fieldAutoWidth",
"showCalculator",
"showRecMsg",
"showConMsg",
"showPrevValueMsg",
"showDataTooltip",
"showMenuImage",
"setTypeOverridden",
"defaultValueOverridden",
"displayTypeOverridden",
"jetDisplayTypeOverridden",
"helpIcon",
"showHelpIcon",
"columnWidths",
"fieldAlignment",
"showTitleIcon",
"showDescription",
"titleIcon",
"cssClass"
],
"model":"model1",
"currency":"USD",
"locale":"en_US"
}Nested Schema : criteria
Type:
objectThis is being used as filter to be used on the CPQ payload
Show Source
-
childDefs:
array childDefs
This property contains the filter value to be used at CPQ.
-
state:
boolean
In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.
Nested Schema : childDefs
Type:
arrayThis property contains the filter value to be used at CPQ.
Show Source
Nested Schema : items
Type:
Show Source
object-
name:
string
Name can contain the state property value that is required.
Response
Supported Media Types
- application/json
200 Response
State, layout, and attribute data for a particular product. This response is returned by reconfigure invocation.
Root Schema : ConfigureResponse
Example:
{
"layout":{
"arraySetVariableNames":[
],
"attributes":[
{
"items":[
{
"constraintDisplayType":{
"displayValue":"Marked",
"lookupCode":"1"
},
"orderNumber":1,
"hidden":false,
"endDate":"",
"defaultValue":"",
"autoLock":false,
"additional":{
},
"inputTypeCode":{
"lookupCode":"TextField"
},
"description":"Registered catalog item.",
"language":null,
"type":{
"displayValue":"Text",
"lookupCode":"1"
},
"required":false,
"array":false,
"calculatorTabs":{
"_state":null,
"items":[
]
},
"id":21634722,
"jetDisplayType":{
"displayValue":"Text",
"lookupCode":"1"
},
"runFilter":false,
"itemLevelProcess":false,
"potentialStates":[
],
"calculatorAttr":null,
"variableName":"_bm_pline_name",
"level":null,
"menuItems":{
"_state":null,
"items":[
]
},
"dateModified":null,
"hideInTrans":false,
"arrayControlAttr":false,
"setType":{
"displayValue":"None",
"lookupCode":"1"
},
"partComment":null,
"ajaxSensitive":false,
"displayType":{
"displayValue":"Text",
"lookupCode":"1"
},
"validationMethod":null,
"name":"Name",
"priceItem":{
"displayPriceAtBottom":true,
"includeInTotalPrice":true,
"dateModified":null,
"language":null,
"pricingDisplayType":{
"displayValue":"None",
"lookupCode":"1"
},
"id":null,
"pricingType":{
"displayValue":"None",
"lookupCode":"1"
}
},
"partNumber":null,
"category":{
"displayValue":"Regular Attributes",
"lookupCode":"1"
},
"startDate":"",
"status":{
"displayValue":"Active",
"lookupCode":"1"
},
"ssplProperties":null,
"pickLists":null
},
{
"constraintDisplayType":{
"displayValue":"Marked",
"lookupCode":"1"
},
"orderNumber":11,
"hidden":false,
"endDate":"",
"defaultValue":"",
"autoLock":false,
"additional":{
"jet_constrained_display":"Strike Through"
},
"inputTypeCode":{
"lookupCode":"SingleSelectMenu"
},
"description":"",
"language":null,
"type":{
"displayValue":"Text",
"lookupCode":"1"
},
"required":false,
"array":false,
"calculatorTabs":{
"_state":null,
"items":[
]
},
"id":18310376,
"jetDisplayType":{
"displayValue":"Select Choice",
"lookupCode":"3"
},
"runFilter":false,
"itemLevelProcess":false,
"potentialStates":[
"updatable"
],
"calculatorAttr":null,
"variableName":"textSSM1",
"level":null,
"menuItems":{
"_state":null,
"items":[
{
"displayValue":"Value 1",
"orderNumber":1,
"imageUrl":null,
"dateModified":null,
"language":null,
"avp":null,
"id":18310378,
"value":"Value 1"
},
{
"displayValue":"Value 2",
"orderNumber":2,
"imageUrl":null,
"dateModified":null,
"language":null,
"avp":null,
"id":18310379,
"value":"Value 2"
},
{
"displayValue":"Value 3",
"orderNumber":3,
"imageUrl":null,
"dateModified":null,
"language":null,
"avp":null,
"id":18310380,
"value":"Value 3"
}
]
},
"dateModified":null,
"hideInTrans":false,
"arrayControlAttr":false,
"setType":{
"displayValue":"None",
"lookupCode":"1"
},
"partComment":null,
"ajaxSensitive":false,
"displayType":{
"displayValue":"Single Select Menu",
"lookupCode":"3"
},
"validationMethod":null,
"name":"Text SSM 1",
"priceItem":{
"displayPriceAtBottom":true,
"includeInTotalPrice":true,
"dateModified":null,
"language":null,
"pricingDisplayType":{
"displayValue":"None",
"lookupCode":"1"
},
"id":null,
"pricingType":{
"displayValue":"None",
"lookupCode":"1"
}
},
"partNumber":null,
"category":{
"displayValue":"Configurable Attributes",
"lookupCode":"2"
},
"startDate":"",
"status":{
"displayValue":"Active",
"lookupCode":"1"
},
"ssplProperties":null,
"pickLists":null
},
{
"constraintDisplayType":{
"displayValue":"Marked",
"lookupCode":"1"
},
"orderNumber":19,
"hidden":false,
"endDate":"",
"defaultValue":"",
"autoLock":false,
"additional":{
},
"inputTypeCode":{
"lookupCode":"SingleSelectPickList"
},
"description":"",
"language":null,
"type":{
"displayValue":"Integer",
"lookupCode":"3"
},
"required":false,
"array":false,
"calculatorTabs":{
"_state":null,
"items":[
]
},
"id":"3022375022",
"jetDisplayType":{
"displayValue":"Select Choice",
"lookupCode":"3"
},
"runFilter":false,
"itemLevelProcess":false,
"potentialStates":[
"updatable"
],
"calculatorAttr":null,
"variableName":"integerSSPL1",
"level":null,
"menuItems":{
"_state":null,
"items":[
]
},
"dateModified":null,
"hideInTrans":false,
"arrayControlAttr":false,
"setType":{
"displayValue":"Set",
"lookupCode":"2"
},
"partComment":null,
"ajaxSensitive":false,
"displayType":{
"displayValue":"Single Select Pick List",
"lookupCode":"11"
},
"validationMethod":{
"displayValue":"None",
"lookupCode":"1"
},
"name":"Integer SSPL 1",
"priceItem":{
"displayPriceAtBottom":true,
"includeInTotalPrice":true,
"dateModified":null,
"language":null,
"pricingDisplayType":{
"displayValue":"None",
"lookupCode":"1"
},
"id":null,
"pricingType":{
"displayValue":"None",
"lookupCode":"1"
}
},
"partNumber":null,
"category":{
"displayValue":"Configurable Attributes",
"lookupCode":"2"
},
"startDate":"",
"status":{
"displayValue":"Active",
"lookupCode":"1"
},
"ssplProperties":{
"filterString":"",
"resAttrImage":"",
"orderByCol":"integerSorting",
"dateModified":null,
"language":null,
"resourceDomain":"customDplBasicTable",
"type":{
"displayValue":"dataTable",
"lookupCode":"0"
},
"resAttrVarName":"",
"pickMaps":[
],
"orderByDir":{
"displayValue":"Ascending",
"lookupCode":"0"
},
"distinctValues":false,
"id":"3022375026",
"resAttrDisplayName":"integerColumn"
},
"pickLists":null
},
{
"constraintDisplayType":{
"displayValue":"Marked",
"lookupCode":"1"
},
"orderNumber":7,
"hidden":false,
"endDate":"",
"defaultValue":"",
"autoLock":false,
"additional":{
},
"inputTypeCode":{
"lookupCode":"TextField"
},
"description":"",
"language":null,
"type":{
"displayValue":"Integer",
"lookupCode":"3"
},
"required":false,
"array":false,
"calculatorTabs":{
"_state":null,
"items":[
]
},
"id":18310368,
"jetDisplayType":{
"displayValue":"Text",
"lookupCode":"1"
},
"runFilter":false,
"itemLevelProcess":false,
"potentialStates":[
"updatable"
],
"calculatorAttr":null,
"variableName":"integerField1",
"level":null,
"menuItems":{
"_state":null,
"items":[
]
},
"dateModified":null,
"hideInTrans":false,
"arrayControlAttr":false,
"setType":{
"displayValue":"None",
"lookupCode":"1"
},
"partComment":null,
"ajaxSensitive":false,
"displayType":{
"displayValue":"Text",
"lookupCode":"1"
},
"validationMethod":{
"displayValue":"None",
"lookupCode":"1"
},
"name":"Integer Field 1",
"priceItem":{
"displayPriceAtBottom":true,
"includeInTotalPrice":true,
"dateModified":null,
"language":null,
"pricingDisplayType":{
"displayValue":"None",
"lookupCode":"1"
},
"id":null,
"pricingType":{
"displayValue":"None",
"lookupCode":"1"
}
},
"partNumber":null,
"category":{
"displayValue":"Configurable Attributes",
"lookupCode":"2"
},
"startDate":"",
"status":{
"displayValue":"Active",
"lookupCode":"1"
},
"ssplProperties":null,
"pickLists":null
}
]
}
]
},
"layoutNamespace":"laptop-laptopConfiguration-sku50001-hierLevel-3",
"arraySetVariableNames":[
],
"configData":{
"monitorCount":null,
"_price_book_var_name":{
"value":"_default_price_book"
},
"_state":{
"updatable":true,
"messages":[
],
"attributes":{
"monitorCount":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false
},
"_price_book_var_name":{
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"Base Price",
"value":"_default_price_book"
},
{
"displayValue":"test_pb",
"value":"test_pb"
},
{
"displayValue":"TestPriceBook",
"value":"testPriceBook"
},
{
"displayValue":"sample_priceBook",
"value":"sample_priceBook"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"required":true
},
"_isMainModelSelected":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":false,
"updatable":false,
"messages":[
],
"hasError":false,
"hasWarning":false
},
"test2Size":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"1",
"value":1
},
{
"displayValue":"2",
"value":2
},
{
"displayValue":"3",
"value":3
},
{
"displayValue":"4",
"value":4
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false,
"required":true
}
},
"hasError":false,
"hasWarning":false,
"actions":{
"_cm_37088514":{
"visible":true,
"enabled":true
},
"_startOver":{
"visible":true,
"enabled":true
},
"_cancel":{
"visible":false,
"enabled":true
},
"_addToTxn":{
"visible":false,
"enabled":true
},
"_cm_36292358":{
"visible":true,
"enabled":true
},
"_update":{
"visible":true,
"enabled":true
},
"_integration_addToCart":{
"visible":true,
"enabled":true
},
"_save":{
"visible":false,
"enabled":true
},
"_next":{
"visible":false,
"enabled":true
},
"_previous":{
"visible":true,
"enabled":true
}
}
},
"_recmdModels":{
"items":[
]
},
"_mandatoryParts":{
"items":[
]
},
"_bom":{
"items":[
{
"_part_custom_field4":null,
"quantity":1,
"_part_custom_field8":null,
"deltaPrice":null,
"price":{
"currency":"USD",
"value":772
},
"_part_custom_field5":0,
"_part_custom_field6":0,
"partNumber":"sku50001",
"partDisplayNumber":"sku50001"
},
{
"_part_custom_field4":null,
"quantity":1,
"_part_custom_field8":null,
"deltaPrice":null,
"price":{
"currency":"USD",
"value":125
},
"_part_custom_field5":0,
"_part_custom_field6":0,
"partNumber":"sku40002",
"partDisplayNumber":"Intel Pentium i3"
},
{
"_part_custom_field4":null,
"quantity":1,
"_part_custom_field8":null,
"deltaPrice":null,
"price":{
"currency":"USD",
"value":100
},
"_part_custom_field5":0,
"_part_custom_field6":0,
"partNumber":"sku40007",
"partDisplayNumber":"8 GB Kingston Sodimm DDR3 1600MHz"
},
{
"_part_custom_field4":null,
"quantity":1,
"_part_custom_field8":null,
"deltaPrice":null,
"price":{
"currency":"USD",
"value":100
},
"_part_custom_field5":0,
"_part_custom_field6":0,
"partNumber":"sku40008",
"partDisplayNumber":"Hard disk 500GB"
},
{
"_part_custom_field4":null,
"quantity":1,
"_part_custom_field8":null,
"deltaPrice":null,
"price":{
"currency":"USD",
"value":41
},
"_part_custom_field5":0,
"_part_custom_field6":0,
"partNumber":"sku40011",
"partDisplayNumber":"Intel HD Graphics Media Accelerator 4600"
}
]
},
"_isMainModelSelected":true,
"test2Size":{
"displayValue":"1",
"value":1
},
"_recmdParts":{
"items":[
]
},
"_priceInfo":{
"name":"Price",
"items":[
{
"category":{
"code":"GENERAL",
"displayName":"Price"
},
"_others":[
{
"variableName":"_basePrice",
"price":{
"currency":"USD",
"value":772
},
"name":"Base Price"
},
{
"variableName":"_totalConfiguredPrice",
"price":{
"currency":"USD",
"value":772
},
"name":"Total Configured Price of Model"
},
{
"variableName":"_totalBOMPrice",
"price":{
"currency":"USD",
"value":366
},
"name":"Total Price of BOM"
},
{
"variableName":"_grandTotal",
"price":{
"currency":"USD",
"value":1138
},
"name":"Grand Total"
}
]
}
]
},
"_mandatoryModels":{
"items":[
]
}
},
"systemCurrentDate":"2023-09-26",
"_flow":{
"productFamily":"laptop",
"productLine":"laptopConfiguration",
"model":"sku50001",
"flow":"laptopFlowEnd1",
"allPF":false
},
"layoutFlowVariableName":"laptopFlowEnd1",
"cacheInstanceId":"22qBSJolEonUczV1JH4SxSjzcBLzsTpUTTWlhcyUVMHLdzaFIrbwIR4MFYQxmHFY",
"links":[
{
"rel":"self",
"href":"http://mumbai74649.bom2.fusionappsdbom1.oraclevcn.com:8080/ccstoreui/v1/cpq/configurations"
}
]
}400 Response
Bad request input data
Root Schema : Error
Type:
Show Source
object-
message:
string
The error message
-
status:
string
The Error code