REST API for Oracle Commerce Cloud

Performs an interact action on a configuration attribute for a particular product.

post

/ccstore/v1/cpq/configurations/interact

This endpoint updates an ajax enabled configuration attribute for a product and returns its configuration data and state.

Request

Supported Media Types

application/json

Root Schema : InteractRequest

Type: object

Show Source

arraySetLimit: number

The current no items to return per page of the array set that raised the interact request.
arraySetOffset: number

The current paging offset of the array set that raised the interact request.
arraySetVarName: string

The variable name of the array set that raised the interact request.
cacheInstanceId(required): string

cacheInstanceId of the current configuration
configData(required): object configData

A configData object that contains the updated configuration affected by the interact attribute update.
criteria: object criteria

This is being used as filter to be used on the CPQ payload
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.

{
    "type":"object",
    "required":[
        "productFamily",
        "productLine",
        "model",
        "configData",
        "cacheInstanceId"
    ],
    "properties":{
        "productFamily":{
            "description":"The productFamily of the model to be configured.",
            "type":"string"
        },
        "productLine":{
            "description":"The productLine of the model to be configured.",
            "type":"string"
        },
        "arraySetVarName":{
            "description":"The variable name of the array set that raised the interact request.",
            "type":"string"
        },
        "configData":{
            "description":"A configData object that contains the updated configuration affected by the interact attribute update.",
            "type":"object"
        },
        "criteria":{
            "description":"This is being used as filter to be used on the CPQ payload",
            "type":"object",
            "properties":{
                "childDefs":{
                    "description":"This property contains the filter value to be used at CPQ.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Name can contain the state property value that is required.",
                                "type":"string"
                            }
                        }
                    }
                },
                "state":{
                    "description":"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.",
                    "type":"boolean"
                }
            }
        },
        "cacheInstanceId":{
            "description":"cacheInstanceId of the current configuration",
            "type":"string"
        },
        "model":{
            "description":"The model to be configured.",
            "type":"string"
        },
        "arraySetLimit":{
            "description":"The current no items to return per page of the array set that raised the interact request.",
            "type":"number"
        },
        "arraySetOffset":{
            "description":"The current paging offset of the array set that raised the interact request.",
            "type":"number"
        }
    },
    "example":{
        "productFamily":"test1",
        "productLine":"productLine1",
        "configData":{
            "condition1":true
        },
        "model":"model1"
    }
}

Example:

{
    "productFamily":"test1",
    "productLine":"productLine1",
    "configData":{
        "condition1":true
    },
    "model":"model1"
}

Nested Schema : configData

Type: object

A configData object that contains the updated configuration affected by the interact attribute update.

Nested Schema : criteria

Type: object

This 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.

{
    "description":"This is being used as filter to be used on the CPQ payload",
    "type":"object",
    "properties":{
        "childDefs":{
            "description":"This property contains the filter value to be used at CPQ.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Name can contain the state property value that is required.",
                        "type":"string"
                    }
                }
            }
        },
        "state":{
            "description":"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.",
            "type":"boolean"
        }
    }
}

Nested Schema : childDefs

Type: array

This property contains the filter value to be used at CPQ.

Show Source

Array of: object items

{
    "description":"This property contains the filter value to be used at CPQ.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Name can contain the state property value that is required.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

name: string

Name can contain the state property value that is required.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name can contain the state property value that is required.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Updated configData and state for a particular product. This response is returned by an interact invocation.

Root Schema : InteractResponse

Type: object

Show Source

cacheInstanceId: string
configData: object configData
systemCurrentDate: string(date)

{
    "type":"object",
    "properties":{
        "configData":{
            "type":"object",
            "properties":{
                "textField2":{
                    "type":"string"
                },
                "textField1":{
                    "type":"string"
                },
                "_state":{
                    "type":"object",
                    "properties":{
                        "attributes":{
                            "format":"nullable",
                            "type":"string"
                        }
                    }
                },
                "_isMainModelSelected":{
                    "type":"boolean"
                },
                "_priceInfo":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "items":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "category":{
                                        "type":"object",
                                        "properties":{
                                            "code":{
                                                "type":"string"
                                            },
                                            "displayName":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "_others":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "variableName":{
                                                    "type":"string"
                                                },
                                                "price":{
                                                    "type":"object",
                                                    "properties":{
                                                        "currency":{
                                                            "type":"string"
                                                        },
                                                        "value":{
                                                            "format":"int32",
                                                            "type":"integer"
                                                        }
                                                    }
                                                },
                                                "name":{
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "systemCurrentDate":{
            "format":"date",
            "type":"string"
        },
        "cacheInstanceId":{
            "type":"string"
        }
    },
    "example":{
        "configData":{
            "textField2":"Value 1",
            "textField1":"Value 1",
            "_state":{
                "attributes":null
            },
            "_isMainModelSelected":true,
            "_priceInfo":{
                "name":"Price",
                "items":[
                    {
                        "category":{
                            "code":"GENERAL",
                            "displayName":"Price"
                        },
                        "_others":[
                            {
                                "variableName":"_totalConfiguredPrice",
                                "price":{
                                    "currency":"USD",
                                    "value":0
                                },
                                "name":"Total Configured Price of Model"
                            }
                        ]
                    }
                ]
            }
        },
        "systemCurrentDate":"2019-08-22",
        "cacheInstanceId":"3W96MAJjbbm7fYTTBNqWG5lXXGHVGIZWZUY2N21qyxI2xc9xABOnlVMpOJGLCvSi"
    }
}

Example:

{
    "configData":{
        "textField2":"Value 1",
        "textField1":"Value 1",
        "_state":{
            "attributes":null
        },
        "_isMainModelSelected":true,
        "_priceInfo":{
            "name":"Price",
            "items":[
                {
                    "category":{
                        "code":"GENERAL",
                        "displayName":"Price"
                    },
                    "_others":[
                        {
                            "variableName":"_totalConfiguredPrice",
                            "price":{
                                "currency":"USD",
                                "value":0
                            },
                            "name":"Total Configured Price of Model"
                        }
                    ]
                }
            ]
        }
    },
    "systemCurrentDate":"2019-08-22",
    "cacheInstanceId":"3W96MAJjbbm7fYTTBNqWG5lXXGHVGIZWZUY2N21qyxI2xc9xABOnlVMpOJGLCvSi"
}

Nested Schema : configData

Type: object

Show Source

_isMainModelSelected: boolean
_priceInfo: object _priceInfo
_state: object _state
textField1: string
textField2: string

{
    "type":"object",
    "properties":{
        "textField2":{
            "type":"string"
        },
        "textField1":{
            "type":"string"
        },
        "_state":{
            "type":"object",
            "properties":{
                "attributes":{
                    "format":"nullable",
                    "type":"string"
                }
            }
        },
        "_isMainModelSelected":{
            "type":"boolean"
        },
        "_priceInfo":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "category":{
                                "type":"object",
                                "properties":{
                                    "code":{
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "type":"string"
                                    }
                                }
                            },
                            "_others":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "variableName":{
                                            "type":"string"
                                        },
                                        "price":{
                                            "type":"object",
                                            "properties":{
                                                "currency":{
                                                    "type":"string"
                                                },
                                                "value":{
                                                    "format":"int32",
                                                    "type":"integer"
                                                }
                                            }
                                        },
                                        "name":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _priceInfo

Type: object

Show Source

items: array items
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "category":{
                        "type":"object",
                        "properties":{
                            "code":{
                                "type":"string"
                            },
                            "displayName":{
                                "type":"string"
                            }
                        }
                    },
                    "_others":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "variableName":{
                                    "type":"string"
                                },
                                "price":{
                                    "type":"object",
                                    "properties":{
                                        "currency":{
                                            "type":"string"
                                        },
                                        "value":{
                                            "format":"int32",
                                            "type":"integer"
                                        }
                                    }
                                },
                                "name":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _state

Type: object

Show Source

attributes: string(nullable)

{
    "type":"object",
    "properties":{
        "attributes":{
            "format":"nullable",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "category":{
                "type":"object",
                "properties":{
                    "code":{
                        "type":"string"
                    },
                    "displayName":{
                        "type":"string"
                    }
                }
            },
            "_others":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "variableName":{
                            "type":"string"
                        },
                        "price":{
                            "type":"object",
                            "properties":{
                                "currency":{
                                    "type":"string"
                                },
                                "value":{
                                    "format":"int32",
                                    "type":"integer"
                                }
                            }
                        },
                        "name":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

_others: array _others
category: object category

{
    "type":"object",
    "properties":{
        "category":{
            "type":"object",
            "properties":{
                "code":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                }
            }
        },
        "_others":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "variableName":{
                        "type":"string"
                    },
                    "price":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string"
                            },
                            "value":{
                                "format":"int32",
                                "type":"integer"
                            }
                        }
                    },
                    "name":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : _others

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "variableName":{
                "type":"string"
            },
            "price":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string"
                    },
                    "value":{
                        "format":"int32",
                        "type":"integer"
                    }
                }
            },
            "name":{
                "type":"string"
            }
        }
    }
}

Nested Schema : category

Type: object

Show Source

code: string
displayName: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

name: string
price: object price
variableName: string

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string"
        },
        "price":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "format":"int32",
                    "type":"integer"
                }
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : price

Type: object

Show Source

currency: string
value: integer(int32)

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "format":"int32",
            "type":"integer"
        }
    }
}

400 Response

Bad request input data

Root Schema : Error

Type: object

Show Source

message: string

The error message
status: string

The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}