Overview
These endpoints enable administration or pricing lookup values that are available for use in product charges.
Administration
|
Description |
Use this endpoint to add a custom pricing lookup type. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing lookup type is active |
|
description |
The description of the pricing lookup type | |
|
displayLabel |
The display label of the pricing lookup type | |
|
id |
The unique id of the pricing lookup type | |
|
integrationId |
The integration ID of the pricing lookup type | |
|
lookupType |
The unique lookup type |
|
|
lookupValues |
An array of lookup values | |
|
parentLookupType |
The parent lookup type for the pricing lookup type | |
|
type |
The type of the pricing lookup type. Allowed Values: "Custom Lookup" |
|
| Response Body Parameters |
JSON data for the newly added pricing lookup type. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups
{ "lookupType": "chargeTypes_c", "displayLabel": "Charge Types", "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee').", "type": "Custom Lookup", "integrationId": "charge_id", "active": true }
{ "lookupType": "chargeTypes_c", "displayLabel": "Charge Types", "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee').", "integrationId": "charge_id", "type": "Custom Lookup", "active": true }
|
Description |
Use this endpoint to add a pricing lookup value. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing lookup value is active |
|
description |
The description of the pricing lookup value | |
|
displayLabel |
The display label of the pricing lookup value | |
|
id |
The unique id of the pricing lookup value | |
|
integrationId |
The integration ID of the pricing lookup value | |
|
lookupCode |
The lookup code of the pricing lookup value |
|
|
lookupType |
The lookup type of the pricing lookup value | |
|
orderNumber |
The position, starting from 1, in a ordered list of Pricing Lookup Values | |
|
parentLookupCode |
The parent lookup code for the pricing lookup value | |
|
type |
The type of the pricing lookup value. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
| Response Body Parameters |
JSON data for the newly added lookup value. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes/lookupValues
{ "lookupType": "chargeTypes", "lookupCode": "installationFee", "displayLabel": "Installation Fee", "description": "", "active": true, "type": "Standard Value", "orderNumber": 4 }
{ "lookupType": "chargeTypes", "lookupCode": "installationFee", "displayLabel": "Installation Fee", "description": "", "active": true, "type": "Standard Value", "orderNumber": 4 }
|
Description |
Use this endpoint to delete the specified pricing lookup type. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to delete the specified pricing lookup value. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues/{lookupCode} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint retrieve the specified pricing lookup type. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing lookup type is active |
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the pricing lookup type | |
|
dateModified |
Last modified date of the pricing lookup type | |
|
description |
The description of the pricing lookup type | |
|
displayLabel |
The display label of the pricing lookup type | |
|
id |
The unique id of the pricing lookup type | |
|
integrationId |
The integration ID of the pricing lookup type | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
links |
he link relations associated with the resource instance | |
|
lookupType |
The unique lookup type | |
|
lookupValues |
An array of lookup values | |
|
parentLookupType |
The parent lookup type for the pricing lookup type | |
|
type |
The type of the pricing lookup type. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes
{ "dateModified": "2023-01-18T17:50:22Z", "dateAdded": "2023-01-18T17:50:22Z", "lookupType": "chargeTypes", "displayLabel": "Charge Types", "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee'.", "type": "Standard Lookup", "active": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes/lookupValues" } ] }
|
Description |
Use this endpoint to retrieve all pricing lookup types. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters | A collection of pricing lookup types. | |
|
active |
Indicates if the pricing lookup type is active | |
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the pricing lookup type | |
|
dateModified |
Last modified date of the pricing lookup type | |
|
description |
The description of the pricing lookup type | |
|
displayLabel |
The display label of the pricing lookup type | |
|
id |
The unique id of the pricing lookup type | |
|
integrationId |
The integration ID of the pricing lookup type | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
links |
he link relations associated with the resource instance | |
|
lookupType |
The unique lookup type | |
|
lookupValues |
An array of lookup values | |
|
parentLookupType |
The parent lookup type for the pricing lookup type | |
|
type |
The type of the pricing lookup type. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups
{ "items": [{ "dateModified": "2023-01-18T17:50:22Z", "dateAdded": "2023-01-18T17:50:22Z", "lookupType": "chargeTypes", "displayLabel": "Charge Types", "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee'.", "type": "Standard Lookup", "active": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes/lookupValues" } ] }, { "dateModified": "2023-01-18T17:50:23Z", "dateAdded": "2023-01-18T17:50:23Z", "lookupType": "priceTypes", "displayLabel": "Price Types", "description": "Indicates the basis on which the pricing will be levied, whether one time, on a periodic basis or on usage. When pricing is rolled up for a model or system the pricing may contain a mixture of price types and is indicated by the value 'mixed'.", "type": "Standard Lookup", "active": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceTypes" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceTypes/lookupValues" } ] }, { "dateModified": "2023-01-18T17:50:23Z", "dateAdded": "2023-01-18T17:50:23Z", "lookupType": "pricePeriods", "displayLabel": "Price Periods", "description": "The time frequency, periodicity or recurrence with which the price is levied or charged. For example, usage prices may be charged to the customer monthly or weekly.", "type": "Standard Lookup", "active": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues" } ] }, { "dateModified": "2023-01-18T17:50:23Z", "dateAdded": "2023-01-18T17:50:23Z", "lookupType": "priceUOMs", "displayLabel": "Price Units of Measure", "description": "A standardized quantity in which products and services may be quoted and sold.", "type": "Standard Lookup", "active": true, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceUOMs" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceUOMs/lookupValues" } ] } ], "offset": 0, "limit": 1000, "count": 4, "hasMore": false, "links": [{ "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups" }, { "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups?offset=0&limit=1000" } ] }
URI Endpoint Sample with Query Parameters
Retrieve active lookup values of a single lookup.
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceTypes/lookupValues?onlyData=true&finder=findLookupItems;isActive=true
Sample Response Body with Query Parameters
{ "items": [{ "dateModified": "2023-02-08T23:26:57Z", "dateAdded": "2023-02-08T23:26:57Z", "lookupType": "priceTypes", "lookupCode": "oneTime", "displayLabel": "One Time", "description": "", "active": "active", "type": "Standard Value", "orderNumber": 1 }, { "dateModified": "2023-02-08T23:26:57Z", "dateAdded": "2023-02-08T23:26:57Z", "lookupType": "priceTypes", "lookupCode": "recurring", "displayLabel": "Recurring", "description": "", "active": "active", "type": "Standard Value", "orderNumber": 2 }, { "dateModified": "2023-02-08T23:26:58Z", "dateAdded": "2023-02-08T23:26:58Z", "lookupType": "priceTypes", "lookupCode": "usage", "displayLabel": "Usage", "description": "", "active": "active", "type": "Standard Value", "orderNumber": 3 } ], "offset": 0, "limit": 1000, "count": 3, "hasMore": false }
|
Description |
Use this endpoint retrieve the specified pricing lookup value. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues/{lookupCode} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing lookup value is active |
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the pricing lookup value | |
|
dateModified |
Last modified date of the pricing lookup value | |
|
description |
The description of the pricing lookup value | |
|
displayLabel |
The display label of the pricing lookup value | |
|
id |
The unique id of the pricing lookup value | |
|
integrationId |
The integration ID of the pricing lookup value | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
links |
he link relations associated with the resource instance | |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
lookupTyoe |
The lookup type of the pricing lookup value | |
|
orderNumber |
The position, starting from 1, in a ordered list of Pricing Lookup Values. | |
|
parentLookupCode |
The parent lookup code for the pricing lookup value | |
|
type |
The type of the pricing lookup value. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues/monthly
{ "dateModified": "2022-12-16T02:12:35Z", "dateAdded": "2022-12-16T02:12:35Z", "lookupType": "pricePeriods", "lookupCode": "monthly", "displayLabel": "Month", "description": "", "active": true, "type": "Standard Value", "orderNumber": 0 }
|
Description |
Use this endpoint to retrieve all pricing lookup values for the specified lookup type. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters | A collection of pricing lookup values. | |
|
active |
Indicates if the pricing lookup value is active | |
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the pricing lookup value | |
|
dateModified |
Last modified date of the pricing lookup value | |
|
description |
The description of the pricing lookup value | |
|
displayLabel |
The display label of the pricing lookup value | |
|
id |
The unique id of the pricing lookup value | |
|
integrationId |
The integration ID of the pricing lookup value | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
links |
he link relations associated with the resource instance | |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
lookupTyoe |
The lookup type of the pricing lookup value | |
|
orderNumber |
The position, starting from 1, in a ordered list of Pricing Lookup Values | |
|
parentLookupCode |
The parent lookup code for the pricing lookup value | |
|
type |
The type of the pricing lookup value. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues
{ "items": [{ "dateModified": "2022-12-16T02:12:35Z", "dateAdded": "2022-12-16T02:12:35Z", "lookupType": "pricePeriods", "lookupCode": "monthly", "displayLabel": "Month", "description": "", "active": true, "type": "Standard Value", "orderNumber": 0, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues/monthly" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues" } ] }, { "dateModified": "2022-12-16T02:12:35Z", "dateAdded": "2022-12-16T02:12:35Z", "lookupType": "pricePeriods", "lookupCode": "yearly", "displayLabel": "Year", "description": "", "active": true, "type": "Standard Value", "orderNumber": 4, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues/yearly" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues" } ] } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues" }, { "rel": "self", "href": "http://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/pricePeriods/lookupValues?offset=0&limit=1000" } ] }
|
Description |
Use this endpoint to update pricing lookup types. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target pricing lookup type. Refer to Update Pricing Lookup Type for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups
[{ "op": "add", "path": "/", "value": { "lookupType": "pricePeriods", "displayLabel": "Price Periods", "description": "The time frequency, periodicity or recurrence with which the price is levied or charged. For example, usage prices may be charged to the customer monthly or weekly.", "type": "Standard Lookup" } }, { "op": "remove", "path": "/chargeTypes" }, { "op": "replace", "path": "/priceUOMs", "value": { "description": "A standardized quantity in which products and services may be quoted and sold.", "displayLabel": "Unit of Measures" } } ]
|
Description |
Use this endpoint to update the specified pricing lookup type. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the pricing lookup type is active |
|
description |
The description of the pricing lookup type | |
|
displayLabel |
The display label of the pricing lookup type | |
|
id |
The unique id of the pricing lookup type | |
|
integrationId |
The integration ID of the pricing lookup type | |
|
lookupType |
The unique lookup type | |
|
lookupValues |
An array of lookup values | |
|
parentLookupType |
The parent lookup type for the pricing lookup type | |
|
type |
The type of the pricing lookup type. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes
{ "lookupType": "chargeTypes", "displayLabel": "Charge Types", "description": "Identifies the value that will be received by the customer for a charge price. For example, the sale of a network device may have both a one time purchase price (with charge type of 'Purchase Price') and a one time installation price (with charge type of 'Installation Fee').", "type": "Standard Lookup", "integrationId": "charge_id", "active": true }
|
Description |
Use this endpoint to update pricing lookup types. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target pricing lookup type. Refer to Update Pricing Lookup Type for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/priceTypes/lookupValues
[{ "op": "add", "path": "/", "value": { "lookupType": "pricePeriods", "displayLabel": "Price Periods", "description": "The time frequency, periodicity or recurrence with which the price is levied or charged. For example, usage prices may be charged to the customer monthly or weekly.", "type": "Standard Lookup" } }, { "op": "remove", "path": "/chargeTypes" }, { "op": "replace", "path": "/priceUOMs", "value": { "description": "A standardized quantity in which products and services may be quoted and sold.", "displayLabel": "Unit of Measures" } } ]
|
Description |
Use this endpoint to update the specified pricing lookup value. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues/{lookupCode} |
|
|
Endpoint Parameters |
lookupTypeVariableName |
The variable name of the lookup type |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the pricing lookup value is active |
|
description |
The description of the pricing lookup value | |
|
displayLabel |
The display label of the pricing lookup value | |
|
id |
The unique id of the pricing lookup value | |
|
integrationId |
The integration ID of the pricing lookup value | |
|
lookupCode |
The lookup code of the pricing lookup value | |
|
lookupTyoe |
The lookup type of the pricing lookup value | |
|
orderNumber |
The position, starting from 1, in a ordered list of Pricing Lookup Values | |
|
parentLookupCode |
The parent lookup code for the pricing lookup value | |
|
type |
The type of the pricing lookup value. Allowed Values: "Standard Lookup", "Custom Lookup" |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/pricingLookups/chargeTypes/lookupValues/purchasePrice
{ "lookupType": "chargeTypes", "lookupCode": "purchasePrice", "displayLabel": "Purchase Price", "description": "", "active": true, "type": "Standard Value", "orderNumber": 0 }
