Recommendations¶

Review recommendation boxes and their designs.

Tips & tricks

List the boxes first, then fetch a design by key to see its templates and styles.

List the recommendation boxes for my website, then show the design for one of them.

Use getRecommendationDesign and updateRecommendationDesign to read and edit a design's HTML and CSS directly.

Show the HTML and CSS for recommendation design <KEY> on my website.

getRecommendationDesign¶

Retrieve the design (template and styles) for a customer website using Hello Retail. Use this before updateRecommendationDesign to read the current state of the design.

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.
`key`	string	Yes	The key of the design. Use `listRecommendationDesigns` to find available keys.

Example request

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

Returns

{
  "key": "<string>",
  "title": "<string>",
  "templateCode": "<string>",
  "templateStyles": "<string>"
}

updateRecommendationDesign¶

Update the design (template and styles) of a recommendation box for a customer website using Hello Retail. Edits the design with the given key. templateCode and templateStyles are optional and updates are partial: omitted fields are left unchanged, but at least one of them must be provided. Saving a design automatically creates a draft of any LIVE boxes using it, leaving them in DRAFT state for review. Use getRecommendationDesign first to read the current state before making changes. Publishing is not possible through this tool.

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.
`key`	string	Yes	The key of the design to update. Use `listRecommendationDesigns` to find available keys.
`templateCode`	string	No	HTML/Liquid template for rendering the recommendation box.
`templateStyles`	string	No	CSS styles applied to the recommendation box.

Example request

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

Returns

{
  "key": "<string>",
  "designId": 0,
  "title": "<string>",
  "lastModified": "<string>"
}

listRecommendationDesigns¶

List all designs available to a website: the company's custom designs (including archived ones) and the shared standard designs. Returns key, title, archived/standard flags and last-modified for each design. Use the key with getRecommendationDesign or updateRecommendationDesign. Archived and standard designs are read-only.

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.

Example request

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

Returns

{
  "designs": [
    {
      "key": "<string>",
      "title": "<string>",
      "archived": false,
      "standard": false,
      "lastModified": "<string>"
    }
  ]
}

listRecommendationBoxes¶

List recommendation boxes for a customer website using Hello Retail. Returns LIVE and DRAFT boxes by default; pass includeArchived=true to also include archived boxes. Each box's designKey identifies the design it renders with; use it with getRecommendationDesign or updateRecommendationDesign to inspect or edit that design.

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.
`includeArchived`	boolean	No	Whether to include archived boxes. Defaults to false.

Example request

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

Returns

{
  "boxes": [
    {
      "key": "<string>",
      "name": "<string>",
      "type": "<string>",
      "state": "<string>",
      "draft": false,
      "designKey": "<string>",
      "lastModified": "<string>"
    }
  ]
}