Jump to

• Request
• Response
• Examples

Get an Account Lookup

get

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

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

Request

Path Parameters

• lookupId(required): string

Query Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AccountLookup

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• description: string
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: string()
  Title: Id

  Read Only: true

  The unique identifier of the account. Usually a number or a string depending on the integration.
• 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: Customer Id

  Read Only: true

  The customer Identifier of the account.
• meaning: string()
  Title: Company Name

  Read Only: true

  The company name of the account.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access 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"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "format":"",
            "description":"The unique identifier of the account. Usually a number or a string depending on the integration.",
            "title":"Id",
            "readOnly":true
        },
        "lookupCode":{
            "type":"string",
            "format":"",
            "description":"The customer Identifier of the account.",
            "title":"Customer Id",
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "format":"",
            "description":"The company name of the account.",
            "title":"Company Name",
            "readOnly":true
        },
        "description":{
            "type":"string"
        }
    }
}

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 : 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 : Link

Type: object

Show Source

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

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

Back to Top

Examples

The following examples show how to retrieve a customer account using the specified lookup Id 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"
https://sitename.oracle.com/rest/v19/pricingSetup/lookups/accounts/38452139

Response Body Sample

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

Back to Top