Get Option by Cluster lookup key and Option Id

GET 
/clusters/:lookupKey/:lookupValue/options/:optionId

Use this endpoint to get details of single cluster option by cluster lookup key and option id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

optionId stringrequired

The value of option id

Query Parameters

expands string

application/json

Body

any

Responses

200

Get Option by Cluster lookup key and Option Id - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

defaultProduct string

descriptions

object[]

Array [

language string

value string

]

id number

isRequired boolean

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

sources

object[]

Array [

language string

source string

sourceId string

]

messages undefined[]
total number

Example (from schema)

{
  "data": {
    "defaultProduct": "",
    "descriptions": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "id": 214,
    "isRequired": false,
    "names": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "sources": [
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "K72334"
      }
    ]
  },
  "messages": [],
  "total": 1
}

Get Option by Cluster lookup key and Option Id - 200

{
  "data": {
    "defaultProduct": "",
    "descriptions": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "id": 214,
    "isRequired": false,
    "names": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Muis"
      }
    ],
    "sources": [
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "K72334"
      }
    ]
  },
  "messages": [],
  "total": 1
}

404

Get Option by Cluster lookup key and Option Id - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  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": 20010,
    "messages": [
      "Cluster Option with id [215] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Get Option by Cluster lookup key and Option Id - 404

{
  "error": {
    "code": 20010,
    "messages": [
      "Cluster Option with id [215] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Loading...