Get attribute by lookup key

GET 
/attributes/:lookupKey/:lookupValue

This endpoint is used to retrieve details of an attribute. The attribute is identified by it's Propeller Id or name. The attributeClass Query Param is useful to use when the same attribute name is used for an attribute with a different class.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Use id or name

lookupValue stringrequired

The id or name of the attribute

Query Parameters

attributeClass string

Attribute class. Optional. Used in combination with lookup key name. Possible values are product, category, user

Responses

200

Get attribute by Id - 200 / Get attribute by name and class - 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

application/json

Schema

Schema

data

object

class string

defaultLanguage string

descriptions

object[]

Array [

language string

value string

]

group string

id number

isHidden boolean

isPublic boolean

isSearchable boolean

isSystem boolean

name string

type string

typeParam string

units

object[]

Array [

language string

value string

]

value

object

anyOf

MOD1

string

MOD2

Array [

]

messages undefined[]
total number

Example (from schema)

{
  "data": {
    "class": "product",
    "defaultLanguage": "EN",
    "descriptions": [
      {
        "language": "EN",
        "value": "Color"
      },
      {
        "language": "NL",
        "value": "Kleur"
      }
    ],
    "group": "",
    "id": 668,
    "isHidden": false,
    "isPublic": true,
    "isSearchable": false,
    "isSystem": false,
    "name": "COLOR",
    "type": "enum",
    "typeParam": "COLORS",
    "units": [
      {
        "language": "EN",
        "value": ""
      },
      {
        "language": "NL",
        "value": ""
      }
    ],
    "value": ""
  },
  "messages": [],
  "total": 1
}

Get attribute by Id - 200

{
  "data": {
    "class": "product",
    "defaultLanguage": "EN",
    "descriptions": [
      {
        "language": "EN",
        "value": "Color"
      },
      {
        "language": "NL",
        "value": "Kleur"
      }
    ],
    "group": "",
    "id": 668,
    "isHidden": false,
    "isPublic": true,
    "isSearchable": false,
    "isSystem": false,
    "name": "COLOR",
    "type": "enum",
    "typeParam": "COLORS",
    "units": [
      {
        "language": "EN",
        "value": ""
      },
      {
        "language": "NL",
        "value": ""
      }
    ],
    "value": ""
  },
  "messages": [],
  "total": 1
}

Get attribute by name and class - 200

{
  "data": {
    "class": "product",
    "defaultLanguage": "NL",
    "descriptions": [
      {
        "language": "NL",
        "value": "Framemateriaal"
      },
      {
        "language": "EN",
        "value": "Frame material"
      }
    ],
    "group": "",
    "id": 85,
    "isHidden": false,
    "isPublic": true,
    "isSearchable": false,
    "isSystem": false,
    "name": "MATERIAAL_FRAME",
    "type": "text",
    "typeParam": "",
    "units": [
      {
        "language": "NL",
        "value": ""
      },
      {
        "language": "EN",
        "value": ""
      }
    ],
    "value": []
  },
  "messages": [],
  "total": 1
}

404

Get attribute by Id - 404 / Get attribute by name and class - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with id [800] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Get attribute by Id - 404

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with id [800] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Get attribute by name and class - 404

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with name [MATERIAAL_FRAME] and attributeClass [category] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Loading...