Query Loyverse POS receipts, shifts, items, inventory and customers, and update stock and customers.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Fetch a single customer by id, with visits, total spent and points balance. Loyverse: GET /customers/{customer_id}.
The customer id (UUID).
Fetch a single customer by id, with visits, total spent and points balance. Loyverse: GET /customers/{customer_id}.
| Argument | Type | Description |
|---|---|---|
| customer_id* | string | The customer id (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"minLength": 1,
"description": "The customer id (UUID)."
}
}
}Fetch a single catalog item by id, with its variants. Loyverse: GET /items/{item_id}.
| Argument | Type | Description |
|---|---|---|
| item_id* | string | The item id (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"item_id"
],
"properties": {
"item_id": {
"type": "string",
"minLength": 1,
"description": "The item id (UUID)."
}
}
}Fetch the merchant account this token belongs to — business name, email, country and currency. A cheap way to confirm the token works. Loyverse: GET /merchant/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Fetch a single receipt by its receipt number (e.g. 2-1008), with line items, modifiers, discounts, taxes and payments. Loyverse: GET /receipts/{receipt_number}.
| Argument | Type | Description |
|---|---|---|
| receipt_number* | string | The receipt number, e.g. 2-1008. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"receipt_number"
],
"properties": {
"receipt_number": {
"type": "string",
"minLength": 1,
"description": "The receipt number, e.g. 2-1008."
}
}
}List item categories. Loyverse: GET /categories.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| categories_ids | string | Comma-separated list of category ids to return. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"categories_ids": {
"type": "string",
"description": "Comma-separated list of category ids to return."
}
}
}List loyalty customers, newest first, with visits, total spent and points balance. Filter by email or ids. Loyverse: GET /customers.
| Argument | Type | Description |
|---|---|---|
| string | Only the customer with this email. | |
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| customer_ids | string | Comma-separated list of customer ids to return. |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
List configured discounts (fixed/variable percent or amount, discount-by-points) and where they apply. Loyverse: GET /discounts.
| Argument | Type | Description |
|---|---|---|
| discount_ids | string | Comma-separated list of discount ids to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"discount_ids": {
"type": "string",
"description": "Comma-separated list of discount ids to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}List employees, with the stores each can access and whether they are the owner. Loyverse: GET /employees.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| employee_ids | string | Comma-separated list of employee ids to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
List current stock (`in_stock`) per variant per store. Filter by stores and/or variants — the answer to 'what is running low?'. Loyverse: GET /inventory.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| store_ids | string | Comma-separated store ids. |
| variant_ids | string | Comma-separated variant ids. |
| updated_at_max | string | Only levels updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only levels updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"store_ids": {
"type": "string",
"description": "Comma-separated store ids."
},
"variant_ids": {
"type": "string",
"description": "Comma-separated variant ids."
},
"updated_at_max": {
"type": "string",
"description": "Only levels updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only levels updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}List catalog items with their variants (SKU, barcode, price, cost, per-store pricing), category, taxes and modifiers. Loyverse: GET /items.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| items_ids | string | Comma-separated list of item ids to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
List the payment types (cash, card, integrated terminals…) and the stores where each is available. Receipt payments reference these ids. Loyverse: GET /payment_types.
| Argument | Type | Description |
|---|---|---|
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| payment_type_ids | string | Comma-separated list of payment type ids to return. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"payment_type_ids": {
"type": "string",
"description": "Comma-separated list of payment type ids to return."
}
}
}List sales and refund receipts, newest first, with line items, payments, discounts and taxes. Filter by store, time range or receipt numbers — the core of any sales question. Loyverse: GET /receipts.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| order | string | Only receipts with this order name/number. |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| source | string | Only receipts from this source (e.g. an app name). |
| store_id | string | Only receipts from this store. |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
List cash-register shifts with their cash, gross/net sales, refunds, discounts, taxes, per-payment-type totals and pay-in/pay-out movements — the end-of-day view. Loyverse: GET /shifts.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| store_ids | string | Comma-separated list of store ids to return. |
| created_at_max | string | Only shifts opened at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only shifts opened at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"store_ids": {
"type": "string",
"description": "Comma-separated list of store ids to return."
},
"created_at_max": {
"type": "string",
"description": "Only shifts opened at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only shifts opened at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}List the merchant's stores (locations) with their addresses. Store ids are what the receipt, shift and inventory filters take. Loyverse: GET /stores.
| Argument | Type | Description |
|---|---|---|
| store_ids | string | Comma-separated list of store ids to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"store_ids": {
"type": "string",
"description": "Comma-separated list of store ids to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}List suppliers with their contact details. Loyverse: GET /suppliers/.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| suppliers_ids | string | Comma-separated list of supplier ids to return. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"suppliers_ids": {
"type": "string",
"description": "Comma-separated list of supplier ids to return."
}
}
}List taxes with their rate, whether they are INCLUDED in or ADDED to the price, and the stores they apply in. Loyverse: GET /taxes.
| Argument | Type | Description |
|---|---|---|
| tax_ids | string | Comma-separated list of tax ids to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_max | string | Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"tax_ids": {
"type": "string",
"description": "Comma-separated list of tax ids to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}List item variants — the sellable SKUs — optionally for given items or one SKU. Variant ids are what inventory levels are keyed on. Loyverse: GET /variants.
| Argument | Type | Description |
|---|---|---|
| sku | string | Only the variant with this SKU. |
| limit | integer | Page size, 1-250 (Loyverse default 50). |
| cursor | string | The `cursor` from the previous page's response. Omit for the first page. |
| items_ids | string | Comma-separated item ids whose variants to return. |
| show_deleted | boolean | Also return soft-deleted records (they carry deleted_at). |
| variants_ids | string | Comma-separated list of variant ids to return. |
| created_at_max | string | Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| created_at_min | string | Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
Set the ABSOLUTE stock (`stock_after`) of one or more variants at given stores — e.g. after a stock count. This overwrites the current level rather than adding to it; read the current levels with loyverse_list_inventory first so they can be restored. Loyverse: POST /inventory.
| Argument | Type | Description |
|---|---|---|
| inventory_levels* | array | The stock levels to set. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inventory_levels"
],
"properties": {
"inventory_levels": {
"type": "array",
"items": {
"type": "object",
"required": [
"variant_id",
"store_id",
"stock_after"
],
"properties": {
"store_id": {
"type": "string",
"minLength": 1,
"description": "The store id."
},
"variant_id": {
"type": "string",
"minLength": 1,
"description": "The item variant id."
},
"stock_after": {
"type": "number",
"description": "The new stock level for that variant at that store."
}
}
},
"maxItems": 250,
"minItems": 1,
"description": "The stock levels to set."
}
}
}Create an item category, or rename/recolor one by passing its `id`. Loyverse: POST /categories.
| Argument | Type | Description |
|---|---|---|
| id | string | Existing category id to update. Omit to create. |
| name* | string | The category name (required). |
| color | string | Display color on the POS. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Existing category id to update. Omit to create."
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The category name (required)."
},
"color": {
"enum": [
"GREY",
"RED",
"PINK",
"ORANGE",
"GREEN",
"BLUE",
"PURPLE"
],
"type": "string",
"description": "Display color on the POS."
}
}
}Create a loyalty customer, or update one by passing its `id`. Loyverse does not document whether omitted fields survive an update, so on update fetch the customer first and send the full record. Loyverse: POST /customers.
| Argument | Type | Description |
|---|---|---|
| id | string | Existing customer id to update. Omit to create. |
| city | string | City, town or village. |
| name* | string | The customer's name (required). |
| note | string | A note about the customer. |
| string | Email address. | |
| region | string | Province, state or prefecture. |
| address | string | Street address. |
| postal_code | string | Postal / ZIP code. |
| country_code | string | Two-letter ISO 3166-1 alpha-2 country code, e.g. US. |
Create a supplier, or update one by passing its `id`. Loyverse does not document whether omitted fields survive an update, so on update send the full record. Loyverse: POST /suppliers/.
| Argument | Type | Description |
|---|---|---|
| id | string | Existing supplier id to update. Omit to create. |
| city | string | City, town or village. |
| name* | string | The supplier company name (required). |
| note | string | A note about the supplier. |
| string | Email address. | |
| region | string | Province, state or prefecture. |
| contact | string | Contact person's name. |
| website | string | Website URL. |
| address_1 | string | Address line 1. |
| address_2 | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"description": "Only the customer with this email."
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"customer_ids": {
"type": "string",
"description": "Comma-separated list of customer ids to return."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"employee_ids": {
"type": "string",
"description": "Comma-separated list of employee ids to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"items_ids": {
"type": "string",
"description": "Comma-separated list of item ids to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| receipt_numbers | string | Comma-separated receipt numbers to return, e.g. 2-1008,2-1009. |
| since_receipt_number | string | Only receipts created at or after the receipt with this number. |
| before_receipt_number | string | Only receipts created up to the receipt with this number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"order": {
"type": "string",
"description": "Only receipts with this order name/number."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"source": {
"type": "string",
"description": "Only receipts from this source (e.g. an app name)."
},
"store_id": {
"type": "string",
"description": "Only receipts from this store."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"receipt_numbers": {
"type": "string",
"description": "Comma-separated receipt numbers to return, e.g. 2-1008,2-1009."
},
"since_receipt_number": {
"type": "string",
"description": "Only receipts created at or after the receipt with this number."
},
"before_receipt_number": {
"type": "string",
"description": "Only receipts created up to the receipt with this number."
}
}
}| updated_at_max |
| string |
| Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
| updated_at_min | string | Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sku": {
"type": "string",
"description": "Only the variant with this SKU."
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Page size, 1-250 (Loyverse default 50)."
},
"cursor": {
"type": "string",
"description": "The `cursor` from the previous page's response. Omit for the first page."
},
"items_ids": {
"type": "string",
"description": "Comma-separated item ids whose variants to return."
},
"show_deleted": {
"type": "boolean",
"description": "Also return soft-deleted records (they carry deleted_at)."
},
"variants_ids": {
"type": "string",
"description": "Comma-separated list of variant ids to return."
},
"created_at_max": {
"type": "string",
"description": "Only records created at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"created_at_min": {
"type": "string",
"description": "Only records created at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_max": {
"type": "string",
"description": "Only records updated at or before this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
},
"updated_at_min": {
"type": "string",
"description": "Only records updated at or after this time (ISO 8601 UTC, e.g. 2026-03-30T18:30:00.000Z)."
}
}
}| phone_number |
| string |
| Phone number. |
| customer_code | string | Your own customer code (e.g. a loyalty card number). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Existing customer id to update. Omit to create."
},
"city": {
"type": "string",
"maxLength": 64,
"description": "City, town or village."
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The customer's name (required)."
},
"note": {
"type": "string",
"maxLength": 255,
"description": "A note about the customer."
},
"email": {
"type": "string",
"maxLength": 100,
"description": "Email address."
},
"region": {
"type": "string",
"maxLength": 64,
"description": "Province, state or prefecture."
},
"address": {
"type": "string",
"maxLength": 192,
"description": "Street address."
},
"postal_code": {
"type": "string",
"maxLength": 20,
"description": "Postal / ZIP code."
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter ISO 3166-1 alpha-2 country code, e.g. US."
},
"phone_number": {
"type": "string",
"maxLength": 15,
"description": "Phone number."
},
"customer_code": {
"type": "string",
"maxLength": 40,
"description": "Your own customer code (e.g. a loyalty card number)."
}
}
}| Address line 2. |
| postal_code | string | Postal / ZIP code. |
| country_code | string | Two-letter ISO 3166-1 alpha-2 country code, e.g. US. |
| phone_number | string | Phone number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Existing supplier id to update. Omit to create."
},
"city": {
"type": "string",
"maxLength": 64,
"description": "City, town or village."
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The supplier company name (required)."
},
"note": {
"type": "string",
"maxLength": 500,
"description": "A note about the supplier."
},
"email": {
"type": "string",
"maxLength": 100,
"description": "Email address."
},
"region": {
"type": "string",
"maxLength": 64,
"description": "Province, state or prefecture."
},
"contact": {
"type": "string",
"maxLength": 64,
"description": "Contact person's name."
},
"website": {
"type": "string",
"description": "Website URL."
},
"address_1": {
"type": "string",
"maxLength": 192,
"description": "Address line 1."
},
"address_2": {
"type": "string",
"maxLength": 192,
"description": "Address line 2."
},
"postal_code": {
"type": "string",
"maxLength": 20,
"description": "Postal / ZIP code."
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter ISO 3166-1 alpha-2 country code, e.g. US."
},
"phone_number": {
"type": "string",
"maxLength": 15,
"description": "Phone number."
}
}
}