Get Cluster by lookup key

GET 
/clusters/:lookupKey/:lookupValue

Use this endpoint to retrieve cluster details by 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 options to retrieve the cluster options. Use products to retrive cluster products etc.

Responses

200

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

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

clusterConfig

object

id number

name string

settings undefined[]

code string

defaultobject_id string

descriptions

object[]

Array [

language string

value string

]

id number

names

object[]

Array [

language string

value string

]

options

object[]

Array [

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

]

]

parent

object

descriptions

object[]

Array [

language string

value string

]

id number

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

sources

object[]

Array [

language string

source string

sourceId string

]

products

object[]

Array [

descriptions

object[]

Array [

language string

value string

]

eanCode string

id number

manufacturer string

minimumQuantity number

names

object[]

Array [

language string

value string

]

notes

object[]

Array [

language string

value string

]

oemCode string

package string

packageDescriptions

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

shortName string

sku string

sources

object[]

Array [

language string

source string

sourceId string

]

status string

supplier string

supplierCode string

taxCode string

taxPercentage number

unit number

]

shortDescriptions

object[]

Array [

language string

value string

]

sources

object[]

Array [

language string

source string

sourceId string

]

messages undefined[]
total number

Example (from schema)

{
  "data": {
    "clusterConfig": {
      "id": 11,
      "name": "OPTIONS_CLUSTER",
      "settings": []
    },
    "code": "15120300",
    "defaultobject_id": "",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "id": 210,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      }
    ],
    "options": [
      {
        "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"
          },
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "K72334000"
          }
        ]
      },
      {
        "defaultProduct": "",
        "descriptions": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "id": 216,
        "isRequired": false,
        "names": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "sources": [
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "KM636000"
          }
        ]
      }
    ],
    "parent": {
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 23409,
      "names": [
        {
          "language": "NL",
          "value": "Clusters"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "sources": [
        {
          "language": "NL",
          "source": "REST-API",
          "sourceId": "CLUSTERS"
        }
      ]
    },
    "products": [
      {
        "descriptions": [
          {
            "language": "NL",
            "value": "39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"
          }
        ],
        "eanCode": "4004675044075",
        "id": 707971,
        "manufacturer": "DELL",
        "minimumQuantity": 1,
        "names": [
          {
            "language": "NL",
            "value": "DELL Precision 5530 Laptop - Z"
          }
        ],
        "notes": [
          {
            "language": "NL",
            "value": "base cluster product"
          }
        ],
        "oemCode": "FYR88",
        "package": "STK",
        "packageDescriptions": [
          {
            "language": "NL",
            "value": "Stuks"
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": "DELL Precision 5530 Laptop - Z"
          }
        ],
        "shortName": "DELL Precision 5530 Laptop",
        "sku": "FYR88",
        "sources": [
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "FYR88"
          }
        ],
        "status": "A",
        "supplier": "REST-API",
        "supplierCode": "FYR88",
        "taxCode": "H",
        "taxPercentage": 0.21,
        "unit": 1
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": ""
      }
    ],
    "sources": [
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "CO.FYR88"
      },
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "COFYR88"
      }
    ]
  },
  "messages": [],
  "total": 1
}

Get Cluster by lookup key - 200

{
  "data": {
    "clusterConfig": {
      "id": 11
    },
    "code": "15120300",
    "defaultobject_id": "",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "id": 210,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": ""
      }
    ]
  },
  "messages": [],
  "total": 1
}

Get Cluster by lookup key - 200 (expands)

{
  "data": {
    "clusterConfig": {
      "id": 12,
      "name": "OPTIONS_CLUSTER",
      "settings": []
    },
    "code": "CO.FYR88",
    "defaultobject_id": "",
    "descriptions": [
      {
        "language": "NL",
        "value": "39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"
      }
    ],
    "id": 213,
    "names": [
      {
        "language": "NL",
        "value": "DELL Precision 5530 Laptop - Z"
      }
    ],
    "options": [
      {
        "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"
          },
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "K72334000"
          }
        ]
      },
      {
        "defaultProduct": "",
        "descriptions": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "id": 216,
        "isRequired": false,
        "names": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": "Toetsenbord"
          }
        ],
        "sources": [
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "KM636000"
          }
        ]
      }
    ],
    "parent": {
      "descriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "id": 23409,
      "names": [
        {
          "language": "NL",
          "value": "Clusters"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": ""
        }
      ],
      "sources": [
        {
          "language": "NL",
          "source": "REST-API",
          "sourceId": "CLUSTERS"
        }
      ]
    },
    "products": [
      {
        "descriptions": [
          {
            "language": "NL",
            "value": "39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"
          }
        ],
        "eanCode": "4004675044075",
        "id": 707971,
        "manufacturer": "DELL",
        "minimumQuantity": 1,
        "names": [
          {
            "language": "NL",
            "value": "DELL Precision 5530 Laptop - Z"
          }
        ],
        "notes": [
          {
            "language": "NL",
            "value": "base cluster product"
          }
        ],
        "oemCode": "FYR88",
        "package": "STK",
        "packageDescriptions": [
          {
            "language": "NL",
            "value": "Stuks"
          }
        ],
        "shortDescriptions": [
          {
            "language": "NL",
            "value": "DELL Precision 5530 Laptop - Z"
          }
        ],
        "shortName": "DELL Precision 5530 Laptop",
        "sku": "FYR88",
        "sources": [
          {
            "language": "NL",
            "source": "REST-API",
            "sourceId": "FYR88"
          }
        ],
        "status": "A",
        "supplier": "REST-API",
        "supplierCode": "FYR88",
        "taxCode": "H",
        "taxPercentage": 0.21,
        "unit": 1
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": ""
      }
    ],
    "sources": [
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "CO.FYR88"
      },
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "COFYR88"
      }
    ]
  },
  "messages": [],
  "total": 1
}

404

Get Cluster by lookup key - 404

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

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

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

Get Cluster by lookup key - 404

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

Loading...