Overview
This REST API is used to retrieve and search for Oracle CPQ products. Products consist of both stand-alone parts and product structures (i.e. BOM hierarchies).
Administration
Get a Product|
Description |
Use this endpoint to retrieve the specified CPQ product. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/products/{productId} |
|
|
Endpoint Parameters |
productId |
The unique identifier for the product |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
bomItemVariableName |
The variable name of the BOM item |
|
description |
Description of the Product |
|
|
id |
Resource ID |
|
|
label |
Product label |
|
|
model |
Name of the model |
|
|
modelPath |
The variable name of the Model Path |
|
|
partNumber |
Part number of the Product |
|
|
productIdentifier |
Uniquely identifies a Product |
|
|
productType |
Type of The Product |
|
|
status |
Workflow status of this product |
|
https://sitename.oracle.com/rest/v17/products/PART_255
{ "productIdentifier": "PART_255", "modelPath": null, "description": "License/Applications/Vertical ERP Applications/Oracle Other Applications/Other Applications/Tutor for Applications/Tutor General Ledger", "label": "Tutor General Ledger", "bomItemVariableName": null, "model": null, "partNumber": "255", "id": 37641510, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }
|
Description |
Use this endpoint to retrieve CPQ products, endpoint query parameters must be provided to filter results. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/products |
|
| Endpoint Parameters | None | |
| Query Parameters |
This endpoint supports the following optional parameters: |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
A list of Oracle CPQ products, both stand-alone parts and product structures (i.e. BOM hierarchies). |
|
https://sitename.oracle.com/rest/v17/products?limit=5&keywords=GEN&orderby=label:DESC&q={"$and":[{"productType":{"$eq":"Part", "$options":"I"}}]}
{ "offset": 0, "limit": 5, "count": 5, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/products" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/products?limit=5&keywords=GEN&orderby=label%3ADESC&q=%7B%22%24and%22%3A%5B%7B%22productType%22%3A%7B%22%24eq%22%3A%22Part%22%2C%20%22%24options%22%3A%22I%22%7D%7D%5D%7D&offset=5" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/products?limit=5&keywords=GEN&orderby=label%3ADESC&q=%7B%22%24and%22%3A%5B%7B%22productType%22%3A%7B%22%24eq%22%3A%22Part%22%2C%20%22%24options%22%3A%22I%22%7D%7D%5D%7D&offset=0" } ], "items": [{ "productIdentifier": "PART_MFG-PLG-PROD4", "modelPath": null, "description": null, "label": "shelf life and generation parent and child", "bomItemVariableName": null, "model": null, "partNumber": "MFG-PLG-PROD4", "id": 37805108, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }, { "productIdentifier": "PART_A60", "modelPath": null, "description": "License/Applications/ERP Applications/Oracle ERP Applications/Order Management/iStore/eCommerce Business Intelligence", "label": "eCommerce Business Intelligence", "bomItemVariableName": null, "model": null, "partNumber": "A60", "id": 37641084, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }, { "productIdentifier": "PART_STL", "modelPath": null, "description": "License/Database Technology/Database and Collaboration/Applications and Systems Management/Application Testing/Load Testing for Web Applications Controller/e-Load Professional Option: Generic Data Parser ServerStats", "label": "e-Load Professional Option: Generic Data Parser ServerStats", "bomItemVariableName": null, "model": null, "partNumber": "STL", "id": 37649152, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }, { "productIdentifier": "PART_RT00005", "modelPath": null, "description": null, "label": "Washing Detergent Powder w/bleach 117oz", "bomItemVariableName": null, "model": null, "partNumber": "RT00005", "id": 37278894, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }, { "productIdentifier": "PART_MFG-PLG-PROD3", "modelPath": null, "description": null, "label": "User defined exp and generation at parent", "bomItemVariableName": null, "model": null, "partNumber": "MFG-PLG-PROD3", "id": 37805109, "productType": { "displayValue": "Part", "lookupCode": "0", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_TYPE%22%7D%7D" } ] }, "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } } ] }
|
Description |
Use this endpoint to retrieve CPQ products using the specified search criteria. |
|||
|---|---|---|---|---|
|
URI Endpoint |
/rest/v17/products/actions/search |
|||
|
Endpoint Parameters |
None |
|||
|
HTTP Method |
POST |
|||
|
Request Body Parameters
|
criteria |
A top-level object in the payload used to specify the fields used to filter the parts or limit the number of parts returned in the response. * Advanced query object “q” criteria is supported. |
||
|
context
|
This object contains the context definition for the part search and can include:
|
|||
|
pricebookVarName |
The string value that specifies the variable name of the active price book. If the site uses price books, this is required. |
|||
|
config
|
The Configuration data for the part search. |
|||
|
currencyCode |
The code for the desired currency |
|||
|
allProducts |
Attributes belonging to all products |
|||
|
segment |
The variable name of a segment |
|||
|
productLine |
The variable name of a Product Line |
|||
|
model |
The variable name of the a Model |
|||
|
commerce |
Provides the Commerce process ID to be used in the part query. |
|||
|
id |
Current unique user-side ID. This is the internal identifier for a transaction within an Oracle CPQ site |
|||
|
cacheInstanceId |
The cache instance ID |
|||
|
currencyCode |
The code for the desired currency |
|||
|
process |
The process variable name |
|||
|
mainDocument |
The main document variable name |
|||
|
Response Body Parameters |
Returns a list of product search results |
|||
https://sitename.oracle.com/rest/v17/products/actions/search
{ "criteria": { "totalResults": true, "limit": 3, "offset": 0, "q": "{'productType': {'$like': '%Part%'}}", "keywords": ["GEN"], "orderby": ["productType:ASC", "partNumber:DESC"] }, "context": { "pricebookVarName": "pricebook1", "commerce": { "id": "20587705" } } }
{ "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" } } ] } }
