Fetch the account profile: business name, country, and the currency with its decimal places. Call this first to know how to format money in every other result.

List the stores on the account with their addresses. Most filters elsewhere take a store_id from here.

Fetch one store by id.

List employees and their roles. Receipts and shifts reference employees by id.

Fetch one employee by id.

List till shifts with their opening and closing cash amounts. Use this to reconcile a day's cash drawer.

Fetch one shift by id.

List the payment types configured on the account. Creating a receipt requires a payment_type_id from here.

List the till devices registered to the account.

Register a till device against a store, or rename one by passing its id.

List suppliers with their contact details.

Fetch one supplier by id.

Create a supplier, or update one by passing its id.

List catalogue items with their variants, prices and SKUs. Use this to find the variant_id that the inventory and receipt tools need.

Fetch one catalogue item by id, including all of its variants.

Create a catalogue item, or update one by passing its id. Loyverse uses POST for both. Stock cannot be set here; create the item first, then call loyverse_set_inventory.

List item variants, optionally filtered by SKU or parent item. A variant is the sellable unit that inventory and receipts refer to.

Fetch one variant by id, including its per-store pricing.

Create a variant on an existing item, or update one by passing variant_id. Use this to change a price without rewriting the whole item.

List item categories.

Create a category, or rename one by passing its id.

List modifier groups and their options, such as sizes or extras.

Create a modifier group with its options, or update one by passing its id.

List the discounts configured on the account.

Create a discount, or update one by passing its id.

List tax rates and whether each is included in or added to the price.

Create a tax rate, or update one by passing its id.

Read current stock per variant per store. Filter by store_ids or variant_ids to keep the result small.

Set stock to an absolute figure for one or more variants at a store. stock_after is the resulting stock level, not a delta: sending 5 leaves 5 in stock regardless of what was there before. Read the current level with loyverse_get_inventory first if you mean to add or remove a quantity.

List loyalty customers with visit counts, total spend and points balance. Filter by email to find one person.

Fetch one customer by id, including loyalty points and visit history totals.

Create a customer, or update one by passing its id. This writes personal data to the merchant's Loyverse account, so only pass details the customer has given.

List sales and refund receipts with their line items, taxes, discounts and payments. Without the Unlimited Sales History add-on the account only serves the last 31 days, and older ranges return a payment-required error.

Fetch one receipt by its receipt number.

Record a sale. This posts a real transaction to the merchant's books and affects stock and reporting, so confirm the line items and total with the user before calling it. A receipt created through the API can carry only one payment type; split tender is not supported.

Issue a refund against an existing receipt, in full or for named line items. This moves money and restores stock, and it cannot be undone through the API. Always confirm the receipt number, the lines and the quantities with the user first.

Aggregate receipts over a date range into totals and a breakdown, without the model having to page through raw receipts. Reports gross sales, refunds, discounts, tax, tips and net, plus a ranked breakdown by day, item, category, payment type, employee or store. Cancelled receipts are excluded. Without the Unlimited Sales History add-on the account only serves the last 31 days.

Delete one record from the merchant's Loyverse account. This removes live business data and cannot be undone through the API. Name the record back to the user and get an explicit yes before calling it. Deleting an item also removes its variants and their stock history.

Attach an image to a catalogue item from a public URL, replacing any existing one.

List the webhook subscriptions registered on the account.

Subscribe an https endpoint to a Loyverse event. The endpoint will receive the merchant's live business data, so only register a URL the user has given you.