Skip to main content

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

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

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 [

  • costPrice number

    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
  • ]

  • price number

    shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • shortName string
    sku string

    sources

    object[]

  • Array [

  • language string
    source string
    sourceId string
  • ]

  • status string
    suggestedPrice number
    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
Loading...