Loyverse

These are the Loyverse actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create or Update Customer

  Tool to create a new customer or update an existing one in Loyverse. Use when you need to add customer records or modify customer information. If the 'id' field is provided, it will update the existing customer; otherwise, it creates a new customer.

• Create or Update Item

  Tool to create a new item or update an existing one in Loyverse inventory. Include the item ID to update an existing item, or omit it to create a new one.

• Create or Update Variant

  Tool to create or update a single item variant in Loyverse. Use when you need to add product variations (like size, color) or modify existing variant details. If variant_id is provided, it updates the existing variant; otherwise, it creates a new one. Note: The parent item must have option names defined before variants can be created.

• Create Receipt

  Tool to create a sales receipt with line items and payments. Use when you need to record a sale transaction in Loyverse.

• Create Refund

  Tool to create a refund receipt for a sales receipt. Use when you need to process a refund for items from a previous sale. Only supports refunds for receipts paid by a single payment method (not integrated payments).

• Get Customer

  Tool to get a single customer by their ID. Use when you need to fetch details of a specific customer.

• Get Item

  Tool to get a single item by ID including all its variants. Use when you need detailed information about a specific item from the Loyverse inventory.

• Get POS Device

  Tool to retrieve details of a specific POS device by its ID. Use when you need POS device metadata after obtaining the device ID.

• Get Receipt

  Tool to retrieve a single receipt by its receipt number. Use when you need detailed information about a specific receipt including line items, payments, and totals.

• Get Variant

  Tool to get a single item variant by its ID. Use when you need detailed information about a specific variant from the Loyverse inventory.

• List Employees (Advanced)

  Tool to get a list of employees with advanced filtering options. Use when you need to filter employees by creation/update dates or view deleted employees.

• List Inventory

  Retrieves inventory levels for item variants across stores in the Loyverse system. Use this to track stock quantities for specific variants at different store locations. Filter by store IDs, variant IDs, or date range to narrow results.

• List Modifiers (Enhanced)

  Tool to get a list of modifiers sorted by created_at in descending order. Use when you need to retrieve modifiers with advanced filtering options including creation/update dates and deleted items.

• List Stores

  Tool to get a list of stores sorted by creation date (newest first). Use when you need to retrieve store information across multiple locations.

• List Variants

  Tool to get a list of item variants sorted by creation date (newest first). Use when you need comprehensive filtering by variant IDs, item IDs, SKU, or date ranges, including deleted variants.

• Update Inventory

  Tool to batch update inventory levels for item variants at specific stores. Use when you need to set absolute stock quantities (not deltas) for one or more variant-store combinations.

• Create or Update Category

  Tool to create a new category or update an existing one. If the ID field is provided, the category will be updated; otherwise, a new category is created.

• Create or Update Discount

  Tool to create or update a single discount. Use when creating new discounts or modifying existing ones. Supports FIXED_PERCENT (percentage-based), FIXED_AMOUNT (fixed amount), and VARIABLE discount types.

• Create or Update Modifier

  Tool to create or update a single modifier with options. If an ID is included in the request, it will update the existing modifier; otherwise, it creates a new one.

• Create or Update POS Device

  Tool to create a new POS device or update an existing one. If the request includes an ID, it updates the device; otherwise, it creates a new one.

• Create or Update Supplier

  Tool to create a new supplier or update an existing one in Loyverse. Use when you need to register suppliers before purchases or modify supplier information. If the 'id' field is provided, it will update the existing supplier; otherwise, it creates a new supplier.

• Create or Update Tax

  Tool to create or update a single tax. If the ID field is provided, the tax will be updated; otherwise, a new tax is created. Use when setting up tax rates for stores.

• Create or Update Webhook

  Tool to create a new webhook subscription or update an existing one in Loyverse. Use when you need to subscribe to events like items.update, inventory.update, receipts.create, customers.update, or shifts.create. If the 'id' field is provided, it will update the existing webhook; otherwise, it creates a new webhook.

• Delete Category

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

• Delete Customer

  Tool to delete a single customer by their ID. Use after confirming the customer ID to remove an existing customer.

• Delete Discount

  Tool to delete a single discount by ID. Use after confirming the discount ID to remove an existing discount.

• Delete Item

  Tool to delete a single item by ID. Use when you need to remove an item from the inventory.

• Delete Item Image

  Tool to delete a single image from an item. Use when you need to remove the image associated with a specific item.

• Delete Modifier

  Tool to delete a single modifier by its ID. Use when you need to remove an existing modifier.

• Delete POS Device

  Tool to delete a single POS device by its ID. Use when you need to remove a POS device from the system.

• Delete Supplier

  Tool to delete a specific supplier by ID. Use after confirming the supplier ID to remove an existing supplier.

• Delete Tax

  Tool to delete a single tax by its ID. Use when you need to remove an existing tax configuration.

• Delete Variant

  Tool to delete a single item variant by its ID. Use after confirming the variant ID to remove an existing variant.

• Delete Webhook

  Tool to delete a single webhook by its ID. Use when you need to remove a webhook configuration.

• Get Category

  Tool to get a single category by ID. Use when you need to fetch details of an existing category in Loyverse.

• Get Discount

  Tool to get a single discount by ID. Use after confirming the discount ID to retrieve its details.

• Get Employee

  Tool to get a single employee by ID. Use after confirming the employee ID to fetch its details.

• Get JWKS

  Tool to fetch JSON Web Key Set for OpenID Connect. Use when verifying Loyverse ID token signatures.

• Get Merchant Info

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

• Get Modifier

  Tool to get a single modifier by ID. Use when you need to fetch details of an existing modifier in Loyverse.

• Get OpenID Connect Discovery Document

  Tool to retrieve the OpenID Connect discovery document. Use when integrating authentication and need endpoints and supported features.

• 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.

• 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.

• Get Supplier

  Tool to get a single supplier by their ID. Use when you need to fetch details of a specific supplier in Loyverse.

• Get Tax

  Tool to get a single tax by ID. Use when you need to retrieve details of a specific tax configuration in Loyverse.

• Get Webhook

  Tool to get a single webhook by its ID. Use when you need to retrieve details of a specific webhook configuration.

• List Categories

  Tool to list categories with optional filtering and pagination.

• List Customers

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

• List Discounts

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

• List Items

  Retrieves a paginated list of items (products) from the Loyverse inventory. Items are sorted by creation date in descending order (newest first). Use filters to narrow results by category, date range, or specific item IDs.

• List Payment Types

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

• List POS Devices

  Tool to get a list of POS devices sorted by creation date in descending order. Use when you need to retrieve POS device information for store management or reporting.

• List Receipts

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

• List Shifts

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

• List Suppliers

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

• List Taxes

  Tool to get a list of taxes sorted by creation date (newest first). Use when you need to retrieve tax records with optional filtering by IDs or date ranges.

• List Webhooks

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

• Upload Item Image

  Tool to upload a single image for an item. Accepts image/png or image/jpeg content types. Use after confirming the item ID to upload product images.