Lookup REST APIs

Overview

The Pricing Engine references several other business objects within CPQ. These lookup APIs retrieve an unfiltered list of important values for the specified business object comprising a set of ids, lookup codes, meanings, and descriptions. For example, the lookup codes retrieved for accounts are the account Ids visible in the CPQ native Account Object. For parts, the lookup codes are part numbers.

Administration

ClosedGet Lookups for All Accounts

Get Lookups for All AccountsGET Method

Description

Use this endpoint to retrieve a list of lookup values for customer accounts.

URI Endpoint

/rest/v17/pricingSetup/lookups/accounts

Endpoint Parameters

None

(Optional) This endpoint supports the following query specifications: fields, finder, limit, offset, onlyData, orderby, and totalResults, For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

A collection of account lookup values.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts

The finder query specification is used in the following example to return results that contain the "Customer" keyword.

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts?finder=findByKeyword;keyword=Customer


ClosedSample Response Body

{ "items": [{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452133" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" } ], "id": "38452133", "lookupCode": "Customer_Gold1", "meaning": "Customer_Gold1" }, { "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452135" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" } ], "id": "38452135", "lookupCode": "Customer_Gold2", "meaning": "Customer_Gold2" }, { "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452137" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" } ], "id": "38452137", "lookupCode": "Customer_Silver1", "meaning": "Customer_Silver1" }, { "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452139" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" } ], "id": "38452139", "lookupCode": "Customer_Platinum1", "meaning": "Customer_Platinum1" } ], "offset": 0, "limit": 1000, "count": 4, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts?offset=0&limit=1000&finder=findByKeyword;keyword=Customer" } ] }


ClosedGet Lookups for an Account

Get Lookups for an AccountGET Method

Description

Use this endpoint to retrieve a customer account using the specified lookup Id.

URI Endpoint

/rest/v17/pricingSetup/lookups/accounts/{lookupId}

Endpoint Parameters

lookupId

The account lookup Id.

HTTP Method

GET

Request Body Parameters

None

None

Response Body Parameters

The lookup values for the specified account.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452139


ClosedSample Response Body

{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts/38452139" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/accounts" } ], "id": "38452139", "lookupCode": "Customer_Platinum1", "meaning": "Customer_Platinum1" }


ClosedGet Lookups for All Supported Currencies

Get Lookups for All Supported CurrenciesGET Method

Description

Use this endpoint to retrieve a list of lookup values for supported currencies.

URI Endpoint

/rest/v17/pricingSetup/lookups/currencies

Endpoint Parameters

None

(Optional) This endpoint supports the following query specifications:finder, limit, offset, orderby, and totalResults. For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

A collection of lookup values for supported currencies.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/currencies

The onlyData query specification is used in the following example to omit links in the response.

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/currencies/?onlyData=true


ClosedSample Response Body

{ "items": [{ "id": "36683896", "lookupCode": "DemoAccount", "meaning": "PG" }, { "id": "38114818", "lookupCode": "1001", "meaning": "ABC Solutions, Inc." }, { "id": "38160524", "lookupCode": "Test", "meaning": "Test" }, { "id": "38452133", "lookupCode": "Customer_Gold1", "meaning": "Customer_Gold1" }, { "id": "38452135", "lookupCode": "Customer_Gold2", "meaning": "Customer_Gold2" }, { "id": "38452137", "lookupCode": "Customer_Silver1", "meaning": "Customer_Silver1" }, { "id": "38452139", "lookupCode": "Customer_Platinum1", "meaning": "Customer_Platinum1" } ], "offset": 0, "limit": 1000, "count": 7, "hasMore": false }


ClosedGet Lookups for a Supported Currency

Get Lookups for a Supported CurrencyGET Method

Description

Use this endpoint to retrieve a supported currency using the specified lookup Id.

URI Endpoint

/rest/v17/pricingSetup/lookups/currencies/{lookupId}

Endpoint Parameters

lookupId

The currency lookup Id.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

Lookup values for the specified currencies.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/currencies/5190371


ClosedSample Response Body

{ "storedPrecision": 2, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/currencies/5190371" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/currencies" } ], "id": "5190371", "lookupCode": "GBP", "meaning": "United Kingdom Pound", "description": "United Kingdom" }


ClosedGet Lookups for All Supported Data Sources

Get Lookups for All Supported Data SourcesGET Method

Description

Use this endpoint to retrieve a list lookup values for supported data sources.

URI Endpoint

/rest/v17/pricingSetup/lookups/dataSources

Endpoint Parameters

None

(Optional) This endpoint supports the following query specifications: fields, finder, limit, offset, onlyData, orderby, and totalResults, For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

