Skip to main content

Get resource attributes by resource lookup key

GET 

/:resourceType/:lookupKey/:lookupValue/attributes

Retrieves all attributes for a resource identified by its lookup key. Results will be paginated. The default number of attributes per page is 12, but can be up to 100.
A resource can be a product, category, user or usergroup.

Response fields

NameDescription
idAttribute Id
nameAttribute name
typeType of the value of the attribute
classAttribute class
valueAttribute value for the product. Depends on the type.
inheritedBoolean. Indicates whether the value is directly set on the product or inherited from a parent resource. For text and list type attributes, inherited is part of the localized string for each language.

Request

Path Parameters

    resourceType stringrequired

    Resource type. Possible values are products, categories, users, usergroups

    lookupKey stringrequired

    Lookup key. Use different lookup keys depending on the resource type

    lookupValue stringrequired

    The value of the key (an id, sourceId, sku, etc.)

Query Parameters

    page string

    Page number

    offset string

    Number of results per page

    source string

    Optional. Used in combination with lookup key sourceId

Responses

Get product attributes by product id - 200 (with results) / Get product attributes by product id - 200 (no results) / Get user attributes by user id - 200 / Get usergroup attributes by usergroup id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

  • class string
    id number
    inherited boolean
    name string
    type string

    value

    object

    anyOf

  • Array [

  • inherited boolean
    language string
    value string
  • ]

  • ]

  • end number
    itemsFound number
    messages string[]
    offset number
    page number
    pages number
    start number
    total number
Loading...