Search Attributes.

POST 
/v2/attributes/search

Searches for all Attributes for a specific attributeClass.

Request

application/json

Body

required

The search input

productIds integer[]

List of productIds to search attributes for

categoryIds integer[]

LIst of categoryIds to search attributes for

companyIds integer[]

List of companyIds to search attributes for

contactIds integer[]

List of contactIds to search attributes for

customerIds integer[]

List of customerIds to search attributes for

clusterIds integer[]

List of clusterIds to search attributes for

offset integer

Possible values: >= 1

Default value: 12

Pagination offset number

page integer

Possible values: >= 1

Default value: 1

Pagination page number

attributeDescription

object

ids uuid[]

Array of attributeDescriptionIds to search attributes for

names string[]

Array of attributeDescription names to search attributes for

types string[]

Possible values: [text, enum, color, datetime, integer, decimal]

Array of attributeDescription types to search attributes for

groups string[]

Array of attributeDescription groups to search attributes for

isSearchable boolean

Search for searchable attributes

isPublic boolean

Search for public attributes

isHidden booleannullable

Search for hidden attributes

isSystem boolean

Search for system attributes

Responses

200

A list of Attributes

application/json

Schema

Schema

• Array [

oneOf

ProductAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

productId integerrequired

The ID of the product this attribute belongs to

ClusterAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

clusterId integerrequired

The ID of the cluster this attribute belongs to

CategoryAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

categoryId integerrequired

The ID of the category this attribute belongs to

CompanyAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

companyId integerrequired

The ID of the company this attribute belongs to

ContactAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

contactId integerrequired

The ID of the contact this attribute belongs to

CustomerAttribute

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

AttributeTextValue

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

]

AttributeEnumValue

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

enumValues string[]required

Attribute enum values

AttributeIntValue

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

intValue integerrequired

Attribute integer value

AttributeDecimalValue

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

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

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

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

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

dateTimeValue date-timenullablerequired

Attribute decimal value

customerId integerrequired

The ID of the customer this attribute belongs to

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {},
  {}
]

401

Unauthorized

application/json

Schema

Schema

any

invalid_client_id

{
  "ErrorCode": "invalid_client",
  "Error": "ClientId is Invalid"
}

invalid_client_cred

{
  "ErrorCode": "invalid_client",
  "Error": "Client credentials are invalid"
}

Loading...