A collection of lookup values for supported data sources.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSources


ClosedSample Response Body

{ "items": [{ "label": "Oracle Quote to Order", "dataSourceType": "Commerce Main Doc Attributes", "id": "36244034", "variableName": "_cm_oraclecpqo_main", "lookupCode": "_cm_oraclecpqo_main", "meaning": "Commerce Main Doc Attributes", "description": "Oracle Quote to Order" }, { "label": "Oracle Quote to Order", "dataSourceType": "Commerce All Doc Attributes", "id": "36244034", "variableName": "oraclecpqo", "lookupCode": "oraclecpqo", "meaning": "Commerce All Doc Attributes", "description": "Oracle Quote to Order" }, { "label": "test", "dataSourceType": "Commerce Main Doc Attributes", "id": "38423181", "variableName": "_cm_test_main", "lookupCode": "_cm_test_main", "meaning": "Commerce Main Doc Attributes", "description": "test" }, { "label": "test", "dataSourceType": "Commerce All Doc Attributes", "id": "38423181", "variableName": "test", "lookupCode": "test", "meaning": "Commerce All Doc Attributes", "description": "test" }, { "label": "Item Attributes", "dataSourceType": "Part Custom Attributes", "id": "-1", "variableName": "PART_CUSTOM_ATTRS", "lookupCode": "PART_CUSTOM_ATTRS", "meaning": "Part Custom Attributes", "description": "Item Attributes" }, { "label": "Configuration : Unity INC", "dataSourceType": "Configuration Attributes", "id": "unityINC", "variableName": "CONFIG_ATTRS_unityINC", "lookupCode": "CONFIG_ATTRS_unityINC", "meaning": "Configuration Attributes", "description": "Configuration : Unity INC" }, { "label": "Configuration : Vario Tablets", "dataSourceType": "Configuration Attributes", "id": "varioTablets", "variableName": "CONFIG_ATTRS_varioTablets", "lookupCode": "CONFIG_ATTRS_varioTablets", "meaning": "Configuration Attributes", "description": "Configuration : Vario Tablets" }, { "label": "Configuration : Vision Services", "dataSourceType": "Configuration Attributes", "id": "visionServices", "variableName": "CONFIG_ATTRS_visionServices", "lookupCode": "CONFIG_ATTRS_visionServices", "meaning": "Configuration Attributes", "description": "Configuration : Vision Services" }, { "label": "Configuration : Vision Vehicles", "dataSourceType": "Configuration Attributes", "id": "visionVehicles", "variableName": "CONFIG_ATTRS_visionVehicles", "lookupCode": "CONFIG_ATTRS_visionVehicles", "meaning": "Configuration Attributes", "description": "Configuration : Vision Vehicles" }, { "label": "Configuration : All Products", "dataSourceType": "Configuration Attributes", "id": "_all_products", "variableName": "CONFIG_ATTRS__all_products", "lookupCode": "CONFIG_ATTRS__all_products", "meaning": "Configuration Attributes", "description": "Configuration : All Products" } ], "offset": 0, "limit": 1000, "count": 10, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSources" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSources?offset=0&limit=1000" } ] }


ClosedGet Lookups for a Data Source's Attributes

Get Lookups for a Data Source's AttributesGET Method

Description

Use this endpoint to retrieve all attributes for a supported data source.

URI Endpoint

/rest/v17/pricingSetup/lookups/dataSources/{dataSourceVariableName}/attributes

Endpoint Parameters

dataSourceVariableName

The data source variable name.

(Optional) This endpoint supports the following query specifications: fields, limit, offset, onlyData, orderby, and totalResults. For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

A collection of attribute lookup values for a supported data source.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSourcesCONFIG_ATTRS_visionVehicles/attributes

The limit query specification is used in the following example to limit the results to five attributes per page.

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSourcesCONFIG_ATTRS_visionVehicles/attributes?limit=5


ClosedSample Response Body

