The Loyverse connector lets your AI agent act in each user's Loyverse account. Each user connects their own Loyverse access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 56 tools.
- Tools
- 56
- What they doRead · write · destructive
- 32 · 13 · 1132 read13 write11 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Loyverse connection
In AgentKit > Connections, create a Loyverse connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'loyverse'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Loyverse:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'loyverse_categories_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "loyverse"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Loyverse:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="loyverse_categories_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Loyverse credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolloyverse_categories_listList item categories.Read-onlyList Categories
List item categories. Returns per category its id, name and color. Results are paged: pass the returned cursor to get the next page.
Inputs
categories_idsstring- Comma-separated category IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
loyverse_category_getGet one category by ID.Read-onlyGet Category
Get one category by ID. Returns its name and color.
Inputs
category_idstringrequired- ID of the category. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_customer_getGet one customer by ID.Read-onlyGet Customer
Get one customer by ID. Returns contact details, note, points balance, first and last visit, visits and total spent.
Inputs
customer_idstringrequired- ID of the customer. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_customers_listList customers, optionally by email or date range.Read-onlyList Customers
List customers, optionally by email or date range. Returns per customer their id, name, email, phone, address, customer code, note, points balance, visits and total spent. Results are paged: pass the returned cursor to get the next page.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
customer_idsstring- Comma-separated customer IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
emailstring- Exact customer email. Example: jane@example.com.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_discount_getGet one discount by ID.Read-onlyGet Discount
Get one discount by ID. Returns its name, type, value, stores and restricted access flag.
Inputs
discount_idstringrequired- ID of the discount. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_discounts_listList discounts.Read-onlyList Discounts
List discounts. Returns per discount its id, name, type, amount or percent, stores and restricted access flag.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
discount_idsstring- Comma-separated discount IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_employee_getGet one employee by ID.Read-onlyGet Employee
Get one employee by ID. Returns name, email, phone, role and stores.
Inputs
employee_idstringrequired- ID of the employee. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_employees_listList employees.Read-onlyList Employees
List employees. Returns per employee their id, name, email, phone, role and stores. Results are paged: pass the returned cursor to get the next page.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
employee_idsstring- Comma-separated employee IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_inventory_listList stock levels per item variant and store, optionally of some stores or variants.Read-onlyList Inventory Levels
List stock levels per item variant and store, optionally of some stores or variants. Returns per entry variant_id, store_id, in_stock and updated_at. Results are paged: pass the returned cursor to get the next page.
Inputs
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
store_idsstring- Comma-separated store IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
variant_idsstring- Comma-separated variant IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_item_getGet one item by ID with its variants, prices, category, taxes, modifiers and components.Read-onlyGet Item
Get one item by ID with its variants, prices, category, taxes, modifiers and components.
Inputs
item_idstringrequired- ID of the item. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_items_listList items (products) with their variants.Read-onlyList Items
List items (products) with their variants. Returns per item its id, name, description, category, taxes, modifiers, options and variants with SKU, barcode, prices per store and costs. Results are paged: pass the returned cursor to get the next page. Use loyverse_variants_list to look up by SKU.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
items_idsstring- Comma-separated item IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_merchant_getGet the merchant account: business name, email, country, currency and creation date.Read-onlyGet Merchant
Get the merchant account: business name, email, country, currency and creation date. Use this to check the connection.
Inputs
This tool takes no inputs.
loyverse_modifier_getGet one modifier by ID with its options, prices and stores.Read-onlyGet Modifier
Get one modifier by ID with its options, prices and stores.
Inputs
modifier_idstringrequired- ID of the modifier. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_modifiers_listList modifiers (option groups such as extra toppings) with their options and prices.Read-onlyList Modifiers
List modifiers (option groups such as extra toppings) with their options and prices. Results are paged: pass the returned cursor to get the next page.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
modifier_idsstring- Comma-separated modifier IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_payment_type_getGet one payment type by ID.Read-onlyGet Payment Type
Get one payment type by ID. Returns its name and type.
Inputs
payment_type_idstringrequired- ID of the payment type. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_payment_types_listList payment types (cash, card and custom ones).Read-onlyList Payment Types
List payment types (cash, card and custom ones). Returns per type its id, name and type. Use this to find a payment_type_id for receipts.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
payment_type_idsstring- Comma-separated payment type IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_pos_device_getGet one POS device by ID.Read-onlyGet POS Device
Get one POS device by ID. Returns its name, store and activation state.
Inputs
pos_device_idstringrequired- ID of the pos device. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_pos_devices_listList POS devices, optionally of one store.Read-onlyList POS Devices
List POS devices, optionally of one store. Returns per device its id, name, store and activation state.
Inputs
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
store_idstring- Only devices of this store ID. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
loyverse_receipt_getGet one receipt by number.Read-onlyGet Receipt
Get one receipt by number. Returns its type, dates, store, employee, customer, totals, taxes, discounts, line items and payments.
Inputs
receipt_numberstringrequired- Number of the sales receipt, e.g. 1-1001. Example: 1-1001.
loyverse_receipts_listList sales and refund receipts, optionally by numbers, store, order, source or date range.Read-onlyList Receipts
List sales and refund receipts, optionally by numbers, store, order, source or date range. Returns per receipt its number, type, dates, store, employee, customer, totals, taxes, discounts, line items and payments. Results are paged: pass the returned cursor to get the next page.
Inputs
before_receipt_numberstring- Only receipts before this receipt number. Example: 1-1100.
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
orderstring- Only receipts with this order name or number. Example: Table 12.
receipt_numbersstring- Comma-separated receipt numbers. Example: 1-1001,1-1002.
since_receipt_numberstring- Only receipts after this receipt number. Example: 1-1001.
sourcestring- Only receipts from this source, e.g. point of sale or an app name. Example: My App.
store_idstring- Only receipts of this store ID. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_shift_getGet one shift by ID.Read-onlyGet Shift
Get one shift by ID. Returns its store, device, times, employees, cash movements, gross and net sales, taxes and payments.
Inputs
shift_idstringrequired- ID of the shift. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_shifts_listList cash register shifts, optionally of some stores or in a date range.Read-onlyList Shifts
List cash register shifts, optionally of some stores or in a date range. Returns per shift its id, store, POS device, opening and closing times and employees, cash amounts, taxes and payments. Results are paged: pass the returned cursor to get the next page.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
store_idsstring- Comma-separated store IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_store_getGet one store by ID.Read-onlyGet Store
Get one store by ID. Returns its name, address, phone and description.
Inputs
store_idstringrequired- ID of the store. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
loyverse_stores_listList the merchant's stores.Read-onlyList Stores
List the merchant's stores. Returns per store its id, name, address, phone and description. Use this to find a store_id.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
store_idsstring- Comma-separated store IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_supplier_getGet one supplier by ID.Read-onlyGet Supplier
Get one supplier by ID. Returns name, contact, email, phone, website, address and note.
Inputs
supplier_idstringrequired- ID of the supplier. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_suppliers_listList suppliers.Read-onlyList Suppliers
List suppliers. Returns per supplier its id, name, contact, email, phone, website and address. Results are paged: pass the returned cursor to get the next page.
Inputs
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
suppliers_idsstring- Comma-separated supplier IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_tax_getGet one tax by ID.Read-onlyGet Tax
Get one tax by ID. Returns its name, rate, type and stores.
Inputs
tax_idstringrequired- ID of the tax. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_taxes_listList taxes.Read-onlyList Taxes
List taxes. Returns per tax its id, name, rate, type (included or added) and stores.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
tax_idsstring- Comma-separated tax IDs to return. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
loyverse_variant_getGet one item variant by ID.Read-onlyGet Item Variant
Get one item variant by ID. Returns its item, SKU, barcode, option values, cost and prices per store.
Inputs
variant_idstringrequired- ID of the variant. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_variants_listList item variants, optionally by item, SKU or IDs.Read-onlyList Item Variants
List item variants, optionally by item, SKU or IDs. Returns per variant its id, item, SKU, barcode, option values, cost and prices per store. Results are paged: pass the returned cursor to get the next page.
Inputs
created_at_maxstring- Only records created at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
created_at_minstring- Only records created at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
cursorstring- Cursor from the previous response's cursor field, to get the next page. Example: eyJsYXN0SWQiOiIxMjM0In0=.
items_idsstring- Comma-separated item IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
limitinteger- Maximum number of results to return, 1 to 250. Defaults to 50. Example: 50.
show_deletedboolean- Include deleted records. Defaults to false. Example: false.
skustring- Exact variant SKU. Example: 10001.
updated_at_maxstring- Only records updated at or before this time (ISO 8601). Example: 2026-12-31T23:59:59.000Z.
updated_at_minstring- Only records updated at or after this time (ISO 8601). Example: 2026-01-01T00:00:00.000Z.
variants_idsstring- Comma-separated variant IDs. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_webhook_getGet one webhook by ID.Read-onlyGet Webhook
Get one webhook by ID. Returns its URL, event type and status.
Inputs
webhook_idstringrequired- ID of the webhook. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_webhooks_listList webhooks.Read-onlyList Webhooks
List webhooks. Returns per webhook its id, URL, event type and status.
Inputs
This tool takes no inputs.
loyverse_category_upsertCreate an item category, or update one.WriteCreate or Update Category
Create an item category, or update one. Pass id to update an existing record instead of creating one. Returns the category.
Inputs
namestringrequired- Category name. Example: Drinks.
colorstring- Category color on the POS. One of: GREY, RED, PINK, ORANGE, GREEN, BLUE, PURPLE. Example: BLUE.one of
GREYREDPINKORANGEGREENBLUEPURPLE idstring- ID of the category to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_customer_upsertCreate a customer, or update one.WriteCreate or Update Customer
Create a customer, or update one. Pass id to update an existing record instead of creating one. Returns the customer.
Inputs
namestringrequired- The customer's name. Example: Jane Doe.
addressstring- The customer's address. Example: 123 Main St.
citystring- The customer's city, town, or village. Example: Austin.
country_codestring- The two-letter country code corresponding to the customer's country in ISO 3166-1-alpha-2 format. Example: US.
customer_codestring- Your own code for the customer, e.g. a loyalty card number. Example: C-1001.
emailstring- The customer's email. Example: jane@example.com.
idstring- ID of the customer to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
notestring- The note about the customer. Example: Prefers oat milk.
phone_numberstring- The customer's phone number. Example: +15555550123.
postal_codestring- The customer’s postal code, also known as zip, postcode, Eircode, etc. Example: 78701.
regionstring- The customer’s region name. Typically a province, a state, or a prefecture. Example: TX.
total_pointsnumber- Actual customer points balance. Example: 120.
loyverse_discount_upsertCreate a discount, or update one.WriteCreate or Update Discount
Create a discount, or update one. Pass id to update an existing record instead of creating one. Returns the discount.
Inputs
namestringrequired- The discount name. Example: Happy hour.
typestringrequired- The type of the discount. One of: FIXED_PERCENT, FIXED_AMOUNT, VARIABLE_PERCENT, VARIABLE_AMOUNT, DISCOUNT_BY_POINTS. Example: FIXED_PERCENT.one of
FIXED_PERCENTFIXED_AMOUNTVARIABLE_PERCENTVARIABLE_AMOUNTDISCOUNT_BY_POINTS discount_amountnumber- The discount value in money representation (only for discounts with type FIXED_AMOUNT). Example: 2.
discount_percentnumber- This is discount value in percentage (only for discounts with type FIXED_PERCENT). Example: 15.
idstring- ID of the discount to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
restricted_accessboolean- If true, the password verification is necessary in order to apply this discount on POS. Example: false.
storesarray- IDs of the stores where the discount is available; all stores by default. Example: ["3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]
loyverse_inventory_updateSet the stock level of item variants at stores, in one batch.WriteUpdate Inventory Levels
Set the stock level of item variants at stores, in one batch. Returns the updated levels.
- Idempotent
Inputs
inventory_levelsarrayrequired- Stock levels to set, each with variant_id, store_id and stock_after (the new quantity in stock). Example: [{"variant_id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "store_id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "stock_after": 25}]
loyverse_item_upsertCreate an item (product) with its variants, or update one.WriteCreate or Update Item
Create an item (product) with its variants, or update one. Pass id to update an existing record instead of creating one. Returns the item with its variants.
Inputs
item_namestringrequired- Item name. Example: Cappuccino.
category_idstring- The category id of the item. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
colorstring- One of the predefined colors for the item that is displayed on the POS. Example: GREY.one of
GREYREDPINKORANGEYELLOWGREENBLUEPURPLE descriptionstring- The item description. Example: Double shot with steamed milk.
formstring- The visual form of the item that is displayed on the POS. One of: SQUARE, CIRCLE, SUN, OCTAGON. Example: SQUARE.one of
SQUARECIRCLESUNOCTAGON idstring- ID of the item to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
modifiers_idsarray- IDs of the modifiers offered with the item. Example: ["3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]
option1_namestring- Name of the first variant option, e.g. Size. Example: Size.
option2_namestring- Name of the second variant option, e.g. Color. Example: Milk.
option3_namestring- Name of the third variant option, e.g. Material. Example: Temperature.
primary_supplier_idstring- ID of the item's main supplier. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
reference_idstring- External reference id for the item. Example: CAP-01.
sold_by_weightboolean- If true, a fractional quantity for this item can be specified at the time of a sale (for example 1.5). Example: false.
tax_idsarray- IDs of the taxes applied to the item. Example: ["3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]
track_stockboolean- If true, the system tracks inventory for this item at all stores. Make sure you don't accidentally disable track stock. If you set track_stock to false then all inventory levels of this item are set to 0. Example: false.
variantsarray- Variants of the item, each with optional sku, barcode, option values, cost, default_pricing_type (FIXED or VARIABLE), default_price and per-store stores entries. Example: [{"option1_value": "Large", "sku": "10001", "default_pricing_type": "FIXED", "default_price": 4.5}].
loyverse_modifier_upsertCreate a modifier with its options, or update one.WriteCreate or Update Modifier
Create a modifier with its options, or update one. Pass id to update an existing record instead of creating one. Returns the modifier.
Inputs
modifier_optionsarrayrequired- Options of the modifier, each with name, price and optional position. Example: [{"name": "Extra shot", "price": 0.5}].
namestringrequired- The modifier name. Example: Extra shots.
idstring- ID of the modifier to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
positioninteger- Determines the position of this modifier in the modifiers list. Example: 1.
storesarray- IDs of the stores where the modifier is available. Example: ["3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]
loyverse_pos_device_upsertCreate a POS device for a store, or rename one.WriteCreate or Update POS Device
Create a POS device for a store, or rename one. Pass id to update an existing record instead of creating one. Returns the device.
Inputs
namestringrequired- Device name. Example: Front counter.
store_idstringrequired- ID of the store the device belongs to. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
idstring- ID of the POS device to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_receipt_createRecord a sale as a receipt, with line items and one payment, for example an order placed in another system.WriteCreate Sales Receipt
Record a sale as a receipt, with line items and one payment, for example an order placed in another system. Returns the new receipt with its number. Stock is reduced for tracked items.
Inputs
line_itemsarrayrequired- Items sold, each with variant_id and quantity, and optionally price, cost and line_note. Example: [{"variant_id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "quantity": 2, "price": 4.5}]
store_idstringrequired- ID of the store of the sale. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
customer_idstring- The customer id associated with the receipt. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
employee_idstring- The employee id associated with the receipt. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
notestring- The receipt's note. Example: Online order.
orderstring- The order name or number associated with the receipt. Example: Table 12.
paymentsarray- The payment, as a one-element list with payment_type_id and money_amount (only one payment is allowed). Example: [{"payment_type_id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "money_amount": 9}]
receipt_datestring- When the sale happened (ISO 8601); defaults to now. Example: 2026-03-15T10:30:00.000Z.
sourcestring- The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. For receipts created from Loyverse mobile point of sale application the value is "point of sale". Example: My App.
loyverse_receipt_refundCreate a refund receipt for some or all line items of a sales receipt.WriteRefund Receipt
Create a refund receipt for some or all line items of a sales receipt. Returns the refund receipt.
Inputs
line_itemsarrayrequired- Line items to refund, each with the id of the original receipt line and the quantity to refund. Example: [{"id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "quantity": 1}]
receipt_numberstringrequired- Number of the sales receipt, e.g. 1-1001. Example: 1-1001.
employee_idstring- The employee id associated with the receipt. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
receipt_datestring- By default, it matches the created_at value (time when receipt was created on the Loyverse server). You can set receipt_date to the value that is equal to the date and time in the past when the refund was created in another system. Example: 2026-03-16T09:00:00.000Z.
sourcestring- The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. Example: My App.
store_idstring- Store of the refund; defaults to the store of the sale. Example: c1a2b3c4-1111-4a5b-9c8d-0123456789ab.
loyverse_supplier_upsertCreate a supplier, or update one.WriteCreate or Update Supplier
Create a supplier, or update one. Pass id to update an existing record instead of creating one. Returns the supplier.
Inputs
namestringrequired- The supplier company name. Example: Bean Co.
address_1string- The supplier address. Example: 1 Roast St.
address_2string- The supplier address. Example: Unit 2.
citystring- The supplier city, town, or village. Example: Portland.
contactstring- The supplier contact person name. Example: Sam Lee.
country_codestring- The two-letter country code corresponding to the supplier country in ISO 3166-1-alpha-2 format. Example: US.
emailstring- The supplier email. Example: orders@beanco.example.
idstring- ID of the supplier to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
notestring- Note about the supplier. Example: Delivers Tuesdays.
phone_numberstring- Supplier phone number. Example: +15555550123.
postal_codestring- The supplier’s postal code, also known as zip, postcode, Eircode, etc. Example: 97201.
regionstring- The supplier’s region name. Typically a province, a state, or a prefecture. Example: OR.
websitestring- The supplier website page. Example: https://beanco.example.
loyverse_tax_upsertCreate a tax, or update one.WriteCreate or Update Tax
Create a tax, or update one. Pass id to update an existing record instead of creating one. Returns the tax.
Inputs
namestringrequired- The tax name. Example: VAT.
ratenumberrequired- The tax rate. For example, a value of "5.255" corresponds to a percentage of 5.255%. Example: 20.
typestringrequired- If the type is INCLUDED then the tax is included in an item price. If the type is ADDED then the tax is added to an item price. One of: INCLUDED, ADDED. Example: ADDED.one of
INCLUDEDADDED idstring- ID of the tax to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
storesarray- IDs of the stores where the tax applies. Example: ["3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]
loyverse_variant_upsertAdd a variant to an existing item, or update a variant (pass variant_id).WriteCreate or Update Item Variant
Add a variant to an existing item, or update a variant (pass variant_id). Returns the variant.
Inputs
barcodestring- Barcode. Example: 4006381333931.
costnumber- The variant cost. Example: 1.2.
default_pricenumber- The default variant price (only for pricing_type: FIXED) If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the stores array for a particular store. Example: 4.5.
default_pricing_typestring- The default variant pricing type. If the value is VARIABLE than the price is specified at the time of a sale. If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the stores array for a particular store. One of: FIXED, VARIABLE. Example: FIXED.one of
FIXEDVARIABLE item_idstring- ID of the item the variant belongs to (required when creating). Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
option1_valuestring- The value of the first option for this variant. Required if option1_name is set for the item this variant is attached to. Example: Large.
option2_valuestring- The value of the second option for this variant. Required if option2_name is set for the item this variant is attached to. Example: Oat.
option3_valuestring- The value of the third option for this variant. Required if option3_name is set for the item this variant is attached to. Example: Hot.
purchase_costnumber- The variant purchase cost. Example: 1.1.
reference_variant_idstring- External reference id for the variant. Example: CAP-01-L.
skustring- The variant sku. It should be unique. Example: 10001.
storesarray- Per-store settings, each with store_id, pricing_type, price, available_for_sale, optimal_stock and low_stock. Example: [{"store_id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "pricing_type": "FIXED", "price": 4.5, "available_for_sale": true}]
variant_idstring- ID of the variant to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_webhook_upsertCreate a webhook that posts one event type (inventory, items, customers, receipts or shifts) to a URL, or update one by id.WriteCreate or Update Webhook
Create a webhook that posts one event type (inventory, items, customers, receipts or shifts) to a URL, or update one by id. Returns the webhook.
Inputs
typestringrequired- Event to send. One of: inventory_levels.update, items.update, customers.update, receipts.update, shifts.create. Example: receipts.update.one of
inventory_levels.updateitems.updatecustomers.updatereceipts.updateshifts.create urlstringrequired- HTTPS URL that receives the events. Example: https://example.com/loyverse-webhook.
idstring- ID of the webhook to update; leave empty to create one. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
statusstring- ENABLED or DISABLED. One of: ENABLED, DISABLED. Example: ENABLED.one of
ENABLEDDISABLED
loyverse_category_deleteDelete a category; its items stay uncategorized.DestructiveDelete Category
Delete a category; its items stay uncategorized.
- Idempotent
Inputs
category_idstringrequired- ID of the category. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_customer_deleteDelete a customer.DestructiveDelete Customer
Delete a customer.
- Idempotent
Inputs
customer_idstringrequired- ID of the customer. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_discount_deleteDelete a discount.DestructiveDelete Discount
Delete a discount.
- Idempotent
Inputs
discount_idstringrequired- ID of the discount. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_item_deleteDelete an item and its variants.DestructiveDelete Item
Delete an item and its variants.
- Idempotent
Inputs
item_idstringrequired- ID of the item. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_item_image_deleteRemove the image of an item.DestructiveDelete Item Image
Remove the image of an item.
- Idempotent
Inputs
item_idstringrequired- ID of the item. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_modifier_deleteDelete a modifier.DestructiveDelete Modifier
Delete a modifier.
- Idempotent
Inputs
modifier_idstringrequired- ID of the modifier. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_pos_device_deleteDelete a POS device.DestructiveDelete POS Device
Delete a POS device.
- Idempotent
Inputs
pos_device_idstringrequired- ID of the pos device. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_supplier_deleteDelete a supplier.DestructiveDelete Supplier
Delete a supplier.
- Idempotent
Inputs
supplier_idstringrequired- ID of the supplier. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_tax_deleteDelete a tax.DestructiveDelete Tax
Delete a tax.
- Idempotent
Inputs
tax_idstringrequired- ID of the tax. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_variant_deleteDelete an item variant.DestructiveDelete Item Variant
Delete an item variant.
- Idempotent
Inputs
variant_idstringrequired- ID of the variant. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
loyverse_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook.
- Idempotent
Inputs
webhook_idstringrequired- ID of the webhook. Example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d.
No tools match.