Look up a product from its storefront URL

POST/api/v1/catalog/lookup

Request body

requiredapplication/json

productUrlstring<uri>required

min length 1 · max length 8192

selectedobject[]

Show properties

Array of object

labelstringrequired

min length 1

namestringrequired

min length 1

Responses

200Catalog product resolved from its storefront URL

merchantobjectrequired

Show properties

namestringrequired

min length 1

slugstringrequired

min length 1

messagesobject[]required

productobject | nullrequired

selectionRequiredbooleanrequired

variantobject | nullrequired

Request

curl -X POST "https://dev.api.orderboost.org/api/v1/catalog/lookup" \
  -H "Content-Type: application/json" \
  -d '{
  "productUrl": "<uri>",
  "selected": [
    {
      "label": "string",
      "name": "string"
    }
  ]
}'

const response = await fetch("https://dev.api.orderboost.org/api/v1/catalog/lookup", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "productUrl": "<uri>",
  "selected": [
    {
      "label": "string",
      "name": "string"
    }
  ]
})
});

import requests

response = requests.post(
    "https://dev.api.orderboost.org/api/v1/catalog/lookup",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "productUrl": "<uri>",
  "selected": [
    {
      "label": "string",
      "name": "string"
    }
  ]
},
)

Response

{
  "merchant": {
    "name": "string",
    "slug": "string"
  },
  "messages": [
    {}
  ],
  "product": {},
  "selectionRequired": true,
  "variant": {}
}