{ "items": [{ "label": "Variable Name", "variableName": "_bm_pline_variable_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_pline_variable_name", "lookupCode": "_bm_pline_variable_name", "meaning": "/config/visionVehicles/_bm_pline_variable_name", "description": "Variable Name", "id": "_bm_pline_variable_name" }, { "label": "Partner Organization Id", "variableName": "_bm_model_partner_organization_id", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_partner_organization_id", "lookupCode": "_bm_model_partner_organization_id", "meaning": "/config/visionVehicles/_bm_model_partner_organization_id", "description": "Partner Organization Id", "id": "_bm_model_partner_organization_id" }, { "label": "Variable Name", "variableName": "_bm_model_variable_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_variable_name", "lookupCode": "_bm_model_variable_name", "meaning": "/config/visionVehicles/_bm_model_variable_name", "description": "Variable Name", "id": "_bm_model_variable_name" }, { "label": "Name", "variableName": "_bm_pline_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_pline_name", "lookupCode": "_bm_pline_name", "meaning": "/config/visionVehicles/_bm_pline_name", "description": "Name", "id": "_bm_pline_name" }, { "label": "Name", "variableName": "_bm_model_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_name", "lookupCode": "_bm_model_name", "meaning": "/config/visionVehicles/_bm_model_name", "description": "Name", "id": "_bm_model_name" } ], "offset": 0, "limit": 5, "count": 5, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSources/CONFIG_ATTRS_visionVehicles/attributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/dataSources/CONFIG_ATTRS_visionVehicles/attributes?offset=0&limit=5" } ] }


ClosedGet Lookups for All Parts

Get Lookups for All PartsGET Method

Description

Use this endpoint to retrieve a list of lookup values for parts.

URI Endpoint

/rest/v17/pricingSetup/lookups/parts

Endpoint Parameters

None

(Optional) This endpoint supports the following query specifications: fields, finder, limit, offset, onlyData, orderby, and totalResults. For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

A collection of lookup values for parts.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/parts

The following example uses the limit query specification to limit the results to five parts per page, and the onlyData query specification to omit links in the response.

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/parts?limit=5&onlyData=true


ClosedSample Response Body

{ "items": [{ "id": "36551467", "lookupCode": "GS5004", "meaning": "Green Server", "description": "" }, { "id": "36594573", "lookupCode": "Vario Tablet Custom", "meaning": "Vario Tablet", "description": "" }, { "id": "36594576", "lookupCode": "CPU-100M-19", "meaning": "Quad Core 1.9 GHz", "description": "Quad Core 1.9 GHz" }, { "id": "36594580", "lookupCode": "CPU-100M-25", "meaning": "Quad Core 2.5 GHz", "description": "Quad Core 2.5 GHz" }, { "id": "36594583", "lookupCode": "MEM-100M-1", "meaning": "1GB Memory", "description": "1GB Memory" } ], "offset": 0, "limit": 5, "count": 5, "hasMore": true }


ClosedGet Lookups for a Part

Get Lookups for a PartGET Method

Description

Use this endpoint to retrieve lookup values for a part using the specified lookup Id.

URI Endpoint

/rest/v17/pricingSetup/lookups/parts/{lookupId}

Endpoint Parameters

lookupId

The lookup Id for the part.

(Optional) This endpoint supports the following query specifications.q, expand, fields, limit, offset, orderby, and totalResults, for more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

The lookup values for the specified part.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/parts/38644102


ClosedSample Response Body

{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/parts/38644102" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/parts" } ], "id": "38644102", "lookupCode": "VEHICLE", "description": "SUV Subscription" }


ClosedGet Lookups for All Simple Condition Attributes

Get Lookups for All Simple Condition AttributesGET Method

Description

Use this endpoint to retrieve a list of lookup values for all simple condition attributes.

URI Endpoint

/rest/v17/pricingSetup/lookups/simpleConditionAttributes

Endpoint Parameters

None

(Optional) This endpoint supports the following query specifications: fields, finder, limit, offset, onlyData, orderby, and totalResults. For more information, see Manage Collections.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

 

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes

The limit query specification is used in the following example to limit the results to five attributes per page.

https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes?limit=5


ClosedSample Response Body

{ "items": [{ "type": "Integer", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes/36831550" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" } ], "id": "36831550", "lookupCode": "oRCL_pRC_quantity", "meaning": "Quantity" }, { "type": "String", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes/36831551" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" } ], "id": "36831551", "lookupCode": "oRCL_pRC_partNumber", "meaning": "Part Number" }, { "type": "String", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes/36831552" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" } ], "id": "36831552", "lookupCode": "oRCL_pRC_externalParentKey", "meaning": "External Parent Key" }, { "type": "Date", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes/36831553" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" } ], "id": "36831553", "lookupCode": "oRCL_pRC_contractStartDate", "meaning": "Contract Start Date" }, { "type": "Boolean", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes/36831554" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" } ], "id": "36831554", "lookupCode": "oRCL_pRC_useUsageLock", "meaning": "Use Usage Lock" } ], "offset": 0, "limit": 5, "count": 5, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes?offset=0&limit=5" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/lookups/simpleConditionAttributes?offset=5&limit=5" } ] }


 

Related Topics

Related Topics Link IconSee Also