Add a Pricing Lookup
post
/rest/v19/pricingSetup/pricingLookups
Use this endpoint to add a pricing lookup type.
Request
Supported Media Types
- application/json
Root Schema : LookupType
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the lookup type is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the lookup type. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the lookup type. -
description:
string()
Title:
Description
The description of the lookup type. -
displayLabel:
string()
Title:
Display Label
The display label of the lookup type. -
id:
integer()
Title:
ID
The ID of the lookup type. -
integrationId:
string()
Title:
Integration ID
The integration ID of the lookup type. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
lookupType:
string()
Title:
Lookup Type
The unique lookup type. -
lookupValues:
Lookup Values
Title:
Lookup Values
Read Only:true
The collection of lookup values for the Lookup Type. Note this is a child resource. -
parentLookupType:
string()
Title:
Parent Lookup Type
The parent lookup type for the lookup type. -
type:
string()
Title:
Type
Allowed Values:[ "Standard Lookup", "Custom Lookup" ]
The type of the lookup type.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Lookup Values
Title:
Lookup Values
Read Only:
true
The collection of lookup values for the Lookup Type. Note this is a child resource.
Match All
The collection of lookup values for the Lookup Type. Note this is a child resource.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingResourceCollection_LookupValue
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures 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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : LookupValue
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the lookup value is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the lookup value. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the lookup value. -
description:
string()
Title:
Description
The description of the lookup value. -
displayLabel:
string()
Title:
Display Label
The display label of the lookup value. -
id:
integer()
Title:
ID
Read Only:true
The ID of the lookup value. -
integrationId:
string()
Title:
Integration ID
The integration ID of the lookup value. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
lookupCode:
string()
Title:
Lookup Code
The lookup code of the lookup value. -
lookupType:
string()
Title:
Lookup Type
The lookup type of the lookup value. -
orderNumber:
integer()
Title:
Order Number
The position(starting from 1) in a ordered list of Lookup Values. -
parentLookupCode:
string()
Title:
Parent Lookup Code
The parent lookup code for the lookup value. -
type:
string()
Title:
Type
Read Only:true
Allowed Values:[ "Standard Value", "Custom Value" ]
The type of the lookup value.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : LookupType
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the lookup type is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the lookup type. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the lookup type. -
description:
string()
Title:
Description
The description of the lookup type. -
displayLabel:
string()
Title:
Display Label
The display label of the lookup type. -
id:
integer()
Title:
ID
The ID of the lookup type. -
integrationId:
string()
Title:
Integration ID
The integration ID of the lookup type. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
lookupType:
string()
Title:
Lookup Type
The unique lookup type. -
lookupValues:
Lookup Values
Title:
Lookup Values
Read Only:true
The collection of lookup values for the Lookup Type. Note this is a child resource. -
parentLookupType:
string()
Title:
Parent Lookup Type
The parent lookup type for the lookup type. -
type:
string()
Title:
Type
Allowed Values:[ "Standard Lookup", "Custom Lookup" ]
The type of the lookup type.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Lookup Values
Title:
Lookup Values
Read Only:
true
The collection of lookup values for the Lookup Type. Note this is a child resource.
Match All
The collection of lookup values for the Lookup Type. Note this is a child resource.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingResourceCollection_LookupValue
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures 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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : LookupValue
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the lookup value is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the lookup value. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the lookup value. -
description:
string()
Title:
Description
The description of the lookup value. -
displayLabel:
string()
Title:
Display Label
The display label of the lookup value. -
id:
integer()
Title:
ID
Read Only:true
The ID of the lookup value. -
integrationId:
string()
Title:
Integration ID
The integration ID of the lookup value. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
lookupCode:
string()
Title:
Lookup Code
The lookup code of the lookup value. -
lookupType:
string()
Title:
Lookup Type
The lookup type of the lookup value. -
orderNumber:
integer()
Title:
Order Number
The position(starting from 1) in a ordered list of Lookup Values. -
parentLookupCode:
string()
Title:
Parent Lookup Code
The parent lookup code for the lookup value. -
type:
string()
Title:
Type
Read Only:true
Allowed Values:[ "Standard Value", "Custom Value" ]
The type of the lookup value.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to add a custom pricing lookup type by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups
Request Body
{ "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 }
Response Body
{ "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 }