---
title: "Connect Lightspeed Retail POS (X-Series) to Hyrule Compendium - APIANT.ai"
description: "When \"Updated Customer\" fires in Lightspeed Retail POS (X-Series), your agent runs \"Find compendium entries by category\" in Hyrule Compendium."
canonical: "https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-hyrule-compendium"
---

# Connect Lightspeed Retail POS (X-Series) to Hyrule Compendium

When **Updated Customer** fires in [Lightspeed Retail POS (X-Series)](https://apiant.ai/connections/lightspeed-retail-pos-x-series), your agent runs **Find compendium entries by category** in [Hyrule Compendium](https://apiant.ai/connections/hyrule-compendium). Describe the whole flow and it is built, tested on every scenario and kept running.

Lightspeed Retail POS (X-Series) **1** trigger Lightspeed Retail POS (X-Series) **14** actions Hyrule Compendium **7** actions

What the catalog holds today. Ask for anything missing and your agent reads the API documentation and adds it.

## What do you want Lightspeed Retail POS (X-Series) and Hyrule Compendium to do together?

Give your AI client this address.

`https://mcp.apiant.ai`

One connection does both: ask your client to act in an app once, or have it build an automation that keeps running. Any client that takes a remote MCP server. Nothing to install. Create your free account, then sign in once in your browser.

### Set it up in your client

### Claude Code

Run this in the directory you want to work in.

`claude mcp add --transport http -s project apiant-ai https://mcp.apiant.ai`

Start Claude Code there, approve the server, and sign in in the browser page it opens.

[Claude Code guide (opens in a new tab)](https://apiant.ai/docs/mcp/claude-code)

### Claude, web and desktop

Open Customize, then Connectors, then Add custom connector, and paste the address. On Team and Enterprise an owner adds it first.

[Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp)

### Cursor

Add the address to your MCP configuration as a server URL. Cursor signs you in in your browser.

[Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp)

### Zed

Open Settings, then AI, then MCP Servers, then Add Server, then Add Remote Server.

[Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp)

### Codex and the ChatGPT desktop app

Open Settings, then MCP servers, then Add server, and choose Streamable HTTP. From the terminal, Codex takes the address with its own add command and then signs you in.

[Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp)

### Any other MCP client

Paste the address where the client asks for a remote MCP server URL, and name the server apiant-ai where it lets you. APIANT's skills reach the client over the same connection.

[Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp)

Example flows

## What Lightspeed Retail POS (X-Series) can start in Hyrule Compendium

- When **Updated Customer** in Lightspeed Retail POS (X-Series) then **Find compendium entries by category** in Hyrule Compendium
- When **Updated Customer** in Lightspeed Retail POS (X-Series) then **Get compendium entry** in Hyrule Compendium

Starting points drawn from the triggers and actions in the catalog today. Describe the flow you need, at any depth, and your agent builds it and tests every scenario before it ships.

Everything your agent can do with Lightspeed Retail POS (X-Series) and Hyrule Compendium

## Triggers and actions 1 trigger · 21 actions

- Trigger

**Updated Customer**

Triggers when a customer is updated.

- Action

**Add Product to Consignment**

Adds a product line to a consignment in Lightspeed Retail, with its expected count and cost.

- Action

**Add Stock Adjustment**

Adjusts a product's stock level at an outlet, recording the reason such as stock found, damage or theft.

- Action

**Create Consignment**

Creates a consignment in Lightspeed Retail: a supplier order, outlet transfer, supplier return or inventory count.

- Action

**Create Customer**

Creates a new customer.

- Action

**Create Customer Group**

Creates a new customer group.

- Action

**Create Product**

Creates a new product.

- Action

**Get Consignment**

Returns a single consignment from Lightspeed Retail by its id, with its type, status and dates.

- Action

**Get customer**

Returns a single customer by its id.

- Action

**Get product**

Get a product by id.

- Action

**Get sale**

Get a sale by id.

- Action

**List outlets**

List all outlets.

- Action

**List Registers**

Returns the registers in the Lightspeed Retail store, with their outlet and whether each is open.

- Action

**Update Consignment**

Updates a consignment in Lightspeed Retail, such as moving a supplier order from open to sent, dispatched or received.

- Action

**Update customer**

Update an existing customer.

- Action

**Find compendium entries by category**

Retrieve all Hyrule Compendium entries in a given category (creatures, equipment, materials, monsters, treasure).

- Action

**Get compendium entry**

Retrieve a single Hyrule Compendium entry by name or ID.

- Action

**Get master mode entry**

Retrieve a single Master Mode-exclusive compendium entry by name or ID.

- Action

**Get region**

Retrieve data on a single Hyrule region (BOTW map only) by name, including encompassed shrines and settlements.

- Action

**List compendium entries**

List all Hyrule Compendium entries.

- Action

**List master mode entries**

List all Master Mode-exclusive compendium entries.

- Action

**List regions**

List all eight of Hyrule's geographical regions (BOTW map only).

## Each app on its own

- [ **Lightspeed Retail POS (X-Series)** Lightspeed Retail POS (X-Series) is a cloud-based POS and retail management software that lets retailers run...](https://apiant.ai/connections/lightspeed-retail-pos-x-series)
- [ **Hyrule Compendium** Hyrule Compendium is an open-source REST service exposing data on every interactive item in The Legend of...](https://apiant.ai/connections/hyrule-compendium)

Reviews

## What our customers say

## More from Lightspeed Retail POS (X-Series)

- [ **Lightspeed Retail POS (X-Series) to Salesforce** Salesforce is a leading enterprise customer relationship management (CRM) platform.](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-salesforce)
- [ **Lightspeed Retail POS (X-Series) to Slack** Slack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-slack)
- [ **Lightspeed Retail POS (X-Series) to Mailchimp** Mailchimp marketing automation and email platform.](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-mailchimp)
- [ **Lightspeed Retail POS (X-Series) to Stripe** Stripe is a payment processing platform for online businesses.](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-stripe)
- [ **Lightspeed Retail POS (X-Series) to Shopify** Shopify is a commerce platform for online stores and retail point-of-sale.](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-shopify)
- [ **Lightspeed Retail POS (X-Series) to QuickBooks Online** QuickBooks Online accounting — manage customers, invoices, bills, payments, vendors, expenses, and more via...](https://apiant.ai/connect/lightspeed-retail-pos-x-series-to-quickbooks-online)

## More into Hyrule Compendium

- [ **HubSpot to Hyrule Compendium** HubSpot is your all-in-one stop for all of your marketing software needs.](https://apiant.ai/connect/hubspot-to-hyrule-compendium)
- [ **Salesforce to Hyrule Compendium** Salesforce is a leading enterprise customer relationship management (CRM) platform.](https://apiant.ai/connect/salesforce-to-hyrule-compendium)
- [ **Slack to Hyrule Compendium** Slack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...](https://apiant.ai/connect/slack-to-hyrule-compendium)
- [ **Google Sheets to Hyrule Compendium** Google Sheets](https://apiant.ai/connect/google-sheets-to-hyrule-compendium)
- [ **Gmail to Hyrule Compendium** Gmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...](https://apiant.ai/connect/gmail-to-hyrule-compendium)
- [ **Google Calendar to Hyrule Compendium** Google Calendar is a time management tool providing scheduling features, event reminders, and integration...](https://apiant.ai/connect/google-calendar-to-hyrule-compendium)

Questions

## Lightspeed Retail POS (X-Series) and Hyrule Compendium, answered

###

### What can start an automation from Lightspeed Retail POS (X-Series)?

Any of Lightspeed Retail POS (X-Series)'s 1 trigger in the catalog, including Updated Customer. Describe the moment in plain language and your agent picks the right one.

###

### What can your agent do in Hyrule Compendium when something happens in Lightspeed Retail POS (X-Series)?

Any of Hyrule Compendium's 7 actions, including Find compendium entries by category, Get compendium entry, Get master mode entry and Get region. Your agent maps the data both ways and tests every scenario before it ships.

###

### Can it also run from Hyrule Compendium to Lightspeed Retail POS (X-Series)?

Hyrule Compendium has no triggers in the catalog today, so automations start in Lightspeed Retail POS (X-Series). If you need the other direction, ask: your agent reads Hyrule Compendium's API documentation and adds it.

###

### Do I have to build a connector for Lightspeed Retail POS (X-Series) or Hyrule Compendium?

No. Both are in the catalog with their triggers and actions. You describe the automation; your agent builds it, tests every scenario and keeps it running.

###

### Can my AI client use Lightspeed Retail POS (X-Series) and Hyrule Compendium without building an automation?

Yes. With your AI client connected to APIANT, ask it to do something in either app once and it runs that action on the spot. Ask for an automation and your agent builds it, tests every scenario and keeps it running. One connection covers both.

###

### What happens when something fails?

Your agent works that out for you. It plans the failure paths along with the happy path, then tests every scenario before it ships.

###

### Is there a free plan?

Yes. Every plan includes the agent, including free, and building from your own AI client spends no assistant credits.
