Product data¶

Fetch a product's full indexed details and inspect how it has changed over time.

Tips & tricks

Pass a product number from a feed run to getProductData to see what Hello Retail indexed for it.

Show the indexed product data for product number <NUMBER> on my website.

getProductChanges shows why a product's price or availability changed. Check it before investigating the feed.

Show the recent changes for product number <NUMBER> on my website.

getProductData¶

Retrieve full product data for a product on a Hello Retail website, looked up by URL or product number. Provide exactly one of url or productNumber. Returns identity, pricing, inventory, categorisation, scoring, and feature-flag fields that match the Products > Data lookup page in the Hello Retail admin UI. Deleted products return only url, id, and status.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
`url`	string	No	The full URL of the product to look up. Provide exactly one of `url` or `productNumber`.
`productNumber`	string	No	The product number of the product to look up. Provide exactly one of `url` or `productNumber`. When multiple products share a product number, the ACTIVE product is preferred.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "getProductData",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

Returns

{
  "url": "<string>",
  "id": "<string>",
  "status": "<string>",
  "websiteUuid": "<string>",
  "inStock": false,
  "created": "<string>",
  "lastSeen": "<string>",
  "price": 0.0,
  "priceExVat": 0.0,
  "oldPrice": 0.0,
  "oldPriceExVat": 0.0,
  "currency": "<string>",
  "priceLowered": false,
  "title": "<string>",
  "description": "<string>",
  "brand": "<string>",
  "keywords": "<string>",
  "hierarchies": [],
  "imgUrl": "<string>",
  "ean": "<string>",
  "productNumber": "<string>",
  "variantProductNumbers": [],
  "groupingKey": "<string>",
  "disabledInFeature": [],
  "productScore": {},
  "normalizedScore": 0.0,
  "extraData": {},
  "extraDataNumber": {},
  "extraDataList": {},
  "pi": {}
}

getProductChanges¶

Retrieve the change history for a product on a Hello Retail website, looked up by URL or product number. Provide exactly one of url or productNumber. Returns changes grouped by field name, each entry listing prior values with date and source. Changes are in reverse-chronological order (newest first). The current value lives on the product itself — use getProductData to see it.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
`url`	string	No	The full URL of the product to look up. Provide exactly one of `url` or `productNumber`.
`productNumber`	string	No	The product number of the product to look up. Provide exactly one of `url` or `productNumber`. When multiple products share a product number, the ACTIVE product is preferred.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "getProductChanges",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

Returns

{
  "<fieldName>": [
    {
      "date": "<string>",
      "source": "<string>",
      "oldValue": "<string>"
    }
  ]
}