Update a configuration for a particular product.
post
/ccstore/v1/cpq/configurations/update
This endpoint updates a configuration for a product and returns its configuration data and state.
Request
Supported Media Types
- application/json
Root Schema : UpdateRequest
Type:
Show Source
object-
cacheInstanceId(required):
string
The cacheInstanceId of the currentConfiguration
-
configData(required):
object configData
A configData object that contains the updated attributes. This object must also contain the _state.attributes object so that the SSE can tell which attributes are 'updatable'.
-
criteria:
object criteria
This is being used as filter to be used on the CPQ payload
-
delta:
boolean
This flag controls the data returned in configData. If delta is true, only a subset of configData is returned which has changed. If delta is false, the entire configData object is returned.
-
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":"laptop",
"productLine":"laptopConfiguration",
"configData":{
"_state":{
"updatable":true,
"attributes":{
"memory_RAM":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260802"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"2GB Kingston Sodimm DDR3 1333MHz",
"value":"sku40005"
},
{
"displayValue":"4GB Kingston Sodimm DDR3 1600MHz",
"value":"sku40006"
},
{
"displayValue":"4GB Transcend DDR3",
"value":"sku260802"
},
{
"displayValue":"8 GB Kingston Sodimm DDR3 1600MHz",
"value":"sku40007"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false,
"required":false
},
"graphicsCard":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260805"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"Intel HD Graphics Media Accelerator 4600",
"value":"sku40011"
},
{
"displayValue":"Intel HD Graphics Media Accelerator 5600",
"value":"sku40012"
},
{
"displayValue":"Intel HD Graphics 5500",
"value":"sku260805"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false,
"required":false
},
"memory_HardDisk":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260803",
"sku260804"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"500GB",
"value":"sku40008"
},
{
"displayValue":"1TB",
"value":"sku40009"
},
{
"displayValue":"500GB 7200 rpm Serial ATA",
"value":"sku260803"
},
{
"displayValue":"1TB 5400rpm Serial ATA hard drive",
"value":"sku260804"
},
{
"displayValue":"2TB",
"value":"sku40010"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false,
"required":false
},
"processor":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260801"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"Intel Pentium Dual Core",
"value":"sku40001"
},
{
"displayValue":"Intel Pentium i3",
"value":"sku40002"
},
{
"displayValue":"Intel Pentium i5",
"value":"sku40003"
},
{
"displayValue":"Intel Pentium i7",
"value":"sku40004"
},
{
"displayValue":"Intel Pentium 3.1 GHz",
"value":"sku260801"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"hasWarning":false,
"required":false
},
"currencyCode":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":false,
"updatable":false,
"messages":[
],
"hasError":false,
"hasWarning":false
},
"_isMainModelSelected":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":false,
"updatable":false,
"messages":[
],
"hasError":false,
"hasWarning":false
}
}
},
"processor":{
"displayValue":"Intel Pentium i7",
"value":"sku40004"
}
},
"cacheInstanceId":"iqsvUuPj7jOYF2EjPWeJ6uSwBzy79LMI2UWqHZJtsBt9O7cO0IhwvWhfwnDquOBf",
"model":"sku50001"
}Nested Schema : configData
Type:
objectA configData object that contains the updated attributes. This object must also contain the _state.attributes object so that the SSE can tell which attributes are 'updatable'.
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
Updated configData and state for a particular product. This response is returned by an update invocation.
Root Schema : UpdateResponse
Example:
{
"configData":{
"_recmdModels":{
"items":[
]
},
"memory_HardDisk":{
"displayValue":"500GB",
"value":"sku40008"
},
"processor":{
"displayValue":"Intel Pentium i7",
"value":"sku40004"
},
"_bom":{
"items":[
{
"extendedDescription1":null,
"_part_custom_field3":"",
"extendedDescription2":null,
"_part_custom_field4":null,
"directBuy":null,
"_part_custom_field1":"",
"quantity":1,
"_part_custom_field8":null,
"_part_custom_field5":0,
"_part_custom_field6":0,
"description":"",
"leadTime":null,
"companyAssociations":null,
"units":null,
"partDisplayNumber":null,
"price":{
"currency":"USD",
"value":772
},
"comment":"",
"partNumber":"sku50001"
},
{
"extendedDescription1":null,
"_part_custom_field3":"",
"extendedDescription2":null,
"_part_custom_field4":null,
"directBuy":"Direct Buy",
"_part_custom_field1":"",
"quantity":1,
"_part_custom_field8":null,
"_part_custom_field5":0,
"_part_custom_field6":0,
"description":"Intel Pentium i7",
"leadTime":-1,
"companyAssociations":"",
"units":"",
"partDisplayNumber":"Intel Pentium i7",
"price":{
"currency":"USD",
"value":200
},
"comment":"Intel Pentium i7",
"partNumber":"sku40004"
},
{
"extendedDescription1":null,
"_part_custom_field3":"",
"extendedDescription2":null,
"_part_custom_field4":null,
"directBuy":"Direct Buy",
"_part_custom_field1":"",
"quantity":1,
"_part_custom_field8":null,
"_part_custom_field5":0,
"_part_custom_field6":0,
"description":"8 GB Kingston Sodimm DDR3 1600MHz",
"leadTime":-1,
"companyAssociations":"",
"units":"",
"partDisplayNumber":"8 GB Kingston Sodimm DDR3 1600MHz",
"price":{
"currency":"USD",
"value":100
},
"comment":"8 GB Kingston Sodimm DDR3 1600MHz",
"partNumber":"sku40007"
},
{
"extendedDescription1":null,
"_part_custom_field3":"",
"extendedDescription2":null,
"_part_custom_field4":null,
"directBuy":"Direct Buy",
"_part_custom_field1":"",
"quantity":1,
"_part_custom_field8":null,
"_part_custom_field5":0,
"_part_custom_field6":0,
"description":"Hard disk 500GB",
"leadTime":-1,
"companyAssociations":"",
"units":"",
"partDisplayNumber":"Hard disk 500GB",
"price":{
"currency":"USD",
"value":100
},
"comment":"Hard disk 500GB",
"partNumber":"sku40008"
},
{
"extendedDescription1":null,
"_part_custom_field3":"",
"extendedDescription2":null,
"_part_custom_field4":null,
"directBuy":"Direct Buy",
"_part_custom_field1":"",
"quantity":1,
"_part_custom_field8":null,
"_part_custom_field5":0,
"_part_custom_field6":0,
"description":"Intel HD Graphics Media Accelerator 4600",
"leadTime":-1,
"companyAssociations":"",
"units":"",
"partDisplayNumber":"Intel HD Graphics Media Accelerator 4600",
"price":{
"currency":"USD",
"value":41
},
"comment":"Intel HD Graphics Media Accelerator 4600",
"partNumber":"sku40011"
}
]
},
"_mandatoryModels":{
"items":[
]
},
"_state":{
"updatable":true,
"messages":[
],
"attributes":{
"memory_RAM":{
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260802"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"2GB Kingston Sodimm DDR3 1333MHz",
"value":"sku40005"
},
{
"displayValue":"4GB Kingston Sodimm DDR3 1600MHz",
"value":"sku40006"
},
{
"displayValue":"4GB Transcend DDR3",
"value":"sku260802"
},
{
"displayValue":"8 GB Kingston Sodimm DDR3 1600MHz",
"value":"sku40007"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"required":false
},
"graphicsCard":{
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260805"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"Intel HD Graphics Media Accelerator 4600",
"value":"sku40011"
},
{
"displayValue":"Intel HD Graphics Media Accelerator 5600",
"value":"sku40012"
},
{
"displayValue":"Intel HD Graphics 5500",
"value":"sku260805"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"required":false
},
"memory_HardDisk":{
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260803",
"sku260804"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"500GB",
"value":"sku40008"
},
{
"displayValue":"1TB",
"value":"sku40009"
},
{
"displayValue":"500GB 7200 rpm Serial ATA",
"value":"sku260803"
},
{
"displayValue":"1TB 5400rpm Serial ATA hard drive",
"value":"sku260804"
},
{
"displayValue":"2TB",
"value":"sku40010"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"required":false
},
"processor":{
"hasConstraintViolation":false,
"visible":true,
"domain":{
"constraintType":"DISALLOWED",
"constraintList":[
"sku260801"
],
"domainRestricted":true,
"availableElements":[
{
"displayValue":"Intel Pentium Dual Core",
"value":"sku40001"
},
{
"displayValue":"Intel Pentium i3",
"value":"sku40002"
},
{
"displayValue":"Intel Pentium i5",
"value":"sku40003"
},
{
"displayValue":"Intel Pentium i7",
"value":"sku40004"
},
{
"displayValue":"Intel Pentium 3.1 GHz",
"value":"sku260801"
}
]
},
"updatable":true,
"messages":[
],
"hasError":false,
"required":false
},
"currencyCode":{
"hasConstraintViolation":false,
"visible":false,
"updatable":false,
"messages":[
],
"hasError":false
},
"_isMainModelSelected":{
"recommendationMessages":[
],
"hasConstraintViolation":false,
"visible":false,
"updatable":false,
"messages":[
],
"hasError":false,
"hasWarning":false
}
},
"hasError":false,
"hasWarning":false,
"actions":{
"_update":{
"visible":true,
"enabled":true
},
"_integration_addToCart":{
"visible":true,
"enabled":true
}
}
},
"memory_RAM":{
"displayValue":"8 GB Kingston Sodimm DDR3 1600MHz",
"value":"sku40007"
},
"graphicsCard":{
"displayValue":"Intel HD Graphics Media Accelerator 4600",
"value":"sku40011"
},
"_mandatoryParts":{
"items":[
]
},
"currencyCode":"USD",
"_isMainModelSelected":true,
"_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":441
},
"name":"Total Price of BOM"
},
{
"variableName":"_grandTotal",
"price":{
"currency":"USD",
"value":1213
},
"name":"Grand Total"
}
]
}
]
}
},
"systemCurrentDate":"2019-06-11",
"cacheInstanceId":"iqsvUuPj7jOYF2EjPWeJ6uSwBzy79LMI2UWqHZJtsBt9O7cO0IhwvWhfwnDquOBf"
}400 Response
Bad request input data
Root Schema : Error
Type:
Show Source
object-
message:
string
The error message
-
status:
string
The Error code