Skip to content

Website

Find the websites tied to a company and read a single website's core configuration.

Tips & tricks

Pick the card that matches what you're doing. Each prompt is ready to paste into your assistant.

The UUID

Start every other tool here

website_listForCompany returns the website UUID that almost every other tool needs as input.

List all websites for my company with their UUIDs.
Context

Tracking domain and currency

website_getInfo reports a site's tracking domain and currency, which set the context for its analytics.

Show the tracking domain and currency for my website.

website_getInfo

Get configuration (company ID, language and currency) for a Hello Retail website, by its UUID.

Name Type Required Description
websiteUuid string Yes The website's UUID. Find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "website_getInfo",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

{
  "uuid": "<string>",
  "companyId": 0,
  "domain": "<string>",
  "language": "<string>",
  "currency": "<string>"
}

website_listForCompany

List all websites for a Hello Retail company, by its company ID.

Name Type Required Description
companyId integer Yes The company ID.

Finding your company ID

In My Hello Retail, click the profile icon in the top-right corner and choose Company Profile. Your company ID is shown in the Company Id field.

Finding the company ID under Company Profile

Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "website_listForCompany",
    "arguments": {
      "companyId": 0
    }
  }
}

{
  "websites": [
    {
      "uuid": "<string>",
      "domain": "<string>",
      "language": "<string>",
      "currency": "<string>"
    }
  ]
}