Get resource attribute by resource lookup key and attribute lookup key

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

Retrieves a specific attribute for a resource identified by resource lookup key and attribute lookup key. The attributeClass Query Param is useful to use when the attribute lookup key is name and the same attribute name is used for an attribute with a different class.

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.)

attributeLookupKey stringrequired

Lookup key. Use id or name

attributeLookupValue stringrequired

The id or name of the attribute

Query Parameters

attributeClass string

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

source string

Optional. Used in combination with lookup key sourceId

Responses

200

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

id number

inherited boolean

name string

type string

value

object

anyOf

MOD1

Array [

inherited boolean

language string

value string

]

MOD2

string

messages string[]
total number

Example (from schema)

{
  "data": {
    "class": "product",
    "id": 671,
    "inherited": false,
    "name": "MATERIAAL_FRAME",
    "type": "text",
    "value": [
      {
        "inherited": false,
        "language": "EN",
        "value": "Leather"
      },
      {
        "inherited": false,
        "language": "NL",
        "value": "Leer"
      }
    ]
  },
  "messages": [
    "Completed"
  ],
  "total": 1
}

Get product attribute by product id and attribute id - 200

{
  "data": {
    "class": "product",
    "id": 671,
    "name": "MATERIAAL_FRAME",
    "type": "text",
    "value": [
      {
        "inherited": false,
        "language": "EN",
        "value": "Leather"
      },
      {
        "inherited": false,
        "language": "NL",
        "value": "Leer"
      }
    ]
  },
  "messages": [
    "Completed"
  ],
  "total": 1
}

Get product attribute by product id and attribute name/ class - 200

{
  "data": {
    "class": "product",
    "id": 671,
    "name": "MATERIAAL_FRAME",
    "type": "text",
    "value": [
      {
        "inherited": false,
        "language": "EN",
        "value": "Leather"
      },
      {
        "inherited": false,
        "language": "NL",
        "value": "Leer"
      }
    ]
  },
  "messages": [
    "Completed"
  ],
  "total": 1
}

Get user attribute by user id and attribute name/ class - 200

{
  "data": {
    "class": "user",
    "id": 48,
    "inherited": false,
    "name": "SHOW_REKENING",
    "type": "enum",
    "value": "Y"
  },
  "messages": [
    "Completed"
  ],
  "total": 1
}

404

Get product attribute by product id and attribute name/ 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 name [FRAME] and attributeClass [product] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Get product attribute by product id and attribute name/ class - 404

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

Loading...