Jump to

• Request
• Response
• Examples

Get All Pricing Lookups

get

/rest/v19/pricingSetup/pricingLookups

Use this endpoint to retrieve all pricing lookup types.

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=lookupValues. To include all the children and grandchildren, specify the value of this query parameter to be "all".
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>
  The following are the available finder names and corresponding finder variables:

  • findByKeyword: Find lookup types using lookup type and display name.
    Finder Variable:
    • keyword;string:The search text.

  • findLookupItems: Find active or inactive lookup types using the active field.
    Finder Variable:
    • isActive;string:The active field of the lookup type when true will return only active lookup types and false will return only inactive lookup types.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_LookupType

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupType"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object LookupType

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

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• 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

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : LookupType

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• type: string()
  Title: Type

  Allowed Values: [ "Standard Lookup", "Custom Lookup" ]

  The type of the lookup type.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the lookup type.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the lookup type.",
            "title":"Date Added",
            "readOnly":true
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The unique lookup type.",
            "title":"Lookup Type"
        },
        "displayLabel":{
            "type":"string",
            "format":"",
            "description":"The display label of the lookup type.",
            "title":"Display Label"
        },
        "parentLookupType":{
            "type":"string",
            "format":"",
            "description":"The parent lookup type for the lookup type.",
            "title":"Parent Lookup Type"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the lookup type.",
            "title":"Description"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"The integration ID of the lookup type.",
            "title":"Integration ID"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"The type of the lookup type.",
            "title":"Type",
            "enum":[
                "Standard Lookup",
                "Custom Lookup"
            ]
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the lookup type is active.",
            "title":"Active"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The ID of the lookup type.",
            "title":"ID"
        },
        "lookupValues":{
            "format":"",
            "description":"The collection of lookup values for the Lookup Type. Note this is a child resource.",
            "title":"Lookup Values",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_LookupValue"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

• object PricingResourceCollection_LookupValue

{
    "format":"",
    "description":"The collection of lookup values for the Lookup Type. Note this is a child resource.",
    "title":"Lookup Values",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_LookupValue"
        }
    ]
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingResourceCollection_LookupValue

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupValue"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object LookupValue

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

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : LookupValue

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• type: string()
  Title: Type

  Read Only: true

  Allowed Values: [ "Standard Value", "Custom Value" ]

  The type of the lookup value.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the lookup value.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the lookup value.",
            "title":"Date Added",
            "readOnly":true
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type of the lookup value.",
            "title":"Lookup Type"
        },
        "lookupCode":{
            "type":"string",
            "format":"",
            "description":"The lookup code of the lookup value.",
            "title":"Lookup Code"
        },
        "displayLabel":{
            "type":"string",
            "format":"",
            "description":"The display label of the lookup value.",
            "title":"Display Label"
        },
        "parentLookupCode":{
            "type":"string",
            "format":"",
            "description":"The parent lookup code for the lookup value.",
            "title":"Parent Lookup Code"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the lookup value.",
            "title":"Description"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"The integration ID of the lookup value.",
            "title":"Integration ID"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the lookup value is active.",
            "title":"Active"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"The type of the lookup value.",
            "title":"Type",
            "readOnly":true,
            "enum":[
                "Standard Value",
                "Custom Value"
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) in a ordered list of Lookup Values.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The ID of the lookup value.",
            "title":"ID",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Back to Top

Examples

The following example shows how to retrieve all pricing lookup types by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups

Response Body

{
  "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/v19/pricingSetup/pricingLookups/chargeTypes"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v19/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/v19/pricingSetup/pricingLookups/priceTypes"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v19/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/v19/pricingSetup/pricingLookups/pricePeriods"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v19/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/v19/pricingSetup/pricingLookups/priceUOMs"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/priceUOMs/lookupValues"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 4,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups?offset=0&limit=1000"
    }
  ]
}

URI Endpoint Sample with Query Parameters

Retrieve active lookup values of a single lookup.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/priceTypes/lookupValues?onlyData=true&finder=findLookupItems;isActive=true

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
}

Back to Top