Get a Product
get
/rest/v16/products/{productId}
Use this endpoint to retrieve the specified CPQ product.
Request
Supported Media Types
- application/json
Path Parameters
-
productId(required): string
Uniquely identifies a Product
Response
Supported Media Types
- application/json
Default Response
Root 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 a retrieve the specified CPQ product by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/products/PART_255"
Response Body Sample
{ "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/v16/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/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" } ] } }