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

200

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

application/json

Schema

Schema

data

object

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": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
      }
    ],
    "eanCode": "0753759256289",
    "id": 40360,
    "manufacturer": "Garmin",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "oemCode": "NCABD70004",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      },
      {
        "language": "EN",
        "value": "Pieces"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
      }
    ],
    "shortName": "Edge 1030 FietsComputer",
    "sku": "NCABD70004",
    "status": "A",
    "supplier": "TECHDATA",
    "supplierCode": "NCABD70004",
    "taxCode": "H",
    "taxPercentage": 0.21,
    "unit": 1
  },
  "messages": [],
  "total": 1
}

Get Product by Id - 200

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
      }
    ],
    "eanCode": "0753759256289",
    "id": 40360,
    "manufacturer": "Garmin",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "oemCode": "NCABD70004",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      },
      {
        "language": "EN",
        "value": "Pieces"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
      }
    ],
    "shortName": "Edge 1030 FietsComputer",
    "sku": "NCABD70004",
    "status": "A",
    "supplier": "TECHDATA",
    "supplierCode": "NCABD70004",
    "taxCode": "H",
    "taxPercentage": 0.21,
    "unit": 1
  },
  "messages": [],
  "total": 1
}

404

Get Product by sourceId - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  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": 80006,
    "messages": [
      "Product with sourceId [40360] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Get Product by sourceId - 404

{
  "error": {
    "code": 80006,
    "messages": [
      "Product with sourceId [40360] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Loading...