Skip to main content

Get Attribute

GET 
/v2/attributes/:resourceType/:lookupKey/:lookupValue/attributes/:attributeLookupKey/:attributeLookupValue

Get a single Attribute by resource lookupKey and lookupValue and by attribute lookupKey and lookupValue

Request​

Path Parameters

    resourceType stringrequired

    Possible values: [products, clusters, categories, customers, contacts, companies]

    The resourceType to get the attribute for

    Example: products
    lookupKey stringrequired

    Possible values: [id, sourceId]

    The lookupKey to find the resource by, i.e. id or sourceId

    Example: id
    lookupValue stringrequired

    The lookupValue to find the resource by, i.e. the id or the sourceId

    Example: 1234
    attributeLookupKey stringrequired

    Possible values: [id, sourceId]

    The lookupKey to find the attribute description by, i.e. id or name

    Example: id
    attributeLookupValue stringrequired

    The lookupValue to find the attribute description by, i.e. the id or the name

    Example: 1234

Query Parameters

    source string

    The source of the lookupValue when the lookupKey is a sourceId

    Example: EXAMPLE_SOURCE

Responses​

A single Attribute

Schema

    oneOf

    id uuidrequired

    Possible values: >= 36 characters and <= 36 characters

    The ID for this attribute

    createdAt date-time

    Default value: CURRENT_TIMESTAMP

    lastModifiedAt date-time

    Default value: CURRENT_TIMESTAMP

    createdBy integer

    The ID of the user that created the attribute

    lastModifiedBy integer

    The ID of the user that last modified the attribute

    attributeDescriptionId uuidrequired

    Possible values: >= 36 characters and <= 36 characters

    The AttributeDescription ID for this attribute

    value

    object

    required

    The value for this attribute

    oneOf

    id uuidrequired

    Possible values: >= 36 characters and <= 36 characters

    Unique identifier of the attribute value

    createdAt date-time

    Default value: CURRENT_TIMESTAMP

    Attribute value creation date

    lastModifiedAt date-time

    Default value: CURRENT_TIMESTAMP

    Attribute value last modified date

    createdBy integer

    The userId of the user that created the attribute value

    lastModifiedBy integer

    The userId of the user that last modified the attribute description

    textValues

    object[]

    required

    Attribute textValues per language

  • Array [

    • language stringrequired

    Possible values: >= 2 characters and <= 2 characters

    Language is set as 2 character country code.

    values array[]

    List of localized string values

  • ]

    • productId integerrequired

    The ID of the product this attribute belongs to

Loading...