Skip to main content

Get Product by lookup key

GET 

/products/:lookupKey/:lookupValue

Use this endpoint to retrieve product details by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. source and language for lookup key source).

Request

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about product lookup keys

    lookupValue stringrequired

    The value of the key (id, sourceId, sku or supplierCode)

Query Parameters

    source string

    Optional. Used in combination with lookup key sourceId

    language string

    Optional. Default language of the product

    expands string

    Optional. Use translation when retrieving translated fields in all lanugages. By default, only the default language of the product will be provided. What is resource expanding?

    supplier string

    Optional. Used in combination with lookup key supplierCode

Responses

Get Product by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object

    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
    status string
    suggestedPrice number
    supplier string
    supplierCode string
    taxCode string
    taxPercentage number
    unit number
    messages undefined[]
    total number
Loading...