Loyverse
loyverseLoyverse is a point-of-sale (POS) system designed for small businesses, offering features like sales management, inventory tracking, and customer engagement tools.
Acciones disponibles (24)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create SupplierLOYVERSE_CREATE_SUPPLIERAcciónTool to create a new supplier. use when you need to register a supplier in loyverse before purchases.
LOYVERSE_CREATE_SUPPLIERAcciónTool to create a new supplier. use when you need to register a supplier in loyverse before purchases.
Parámetros de entrada
citystringSupplier city
namestringObligatorioName of the supplier
notestringAdditional notes about the supplier
emailstringSupplier email address
regionstringSupplier region (state or province)
contactstringContact person at the supplier
websitestringSupplier website URL
address_1stringSupplier address line 1
address_2stringSupplier address line 2
postal_codestringSupplier postal code
country_codestringSupplier country code (ISO 3166-1 alpha-2)
phone_numberstringSupplier phone number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CategoryLOYVERSE_DELETE_CATEGORYAcciónTool to delete a single category by id. use when you need to remove an unused or deprecated category.
LOYVERSE_DELETE_CATEGORYAcciónTool to delete a single category by id. use when you need to remove an unused or deprecated category.
Parámetros de entrada
idstringObligatorioThe unique ID of the category to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SupplierLOYVERSE_DELETE_SUPPLIERAcciónTool to delete a specific supplier by id. use after confirming the supplier id to remove an existing supplier.
LOYVERSE_DELETE_SUPPLIERAcciónTool to delete a specific supplier by id. use after confirming the supplier id to remove an existing supplier.
Parámetros de entrada
supplier_idstringObligatorioThe unique ID of the supplier to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CategoryLOYVERSE_GET_CATEGORYAcciónTool to get a single category by id. use when you need to fetch details of an existing category in loyverse.
LOYVERSE_GET_CATEGORYAcciónTool to get a single category by id. use when you need to fetch details of an existing category in loyverse.
Parámetros de entrada
idstringObligatorioThe unique ID of the category to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DiscountLOYVERSE_GET_DISCOUNTAcciónTool to get a single discount by id. use after confirming the discount id to retrieve its details.
LOYVERSE_GET_DISCOUNTAcciónTool to get a single discount by id. use after confirming the discount id to retrieve its details.
Parámetros de entrada
discount_idstringObligatorioUUID of the discount to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get EmployeeLOYVERSE_GET_EMPLOYEEAcciónTool to get a single employee by id. use after confirming the employee id to fetch its details.
LOYVERSE_GET_EMPLOYEEAcciónTool to get a single employee by id. use after confirming the employee id to fetch its details.
Parámetros de entrada
idstringObligatorioThe unique UUID of the employee to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get JWKSLOYVERSE_GET_JWKSAcciónTool to fetch json web key set for openid connect. use when verifying loyverse id token signatures.
LOYVERSE_GET_JWKSAcciónTool to fetch json web key set for openid connect. use when verifying loyverse id token signatures.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Merchant InfoLOYVERSE_GET_MERCHANT_INFOAcciónTool to get merchant information. use after authenticating to retrieve merchant account details.
LOYVERSE_GET_MERCHANT_INFOAcciónTool to get merchant information. use after authenticating to retrieve merchant account details.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OpenID Connect Discovery DocumentLOYVERSE_GET_OPEN_ID_CONFIGURATIONAcciónTool to retrieve the openid connect discovery document. use when integrating authentication and need endpoints and supported features.
LOYVERSE_GET_OPEN_ID_CONFIGURATIONAcciónTool to retrieve the openid connect discovery document. use when integrating authentication and need endpoints and supported features.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Payment TypeLOYVERSE_GET_PAYMENT_TYPEAcciónTool 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.
LOYVERSE_GET_PAYMENT_TYPEAcciónTool 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.
Parámetros de entrada
payment_type_idstringObligatorioThe unique ID of the payment type to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get StoreLOYVERSE_GET_STOREAcciónTool to retrieve details of a specific store by its id. use when you need store metadata (address, contact) after obtaining the store id.
LOYVERSE_GET_STOREAcciónTool to retrieve details of a specific store by its id. use when you need store metadata (address, contact) after obtaining the store id.
Parámetros de entrada
store_idstringObligatorioThe unique ID of the store to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CategoriesLOYVERSE_LIST_CATEGORIESAcciónTool to list categories with optional filtering and pagination.
LOYVERSE_LIST_CATEGORIESAcciónTool to list categories with optional filtering and pagination.
Parámetros de entrada
limitintegerMaximum number of categories to return (1-250). Default is 50.
cursorstringCursor for pagination from a previous response
show_deletedbooleanInclude soft-deleted categories when true
categories_idsstringComma-separated list of category IDs to filter by
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersLOYVERSE_LIST_CUSTOMERSAcciónTool to get a list of customers. use when you need paginated customer lists with optional filters.
LOYVERSE_LIST_CUSTOMERSAcciónTool to get a list of customers. use when you need paginated customer lists with optional filters.
Parámetros de entrada
limitintegerMaximum number of customers to return (1-250).
offsetintegerNumber of customers to skip for pagination.
customer_idstringFilter by a specific customer ID.
phone_numberstringFilter by customer's phone number (include country code).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DiscountsLOYVERSE_LIST_DISCOUNTSAcciónTool to list discounts. use when fetching a paginated set of discounts for display or sync.
LOYVERSE_LIST_DISCOUNTSAcciónTool to list discounts. use when fetching a paginated set of discounts for display or sync.
Parámetros de entrada
limitintegerMaximum number of discounts to return (>=1).
offsetintegerNumber of discounts to skip for pagination (>=0).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List EmployeesLOYVERSE_LIST_EMPLOYEESAcciónTool to get a list of employees. use when you need paginated employee lists with optional filters. works after authenticating.
LOYVERSE_LIST_EMPLOYEESAcciónTool to get a list of employees. use when you need paginated employee lists with optional filters. works after authenticating.
Parámetros de entrada
limitintegerNumber of employees to return per page
cursorstringCursor for pagination; pass value from previous response to fetch next page
employee_idsstringComma-separated list of employee UUIDs to filter results
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ItemsLOYVERSE_LIST_ITEMSAcciónTool 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.
LOYVERSE_LIST_ITEMSAcciónTool 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.
Parámetros de entrada
afterstringCursor for pagination; returns items after this cursor.
limitintegerMaximum number of items to return (1-250).
vendor_idstringFilter items by vendor ID.
category_idstringFilter items by category ID.
location_idstringFilter items by a specific location ID.
modifier_idstringReturn only items that have this modifier ID attached.
updated_at_maxstringOnly items updated before this ISO 8601 date/time.
updated_at_minstringOnly items updated after this ISO 8601 date/time.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ModifiersLOYVERSE_LIST_MODIFIERSAcciónTool to list modifiers. use when you need a paginated list of modifiers with optional filters.
LOYVERSE_LIST_MODIFIERSAcciónTool to list modifiers. use when you need a paginated list of modifiers with optional filters.
Parámetros de entrada
idsstringComma-separated list of modifier IDs to filter results
limitintegerNumber of modifiers to return per page (1-250)
cursorstringCursor for pagination; use value from previous response to fetch next page
updated_at_maxstringFilter modifiers updated before this datetime (ISO 8601)
updated_at_minstringFilter modifiers updated after this datetime (ISO 8601)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment TypesLOYVERSE_LIST_PAYMENT_TYPESAcciónTool to list payment types. use when you need to fetch available payment methods with optional filters and pagination.
LOYVERSE_LIST_PAYMENT_TYPESAcciónTool to list payment types. use when you need to fetch available payment methods with optional filters and pagination.
Parámetros de entrada
limitintegerMaximum number of payment types to return (1-250)
cursorstringCursor for pagination; pass value from previous response to retrieve next page
show_deletedbooleanWhether to include soft-deleted payment types
created_at_maxstringOnly include payment types created at or before this ISO 8601 timestamp
created_at_minstringOnly include payment types created at or after this ISO 8601 timestamp
updated_at_maxstringOnly include payment types updated at or before this ISO 8601 timestamp
updated_at_minstringOnly include payment types updated at or after this ISO 8601 timestamp
payment_type_idsstringComma-separated list of payment type UUIDs to filter results
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ReceiptsLOYVERSE_LIST_RECEIPTSAcciónTool to retrieve a list of receipts. use when you need to fetch receipts with optional filters and handle pagination.
LOYVERSE_LIST_RECEIPTSAcciónTool to retrieve a list of receipts. use when you need to fetch receipts with optional filters and handle pagination.
Parámetros de entrada
limitintegerMaximum number of receipts to return (1-250)
orderstringFilter receipts by order ID
cursorstringCursor for pagination; pass value from previous response to fetch next page
sourcestringFilter receipts by source application
store_idstringFilter receipts by store ID
created_at_maxstringInclude receipts created before this ISO 8601 date/time
created_at_minstringInclude receipts created at or after this ISO 8601 date/time
updated_at_maxstringInclude receipts updated before this ISO 8601 date/time
updated_at_minstringInclude receipts updated at or after this ISO 8601 date/time
receipt_numbersstringComma-separated list of receipt numbers to filter results
since_receipt_numberstringReturn only receipts after this receipt number
before_receipt_numberstringReturn only receipts before this receipt number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ShiftsLOYVERSE_LIST_SHIFTSAcciónTool to list shifts. use when you need to retrieve shift records for reporting or auditing with optional filters.
LOYVERSE_LIST_SHIFTSAcciónTool to list shifts. use when you need to retrieve shift records for reporting or auditing with optional filters.
Parámetros de entrada
limitintegerMaximum number of shifts to return (1-250)
cursorstringCursor for pagination; use the cursor from previous response to fetch next page
store_idsstringComma-separated list of store IDs to filter shifts
created_at_maxstringShow shifts opened before this date/time (ISO 8601)
created_at_minstringShow shifts opened at or after this date/time (ISO 8601)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SuppliersLOYVERSE_LIST_SUPPLIERSAcciónTool to retrieve a list of suppliers. use when you need a paginated supplier directory with optional filters.
LOYVERSE_LIST_SUPPLIERSAcciónTool to retrieve a list of suppliers. use when you need a paginated supplier directory with optional filters.
Parámetros de entrada
limitintegerMaximum number of suppliers to return (1-250). Default is 50.
cursorstringPagination cursor from a previous request. Use to fetch the next page.
show_deletedbooleanWhether to include soft-deleted suppliers in the results.
suppliers_idsstringReturn only suppliers specified by a comma-separated list of IDs
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TaxesLOYVERSE_LIST_TAXESAcciónTool 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".
LOYVERSE_LIST_TAXESAcciónTool 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".
Parámetros de entrada
limitintegerNumber of results to return per page. Must be between 1 and 250. Default is 50.
offsetintegerInitial index from which to return the results (zero-based). Default is 0.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List VariantsLOYVERSE_LIST_VARIANTSAcciónTool to list variants. use when you need to retrieve item variants with optional filtering by item and pagination.
LOYVERSE_LIST_VARIANTSAcciónTool to list variants. use when you need to retrieve item variants with optional filtering by item and pagination.
Parámetros de entrada
limitintegerNumber of variants to return per page (default is 100).
cursorstringCursor for pagination; use the value from previous response to fetch the next page.
item_idstringFilter variants by the associated item ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List WebhooksLOYVERSE_LIST_WEBHOOKSAcciónTool to list webhooks. use when you need to retrieve all configured webhooks.
LOYVERSE_LIST_WEBHOOKSAcciónTool to list webhooks. use when you need to retrieve all configured webhooks.
Parámetros de entrada
limitintegerMaximum number of webhooks to return per page.
offsetintegerNumber of webhooks to skip for pagination.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not