REST API Services for Oracle CPQ

Get All Products

get

/rest/v16/products

Use this endpoint to retrieve all CPQ products.

Request

Supported Media Types

application/json

Query Parameters

fields: string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit: integer

The requested page size, which limits the number of elements the collection should max return.
offset: integer

The offset of the page. By default, offset is 0, which means first page will be returned.
orderby: string

Specifies a comma-separated list of pairs to order the response by.
q: string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults: boolean

Specifies that the total count of records should be included in the response when doing pagination.

Response

Supported Media Types

application/json

Default Response

Root Schema : Product Collection Definitions

Type: object

Title: Product Collection Definitions

Show Source

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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/products"
            }
        }
    },
    "title":"Product Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

Array of: object Product Instance Definitions

Title: Product Instance Definitions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/products"
    }
}

Nested Schema : Product Instance Definitions

Type: object

Title: Product Instance Definitions

Show Source

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

{
    "type":"object",
    "properties":{
        "bomItemVariableName":{
            "type":"string",
            "description":"The variable name of the BOM item",
            "title":"BOM Item Variable Name"
        },
        "description":{
            "type":"string",
            "description":"Description of the Product",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Resource ID",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Product label",
            "title":"Label"
        },
        "model":{
            "type":"string",
            "description":"Name of the model",
            "title":"Model"
        },
        "modelPath":{
            "type":"string",
            "description":"The variable name of the Model Path",
            "title":"Uniquely identifies a product model"
        },
        "partNumber":{
            "type":"string",
            "description":"Part number of the Product",
            "title":"Part Number"
        },
        "productIdentifier":{
            "type":"string",
            "description":"Uniquely identifies a Product",
            "title":"Product Identifier"
        },
        "productType":{
            "type":"object",
            "description":"Type of The Product",
            "title":"Product Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Workflow status of this product",
            "title":"Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        }
    },
    "title":"Product Instance Definitions"
}

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.

{
    "type":"object",
    "description":"Type of The Product",
    "title":"Product Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Workflow status of this product",
    "title":"Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve a list of CPQ products 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?limit=5&keywords=GEN&orderby=label:DESC&q={"$and":[{"productType":{"$eq":"Part", "$options":"I"}}]}"

Response Body Sample

{
  "offset": 0,
  "limit": 5,
  "count": 5,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/products"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/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/v16/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/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"
          }
        ]
      }
    }, {
      "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/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"
          }
        ]
      }
    }, {
      "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/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"
          }
        ]
      }
    }, {
      "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/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"
          }
        ]
      }
    }, {
      "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/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"
          }
        ]
      }
    }
  ]
}