Loyverse | Composio Docs

Overview

SLUG: LOYVERSE

Description

Loyverse is a point-of-sale (POS) system designed for small businesses, offering features like sales management, inventory tracking, and customer engagement tools.

Authentication Details

API Key

bearer_token

stringRequired

Connecting to Loyverse

Create an auth config

Use the dashboard to create an auth config for the Loyverse toolkit. This allows you to connect multiple Loyverse accounts to Composio for agents to use.

Select App

Navigate to Loyverse.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Loyverse Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 loyverse_auth_config_id = "ac_YOUR_LOYVERSE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Loyverse for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, loyverse_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Loyverse toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["LOYVERSE"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

LOYVERSE_CREATE_SUPPLIER

Tool Name: Create Supplier

Description

Tool to create a new supplier. use when you need to register a supplier in loyverse before purchases.

Action Parameters

address_1

string

address_2

string

city

string

contact

string

country_code

string

name

stringRequired

note

string

phone_number

string

postal_code

string

region

string

website

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_DELETE_CATEGORY

Tool Name: Delete Category

Description

Tool to delete a single category by id. use when you need to remove an unused or deprecated category.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_DELETE_SUPPLIER

Tool Name: Delete Supplier

Description

Tool to delete a specific supplier by id. use after confirming the supplier id to remove an existing supplier.

Action Parameters

supplier_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_CATEGORY

Tool Name: Get Category

Description

Tool to get a single category by id. use when you need to fetch details of an existing category in loyverse.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_DISCOUNT

Tool Name: Get Discount

Description

Tool to get a single discount by id. use after confirming the discount id to retrieve its details.

Action Parameters

discount_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_EMPLOYEE

Tool Name: Get Employee

Description

Tool to get a single employee by id. use after confirming the employee id to fetch its details.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_JWKS

Tool Name: Get JWKS

Description

Tool to fetch json web key set for openid connect. use when verifying loyverse id token signatures.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_MERCHANT_INFO

Tool Name: Get Merchant Info

Description

Tool to get merchant information. use after authenticating to retrieve merchant account details.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_OPEN_ID_CONFIGURATION

Tool Name: Get OpenID Connect Discovery Document

Description

Tool to retrieve the openid connect discovery document. use when integrating authentication and need endpoints and supported features.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_PAYMENT_TYPE

Tool Name: Get Payment Type

Description

Tool to get a single payment type by its id. use when you need to fetch full details of a specific payment method before processing a transaction.

Action Parameters

payment_type_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_GET_STORE

Tool Name: Get Store

Description

Tool to retrieve details of a specific store by its id. use when you need store metadata (address, contact) after obtaining the store id.

Action Parameters

store_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_CATEGORIES

Tool Name: List Categories

Description

Tool to list categories with optional filtering and pagination.

Action Parameters

categories_ids

string

cursor

string

limit

integer

show_deleted

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_CUSTOMERS

Tool Name: List Customers

Description

Tool to get a list of customers. use when you need paginated customer lists with optional filters.

Action Parameters

customer_id

string

limit

integer

offset

integer

phone_number

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_DISCOUNTS

Tool Name: List Discounts

Description

Tool to list discounts. use when fetching a paginated set of discounts for display or sync.

Action Parameters

limit

integer

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_EMPLOYEES

Tool Name: List Employees

Description

Tool to get a list of employees. use when you need paginated employee lists with optional filters. works after authenticating.

Action Parameters

cursor

string

employee_ids

string

limit

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_ITEMS

Tool Name: List Items

Description

Tool to list items with filtering and pagination. use when you need to retrieve inventory items with optional filters and handle pagination for large result sets.

Action Parameters

after

string

category_id

string

limit

integer

location_id

string

modifier_id

string

updated_at_max

string

updated_at_min

string

vendor_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_MODIFIERS

Tool Name: List Modifiers

Description

Tool to list modifiers. use when you need a paginated list of modifiers with optional filters.

Action Parameters

cursor

string

ids

string

limit

integer

updated_at_max

string

updated_at_min

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_PAYMENT_TYPES

Tool Name: List Payment Types

Description

Tool to list payment types. use when you need to fetch available payment methods with optional filters and pagination.

Action Parameters

created_at_max

string

created_at_min

string

cursor

string

limit

integer

payment_type_ids

string

show_deleted

boolean

updated_at_max

string

updated_at_min

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_RECEIPTS

Tool Name: List Receipts

Description

Tool to retrieve a list of receipts. use when you need to fetch receipts with optional filters and handle pagination.

Action Parameters

before_receipt_number

string

created_at_max

string

created_at_min

string

cursor

string

limit

integer

order

string

receipt_numbers

string

since_receipt_number

string

source

string

store_id

string

updated_at_max

string

updated_at_min

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_SHIFTS

Tool Name: List Shifts

Description

Tool to list shifts. use when you need to retrieve shift records for reporting or auditing with optional filters.

Action Parameters

created_at_max

string

created_at_min

string

cursor

string

limit

integer

store_ids

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_SUPPLIERS

Tool Name: List Suppliers

Description

Tool to retrieve a list of suppliers. use when you need a paginated supplier directory with optional filters.

Action Parameters

cursor

string

limit

integerDefaults to 50

show_deleted

boolean

suppliers_ids

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_TAXES

Tool Name: List Taxes

Description

Tool to list taxes. use when you need to fetch tax configurations with pagination for reporting or synchronization purposes. example: "list taxes with limit 100 and offset 0".

Action Parameters

limit

integerDefaults to 50

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_VARIANTS

Tool Name: List Variants

Description

Tool to list variants. use when you need to retrieve item variants with optional filtering by item and pagination.

Action Parameters

cursor

string

item_id

string

limit

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

LOYVERSE_LIST_WEBHOOKS

Tool Name: List Webhooks

Description

Tool to list webhooks. use when you need to retrieve all configured webhooks.

Action Parameters

limit

integer

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired