Skip to main content
Loyverse logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 58
  • Triggers: 0
  • Slug: LOYVERSE
  • Version: 20261101_00

Tools

Slug: LOYVERSE_CREATE_OR_UPDATE_CATEGORYTool 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.

Input Parameters

string
The category ID. If provided, this will update the existing category instead of creating a new one.
string
required
The name of the category (required).
string ("GREY" | "RED" | "PINK" | "ORANGE" | "GREEN" | "BLUE" | "PURPLE")
Available category colors in Loyverse

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_CUSTOMERTool 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.

Input Parameters

string
Customer ID for update operation. If provided, the action will update the existing customer with this ID instead of creating a new one.
string
Customer’s city.
string
required
Customer’s full name (required). This is the primary identifier for the customer.
string
Additional notes or comments about the customer.
string
Customer’s email address. Used for receipts and communication.
string
Customer’s region, state, or province.
string
Customer’s street address.
string
Customer’s postal or ZIP code.
string
Customer’s country code in ISO 3166-1 alpha-2 format (two-letter code).
string
Customer’s phone number. Include country code for international numbers (e.g., +1234567890).
string
Unique customer code or loyalty card number for identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_DISCOUNTCreates a single discount with a FIXED_PERCENT, FIXED_AMOUNT, or VARIABLE type.

Input Parameters

string
required
The discount name.
string ("FIXED_PERCENT" | "FIXED_AMOUNT" | "VARIABLE")
required
Discount type. FIXED_PERCENT for percentage-based discounts, FIXED_AMOUNT for fixed amount discounts, or VARIABLE for variable discounts.
array
Array of store IDs where discount is applicable. If not provided, discount applies to all stores.
number
Fixed discount amount (required for FIXED_AMOUNT type). Value should be a positive number.
number
Discount percentage (required for FIXED_PERCENT type). Value should be between 0 and 100.
boolean
Whether discount has restricted access (requires password verification to apply).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_ITEMTool 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.

Input Parameters

string
UUID of the item. Include this to update an existing item, omit to create a new one.
string
Visual form/shape of the item (e.g., ‘SQUARE’, ‘CIRCLE’).
string
Display color for the item in the POS (e.g., ‘GREY’, ‘RED’, ‘PINK’, ‘ORANGE’, ‘GREEN’, ‘BLUE’, ‘PURPLE’).
string
Human-readable handle/slug for the item.
array
List of tax UUIDs applied to this item.
array
List of variants for this item with pricing and SKU info.
string
URL of the item’s product image.
string
required
Display name of the item. This field is required.
array
List of component items if this is a composite item.
string
UUID of the category this item belongs to.
boolean
Whether inventory tracking is enabled for this item.
boolean
Whether this is a composite/bundle item.
string
Name of the first variant option (e.g., ‘Size’).
string
Name of the second variant option (e.g., ‘Color’).
string
Name of the third variant option.
string
External reference ID for integration purposes.
array
List of modifier UUIDs available for this item.
boolean
Whether the item is sold by weight.
boolean
Whether production workflow is enabled.
string
UUID of the primary supplier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_MODIFIERTool 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.

Input Parameters

string
Modifier ID for updates. If provided, updates the existing modifier; if omitted, creates a new modifier.
string
required
Name of the modifier
array
Array of store IDs where this modifier is available
integer
Display position of the modifier in the list
array
required
Array of modifier option objects. Each option requires at least a name; price defaults to 0.00 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_POS_DEVICETool 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.

Input Parameters

string
Optional POS device ID (UUID). If provided, this will update an existing device instead of creating a new one.
string
required
Name of the POS device
string
required
The unique ID (UUID) of the store this POS device is connected to. Use list stores action to get store IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_SUPPLIERTool 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.

Input Parameters

string
Supplier ID for update operation. If provided, the action will update the existing supplier with this ID instead of creating a new one. Use UUID format.
string
Supplier city, town, or village (max 64 characters).
string
required
Name of the supplier company (1-64 characters, required). This is the primary identifier for the supplier.
string
Additional notes about the supplier.
string
Supplier email address (1-100 characters).
string
Supplier region (state or province). Additional address component.
string
Contact person at the supplier (1-64 characters).
string
Supplier website URL.
string
Supplier address line 1 (max 192 characters).
string
Supplier address line 2 (max 192 characters).
string
Supplier postal code.
string
Supplier country code (ISO 3166-1 alpha-2).
string
Supplier phone number (max 15 characters). Include country code for international numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_TAXTool 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.

Input Parameters

string
Tax ID for updates. If provided, updates the existing tax instead of creating a new one.
string
required
Business-facing label for the tax.
number
required
The tax percentage rate (e.g., 5.545 for 5.545%, 10 for 10%).
string ("ADDED" | "INCLUDED")
required
Determines how the tax is applied. ADDED means tax is added on top of the price, INCLUDED means tax is already included in the price.
array
Array of store IDs where this tax applies. If not provided, tax applies to all stores.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_VARIANTTool 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.

Input Parameters

string
Stock Keeping Unit identifier for the variant. Used for inventory tracking.
number
Cost price of the variant for profit margin calculations.
array
Array of store-specific settings including pricing, availability, and stock levels for each store where this variant is sold.
string
Barcode for the variant, used for scanning at point of sale.
string
required
The ID of the item this variant belongs to. The item must have option names defined (option1_name, option2_name, or option3_name) before variants can be created.
string
The ID of the variant to update. If provided, updates existing variant instead of creating new one. Also referred to as ‘id’ in some API responses.
number
Default selling price for the variant. Used unless overridden by store-specific pricing.
string
Value for the first option (e.g., ‘Small’, ‘Medium’, ‘Large’). Required if the parent item has option1_name defined.
string
Value for the second option (e.g., ‘Red’, ‘Blue’). Required if the parent item has option2_name defined.
string
Value for the third option. Required if the parent item has option3_name defined.
number
Purchase cost of the variant from suppliers.
string ("FIXED" | "VARIABLE")
Pricing type for a variant.
string
External reference ID for the variant, useful for third-party integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_OR_UPDATE_WEBHOOKCreate a new Loyverse webhook subscription or update an existing one by ID. Supported event types include items.update, inventory_levels.update, receipts.update, customers.update, and shifts.create.

Input Parameters

string
The webhook ID. If provided, this will update the existing webhook instead of creating a new one.
string
required
URI where the webhook should send the POST request when the event occurs (required).
string ("inventory_levels.update" | "items.update" | "customers.update" | "receipts.update" | "shifts.create")
required
The event type to subscribe to (required). Available types: inventory_levels.update, items.update, customers.update, receipts.update, shifts.create.
string ("ENABLED" | "DISABLED")
required
The webhook status (required). Set to ENABLED to activate the webhook or DISABLED to deactivate it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_RECEIPTTool to create a sales receipt with line items and payments. Use when you need to record a sale transaction in Loyverse.

Input Parameters

string
Additional notes for the receipt
string
Order reference number or name
string
Source application name
array
Array of payment methods and amounts for the receipt
string
required
UUID of the store where receipt is created
array
Array of line items to include in the receipt
string
UUID of the customer associated with the receipt
string
UUID of the employee processing the transaction
string
ISO 8601 date-time format for when the receipt was created. Defaults to current time if not specified
array
Array of discount objects to apply at the receipt level

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_CREATE_REFUNDTool 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).

Input Parameters

string
Source application or system creating this refund
string
Store ID where the refund is processed. If not provided, uses the original receipt’s store.
array
required
List of line items to refund (at least one item required)
string
Employee ID processing the refund. If not provided, uses the original receipt’s employee.
string
Date and time for the refund receipt in ISO 8601 format. Defaults to current time if not provided.
string
required
The sales receipt number to create a refund for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_CATEGORYTool to delete a single category by ID. Use when you need to remove an unused or deprecated category.

Input Parameters

string
required
The unique ID of the category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_CUSTOMERTool to delete a single customer by their ID. Use after confirming the customer ID to remove an existing customer.

Input Parameters

string
required
The unique ID of the customer to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_DISCOUNTTool to delete a single discount by ID. Use after confirming the discount ID to remove an existing discount.

Input Parameters

string
required
The unique ID of the discount to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_ITEMTool to delete a single item by ID. Use when you need to remove an item from the inventory.

Input Parameters

string
required
The unique ID of the item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_ITEM_IMAGEDelete the image associated with an item by item ID. If the successful response body is empty, the returned deleted-object list contains the item ID supplied in the request.

Input Parameters

string
required
The unique ID of the item from which to delete the image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_MODIFIERTool to delete a single modifier by its ID. Use when you need to remove an existing modifier.

Input Parameters

string
required
The unique identifier of the modifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_POS_DEVICETool to delete a single POS device by its ID. Use when you need to remove a POS device from the system.

Input Parameters

string
required
The unique ID of the POS device to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_SUPPLIERTool to delete a specific supplier by ID. Use after confirming the supplier ID to remove an existing supplier.

Input Parameters

string
required
The unique ID of the supplier to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_TAXTool to delete a single tax by its ID. Use when you need to remove an existing tax configuration.

Input Parameters

string
required
The unique identifier of the tax to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_VARIANTTool to delete a single item variant by its ID. Use after confirming the variant ID to remove an existing variant.

Input Parameters

string
required
The unique ID of the variant to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_DELETE_WEBHOOKTool to delete a single webhook by its ID. Use when you need to remove a webhook configuration.

Input Parameters

string
required
The unique ID of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_CATEGORYTool to get a single category by ID. Use when you need to fetch details of an existing category in Loyverse.

Input Parameters

string
required
The unique ID of the category to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_CUSTOMERTool to get a single customer by their ID. Use when you need to fetch details of a specific customer.

Input Parameters

string
required
The unique UUID of the customer to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_DISCOUNTTool to get a single discount by ID. Use after confirming the discount ID to retrieve its details.

Input Parameters

string
required
UUID of the discount to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_EMPLOYEETool to get a single employee by ID. Use after confirming the employee ID to fetch its details.

Input Parameters

string
required
The unique UUID of the employee to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_ITEMTool 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.

Input Parameters

string
required
The unique UUID of the item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_JWKSTool to fetch JSON Web Key Set for OpenID Connect. Use when verifying Loyverse ID token signatures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_MERCHANT_INFOTool to get merchant information. Use after authenticating to retrieve merchant account details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_MODIFIERTool to get a single modifier by ID. Use when you need to fetch details of an existing modifier in Loyverse.

Input Parameters

string
required
UUID of the modifier to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_OPEN_ID_CONFIGURATIONTool to retrieve the OpenID Connect discovery document. Use when integrating authentication and need endpoints and supported features.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_PAYMENT_TYPETool 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.

Input Parameters

string
required
The unique ID of the payment type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_POS_DEVICETool to retrieve details of a specific POS device by its ID. Use when you need POS device metadata after obtaining the device ID.

Input Parameters

string
required
The unique ID of the POS device to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_RECEIPTTool 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.

Input Parameters

string
required
The unique receipt number to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_STORETool to retrieve details of a specific store by its ID. Use when you need store metadata (address, contact) after obtaining the store ID.

Input Parameters

string
required
The unique ID of the store to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_SUPPLIERTool to get a single supplier by their ID. Use when you need to fetch details of a specific supplier in Loyverse.

Input Parameters

string
required
The unique UUID of the supplier to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_TAXTool to get a single tax by ID. Use when you need to retrieve details of a specific tax configuration in Loyverse.

Input Parameters

string
required
The unique ID of the tax to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_VARIANTTool to get a single item variant by its ID. Use when you need detailed information about a specific variant from the Loyverse inventory.

Input Parameters

string
required
The unique UUID of the variant to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_GET_WEBHOOKTool to get a single webhook by its ID. Use when you need to retrieve details of a specific webhook configuration.

Input Parameters

string
required
The unique UUID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_CATEGORIESTool to list categories with optional filtering and pagination.

Input Parameters

integer
Maximum number of categories to return (1-250). Default is 50.
string
Cursor for pagination from a previous response
boolean
Include soft-deleted categories when true
string
Comma-separated list of category UUIDs to filter by (e.g., ‘uuid1,uuid2’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_CUSTOMERSTool to get a list of customers. Use when you need paginated customer lists with optional filters.

Input Parameters

string
Filter by customer’s email address (exact match).
integer
Maximum number of customers to return per request (1-250). Default is 50 if not specified.
string
Cursor for pagination. Use the cursor value from the previous response to fetch the next page of results.
string
Filter by a specific customer ID to retrieve that customer’s details.
string
Filter by customer’s phone number. Include country code for best results.
string
Filter customers created at or before this timestamp (ISO 8601 format).
string
Filter customers created at or after this timestamp (ISO 8601 format).
string
Filter customers updated at or before this timestamp (ISO 8601 format).
string
Filter customers updated at or after this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_DISCOUNTSTool to list discounts. Use when fetching a paginated set of discounts for display or sync.

Input Parameters

integer
Maximum number of discounts to return (>=1).
integer
Number of discounts to skip for pagination (>=0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_EMPLOYEES2Tool 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.

Input Parameters

integer
Used for pagination. Number of employees to return per page.
string
Used for pagination. Cursor for pagination; pass value from previous response to fetch next page
string
Return only employees specified by a comma-separated list of IDs
boolean
Show deleted modifiers and modifier options
string
Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_INVENTORYRetrieves 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.

Input Parameters

integer
Maximum number of inventory levels to return per page. Default is 50, maximum is 250.
string
Pagination cursor from a previous response. Pass this value to retrieve the next page of results.
string
Comma-separated list of store IDs (UUIDs) to filter inventory levels. Only inventory for these stores will be returned.
string
Comma-separated list of variant IDs (UUIDs) to filter inventory levels. Only inventory for these variants will be returned.
string
Return only inventory levels updated on or before this ISO 8601 timestamp.
string
Return only inventory levels updated on or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_ITEMSRetrieves 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.

Input Parameters

integer
Maximum number of items to return per page. Default is 50, maximum is 250.
string
Pagination cursor from a previous response to retrieve the next page of results.
string
Comma-separated list of item IDs (UUIDs) to filter by.
string
Filter items by category ID (UUID).
boolean
If true, include soft-deleted items in the response. Default is false.
string
Return only items created on or before this ISO 8601 timestamp.
string
Return only items created on or after this ISO 8601 timestamp.
string
Return only items updated on or before this ISO 8601 timestamp.
string
Return only items updated on or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_MODIFIERS2Tool 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.

Input Parameters

integer
Used for pagination. Number of modifiers to return per page (1-250)
string
Used for pagination. Cursor for pagination; use value from previous response to fetch next page
string
Return only modifiers specified by a comma-separated list of IDs
boolean
Show deleted modifiers and modifier options
string
Show resources created before date (ISO 8601 format)
string
Show resources created after date (ISO 8601 format)
string
Show resources updated before date (ISO 8601 format)
string
Show resources updated after date (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_PAYMENT_TYPESTool to list payment types. Use when you need to fetch available payment methods with optional filters and pagination.

Input Parameters

integer
Maximum number of payment types to return (1-250)
string
Cursor for pagination; pass value from previous response to retrieve next page
boolean
Whether to include soft-deleted payment types
string
Only include payment types created at or before this ISO 8601 timestamp
string
Only include payment types created at or after this ISO 8601 timestamp
string
Only include payment types updated at or before this ISO 8601 timestamp
string
Only include payment types updated at or after this ISO 8601 timestamp
string
Comma-separated list of payment type UUIDs to filter results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_POS_DEVICESTool 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.

Input Parameters

integer
Maximum number of POS devices to return per page (1-250). Default is 50.
string
Pagination cursor from a previous response. Use to fetch the next page of results.
string
Filter POS devices by store ID (UUID). If not provided, returns devices from all stores.
boolean
If true, include soft-deleted POS devices in the response. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_RECEIPTSTool to retrieve a list of receipts. Use when you need to fetch receipts with optional filters and handle pagination.

Input Parameters

integer
Maximum number of receipts to return (1-250)
string
Filter receipts by order ID
string
Cursor for pagination; pass value from previous response to fetch next page
string
Filter receipts by source application
string
Filter receipts by store ID
string
Include receipts created before this ISO 8601 date/time
string
Include receipts created at or after this ISO 8601 date/time
string
Include receipts updated before this ISO 8601 date/time
string
Include receipts updated at or after this ISO 8601 date/time
string
Comma-separated list of receipt numbers to filter results
string
Return only receipts after this receipt number
string
Return only receipts before this receipt number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_SHIFTSTool to list shifts. Use when you need to retrieve shift records for reporting or auditing with optional filters.

Input Parameters

integer
Maximum number of shifts to return (1-250)
string
Cursor for pagination; use the cursor from previous response to fetch next page
string
Comma-separated list of store IDs to filter shifts
string
Show shifts opened before this date/time (ISO 8601)
string
Show shifts opened at or after this date/time (ISO 8601)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_STORESTool to get a list of stores sorted by creation date (newest first). Use when you need to retrieve store information across multiple locations.

Input Parameters

integer
Maximum number of stores to return per page (1-250). Default is 50.
string
Pagination cursor from a previous response. Use to fetch the next page of results.
string
Return only stores specified by a comma-separated list of IDs.
boolean
If true, include deleted stores in the response. Default is false.
string
Show stores created on or before this timestamp (ISO 8601 format).
string
Show stores created on or after this timestamp (ISO 8601 format).
string
Show stores updated on or before this timestamp (ISO 8601 format).
string
Show stores updated on or after this timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_SUPPLIERSTool to retrieve a list of suppliers. Use when you need a paginated supplier directory with optional filters.

Input Parameters

integer
Maximum number of suppliers to return (1-250). Default is 50.
string
Pagination cursor from a previous request. Use to fetch the next page.
boolean
Whether to include soft-deleted suppliers in the results.
string
Return only suppliers specified by a comma-separated list of IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_TAXES2Tool 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.

Input Parameters

string
Return only taxes specified by a comma-separated list of IDs
boolean
Show deleted modifiers and modifier options
string
Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_VARIANTS2Tool 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.

Input Parameters

string
Filter variants by SKU (Stock Keeping Unit) code
integer
Maximum number of variants to return per page. Used for pagination. Default is 50.
string
Pagination cursor from a previous response. Used for pagination.
string
Return only variants attached to specified item IDs (comma-separated UUIDs)
boolean
Show deleted modifiers and modifier options. Default is false.
string
Return only variants specified by a comma-separated list of variant IDs (UUIDs)
string
Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
string
Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_LIST_WEBHOOKSList configured webhooks, with optional limit and offset pagination. A call returns one page rather than automatically retrieving all pages.

Input Parameters

integer
Maximum number of webhooks to return per page.
integer
Number of webhooks to skip for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_UPDATE_INVENTORYTool 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.

Input Parameters

array
required
List of inventory level updates to apply. Each entry specifies a variant, store, and new stock level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOYVERSE_UPLOAD_ITEM_IMAGEUpload a single PNG or JPEG image for an item by ID. The tool may report failure after the image has been uploaded if it cannot retrieve the image URL.

Input Parameters

object
required
Image file to upload. Accepts image/png or image/jpeg content types.
string
required
The unique UUID of the item to upload the image to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not