Jump to

• Request
• Response

Update a Pricing Lookup Value

patch

/rest/v19/pricingSetup/pricingLookups/{lookupTypeVarName}/lookupValues/{lookupCode}

Update a pricing lookup value.

Request

Supported Media Types

• application/json

Path Parameters

• lookupCode(required): string
• lookupTypeVarName(required): string

Body ()

Root 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"
    }
}

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

Response

204 Response

Success

Back to Top