Get Options by Cluster lookup key

GET 
/clusters/:lookupKey/:lookupValue/options

Use this endpoint to retrieve cluster options by cluster lookup key.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Query Parameters

expands string

Optional. Use translation to retrieve the cluster options translations. Use defaultProduct to retrive cluster options default products etc.

Responses

200

Get Options by Cluster lookup key / Get Options by Cluster lookup key - 200 (expands)

Response Headers

• Alt-Svc

  string

• Content-Length

  string

• Via

  string

• alt-svc

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

defaultProduct

object

id number

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

]

]

messages undefined[]
total number

Example (from schema)

{
  "data": [
    {
      "defaultProduct": {
        "id": 450102
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 90,
      "isRequired": true,
      "names": [
        {
          "language": "NL",
          "value": "First option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ]
    },
    {
      "defaultProduct": {
        "id": 661190
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 104,
      "isRequired": false,
      "names": [
        {
          "language": "NL",
          "value": "Second option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ]
    }
  ],
  "messages": [],
  "total": 2
}

Get Options by Cluster lookup key

{
  "data": [
    {
      "defaultProduct": {
        "id": 450102
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 90,
      "isRequired": true,
      "names": [
        {
          "language": "NL",
          "value": "First option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ]
    },
    {
      "defaultProduct": {
        "id": 661190
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 104,
      "isRequired": false,
      "names": [
        {
          "language": "NL",
          "value": "Second option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ]
    }
  ],
  "messages": [],
  "total": 2
}

Get Options by Cluster lookup key - 200 (expands)

{
  "data": [
    {
      "defaultProduct": {
        "descriptions": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "eanCode": "",
        "id": 450102,
        "manufacturer": "",
        "minimumQuantity": 1,
        "names": [
          {
            "language": "NL",
            "value": "My first option"
          }
        ],
        "notes": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "oemCode": "",
        "package": "",
        "packageDescriptions": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": "<p>test change</p>\r\n"
          }
        ],
        "shortName": "",
        "sku": "conf-first-option-1",
        "sources": [],
        "status": "A",
        "supplier": "",
        "supplierCode": "",
        "taxCode": "H",
        "taxPercentage": 21,
        "unit": 1
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 90,
      "isRequired": true,
      "names": [
        {
          "language": "NL",
          "value": "First option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "sources": []
    },
    {
      "defaultProduct": {
        "descriptions": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "eanCode": "",
        "id": 661190,
        "manufacturer": "",
        "minimumQuantity": 1,
        "names": [
          {
            "language": "NL",
            "value": "My second option"
          }
        ],
        "notes": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "oemCode": "",
        "package": "",
        "packageDescriptions": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": ""
          }
        ],
        "shortName": "",
        "sku": "conf-second-option-2",
        "sources": [],
        "status": "A",
        "supplier": "",
        "supplierCode": "",
        "taxCode": "H",
        "taxPercentage": 21,
        "unit": 1
      },
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 104,
      "isRequired": false,
      "names": [
        {
          "language": "NL",
          "value": "Second option"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "sources": []
    }
  ],
  "messages": [],
  "total": 2
}

404

Get Options by Cluster lookup key - 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": 20007,
    "messages": [
      "Parent Cluster with id [211] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Get Options by Cluster lookup key - 404

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with id [211] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Loading...