Loyverse

Learn how to use Loyverse with Composio

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

bearer_token
stringRequired

Tools

SLUG: LOYVERSE_CREATE_SUPPLIER

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
email
string
name
stringRequired
note
string
phone_number
string
postal_code
string
region
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: LOYVERSE_DELETE_CATEGORY

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: LOYVERSE_DELETE_SUPPLIER

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

SLUG: LOYVERSE_GET_CATEGORY

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: LOYVERSE_GET_DISCOUNT

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

SLUG: LOYVERSE_GET_EMPLOYEE

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: LOYVERSE_GET_JWKS

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

SLUG: LOYVERSE_GET_MERCHANT_INFO

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: LOYVERSE_GET_OPEN_ID_CONFIGURATION

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

SLUG: LOYVERSE_GET_PAYMENT_TYPE

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

SLUG: LOYVERSE_GET_STORE

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

SLUG: LOYVERSE_LIST_CATEGORIES

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

SLUG: LOYVERSE_LIST_CUSTOMERS

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

SLUG: LOYVERSE_LIST_DISCOUNTS

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

SLUG: LOYVERSE_LIST_EMPLOYEES

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

SLUG: LOYVERSE_LIST_ITEMS

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

SLUG: LOYVERSE_LIST_MODIFIERS

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

SLUG: LOYVERSE_LIST_PAYMENT_TYPES

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

SLUG: LOYVERSE_LIST_RECEIPTS

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

SLUG: LOYVERSE_LIST_SHIFTS

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

SLUG: LOYVERSE_LIST_SUPPLIERS

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

SLUG: LOYVERSE_LIST_TAXES

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

SLUG: LOYVERSE_LIST_VARIANTS

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

SLUG: LOYVERSE_LIST_WEBHOOKS

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