Search for Products
post
/rest/v16/products/actions/search
Use this endpoint to filter CPQ products using the specified search criteria.
Request
Supported Media Types
- application/json
Root Schema : Product Search Collection Request Definitions
Type:
object
Title:
Show Source
Product Search Collection Request Definitions
-
context:
object Product Search Context
Title:
Product Search Context
Context definition for product search. -
criteria:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request.
Nested Schema : Product Search Context
Type:
object
Title:
Product Search Context
Context definition for product search.
Show Source
-
commerce:
object Commerce Data
Title:
Commerce Data
Transaction data for products search. -
pricebookVarName:
string
Title:
Pricebook Variable Name
String value that specifies the variable Name of the pricebook.
Nested Schema : Query Definition
Type:
object
Title:
Query Definition
Captures the query definition for the current resource request.
Show Source
-
actions:
array actions
Array of actions names, whose state is requested in the state object response.
-
childDefs:
array childDefs
-
expand:
array expand
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
-
expandedDomains:
array expandedDomains
Array of field names, whose expanded domains are requested in the state object response.
-
fields:
array fields
Array of field names that you wanted returned in a request.
-
state:
boolean
Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
Nested Schema : Commerce Data
Type:
object
Title:
Commerce Data
Transaction data for products search.
Show Source
-
cacheInstanceId:
string
Title:
Cache Instance Id
The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action to avoid reload transaction data from db. -
currencyCode:
string
Title:
Currency Code
The currencyCode value in which the attribute is represented -
id:
string
Title:
Transaction Id
Current Unique Buyside ID of the transaction. -
mainDocument:
object Main Document Data
Title:
Main Document Data
The transaction's main document data. -
process:
object Process
Title:
Process
The transaction's process meta-data.
Nested Schema : Main Document Data
Type:
object
Title:
Main Document Data
The transaction's main document data.
Show Source
-
attributes:
object Attributes
Title:
Attributes
A set of key, value pairs with key being attribute's variableName and value being the value of the attribute.If its an msm, it can take list of values in items array. -
variableName:
string
Title:
Main Document Variable Name
The variable name of the main document that the current transaction data belongs to.
Nested Schema : Process
Type:
object
Title:
Process
The transaction's process meta-data.
Show Source
-
variableName:
string
Title:
Process Variable Name
The variable name of the process that the current transaction data belongs to.
Nested Schema : Attributes
Type:
object
Title:
Attributes
A set of key, value pairs with key being attribute's variableName and value being the value of the attribute.If its an msm, it can take list of values in items array.
Nested Schema : actions
Type:
array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type:
Show Source
array
-
Array of:
object Child query criteria.
Title:
Child query criteria.
Captures the query criteria for the child resource.
Nested Schema : expand
Type:
array
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
Show Source
Nested Schema : expandedDomains
Type:
array
Array of field names, whose expanded domains are requested in the state object response.
Show Source
Nested Schema : fields
Type:
array
Array of field names that you wanted returned in a request.
Show Source
Nested Schema : Child query criteria.
Type:
object
Title:
Child query criteria.
Captures the query criteria for the child resource.
Show Source
-
name:
string
Rest alias name of the child resource this query belongs to.
-
queryDef:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
recursive:
boolean
Boolean value that specifies whether this query is a recursive expand on the current child resource query.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Product Search Collection Response Definitions
Type:
object
Title:
Show Source
Product Search Collection Response Definitions
-
result:
object Product Collection Definitions
Title:
Product Collection Definitions
Nested Schema : Product Collection Definitions
Type:
object
Title:
Show Source
Product Collection Definitions
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Product Instance Definitions
Title:
Product Instance Definitions
Nested Schema : Product Instance Definitions
Type:
object
Title:
Show Source
Product Instance Definitions
-
bomItemVariableName:
string
Title:
BOM Item Variable Name
The variable name of the BOM item -
description:
string
Title:
Description
Description of the Product -
id:
integer
Title:
Id
Resource ID -
label:
string
Title:
Label
Product label -
model:
string
Title:
Model
Name of the model -
modelPath:
string
Title:
Uniquely identifies a product model
The variable name of the Model Path -
partNumber:
string
Title:
Part Number
Part number of the Product -
productIdentifier:
string
Title:
Product Identifier
Uniquely identifies a Product -
productType:
object Product Type
Title:
Product Type
Type of The Product -
status:
object Status
Title:
Status
Workflow status of this product
Nested Schema : Product Type
Type:
object
Title:
Product Type
Type of The Product
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Status
Type:
object
Title:
Status
Workflow status of this product
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Examples
The following example shows how to retrieve CPQ products using the specified search criteria by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/products/actions/search
Request Body Sample
{ "criteria": { "totalResults": true, "limit": 3, "offset": 0, "q": "{'productType': {'$like': '%Part%'}}", "keywords": ["GEN"], "orderby": ["productType:ASC", "partNumber:DESC"] }, "context": { "pricebookVarName": "pricebook1", "commerce": { "id": "20587705" } } }
Response Body Sample
{ "result": { "totalResults": 475, "offset": 0, "limit": 3, "count": 3, "hasMore": true, "items": [{ "productIdentifier": "PART_zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5555555555", "modelPath": null, "description": "zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5\nProduct with Lot, Revision, Locator and Serial generation at WO issue with Supply Type of Push", "label": "Product with Lot, Revision, Locator and Serial generation at WO issue with Supply Type of Push", "bomItemVariableName": null, "model": null, "partNumber": "zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD5555555555", "id": 37631912, "productType": { "displayValue": "Part", "lookupCode": "0" }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" } }, { "productIdentifier": "PART_zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1", "modelPath": null, "description": "zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1\nzREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1", "label": "Product with Lot, Revision, Locator and Serial generation at WO issue with Supply Type of Push", "bomItemVariableName": null, "model": null, "partNumber": "zREL11_BIAMFG-W-SER-LOT-REV-LOC-PROD1", "id": 37631918, "productType": { "displayValue": "Part", "lookupCode": "0" }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" } }, { "productIdentifier": "PART_zREL11_BIAMFG-W-SER-LOT-REV-LOC-COMP6666", "modelPath": null, "description": null, "label": "Component with Lot, Revision, Locator and Serial generation at WO issue with Supply Type of Push", "bomItemVariableName": null, "model": null, "partNumber": "zREL11_BIAMFG-W-SER-LOT-REV-LOC-COMP6666", "id": 37631911, "productType": { "displayValue": "Part", "lookupCode": "0" }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" } } ] } }