Get Products by Cluster lookup key

GET 
/clusters/:lookupKey/:lookupValue/products

Use this endpoint to retrieve cluster products 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 products translations. Use surcharges to retrive cluster products surcharges etc.

Responses

200

Get Products by Cluster lookup key - 200 / Get Products by Cluster 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[]

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

status string

supplier string

supplierCode string

taxCode string

taxPercentage number

unit number

]

messages undefined[]
total number

Example (from schema)

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "eanCode": "4004675044075",
    "id": 707966,
    "manufacturer": "Schneider",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra blauw"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "<p>blawn</p>\r\n"
      }
    ],
    "oemCode": "151203",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "shortName": "Balpen Slider XB extra blauw",
    "sku": "151203",
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "151203",
    "taxCode": "H",
    "taxPercentage": 21,
    "unit": 1
  },
  "messages": [],
  "total": 2
}

Get Products by Cluster lookup key - 200

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "eanCode": "4004675044075",
    "id": 707966,
    "manufacturer": "Schneider",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra blauw"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "<p>blawn</p>\r\n"
      }
    ],
    "oemCode": "151203",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "shortName": "Balpen Slider XB extra blauw",
    "sku": "151203",
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "151203",
    "taxCode": "H",
    "taxPercentage": 21,
    "unit": 1
  },
  "messages": [],
  "total": 2
}

Get Products by Cluster lookup key - 200 (expands)

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "eanCode": "4004675044075",
    "id": 707966,
    "manufacturer": "Schneider",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra blauw"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "<p>blawn</p>\r\n"
      }
    ],
    "oemCode": "151203",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"
      }
    ],
    "shortName": "Balpen Slider XB extra blauw",
    "sku": "151203",
    "sources": [
      {
        "language": "NL",
        "source": "REST-API",
        "sourceId": "151203"
      }
    ],
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "151203",
    "surcharges": [],
    "taxCode": "H",
    "taxPercentage": 21,
    "unit": 1
  },
  "messages": [],
  "total": 2
}

404

Get Products 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 Products 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...