/loyverse | Type: Application | PCID required: Yes
Tools
loyverse_create_categories
Create or update a single categoryloyverse_create_customers
Create or update a single customerloyverse_create_discounts
Create or update a single discountloyverse_create_items
Create or update a single item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variants | any[] | No | — | The variants value |
loyverse_create_modifiers
Create or update a single modifierloyverse_create_pos_devices
Create or update a single pos deviceloyverse_create_receipts
Create a sales receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | No | — | The customer id associated with the receipt |
employee_id | string | No | — | The employee id associated with the receipt |
line_items | object[] | No | — | The line items included in the receipt |
note | string | No | — | The receipt’s note |
order | string | No | — | The order name or number associated with the receipt |
payments | object[] | No | — | The list of payments. There is a restriction that only one payment can be applied to receipt when using POST request. |
receipt_date | string | No | — | By default, it matches the created_at value. You can set receipt_date to the date and time in the past when the receipt was created in another system. This value is used in Loyverse back-office reports. |
source | string | No | — | 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”. |
store_id | string | No | — | The store id associated with the receipt |
total_discounts | object[] | No | — | The list of all discounts applied in the receipt. Discounts can be applied in two scopes, RECEIPT or LINE_ITEM. For discount with LINE_ITEM level you must reference to corresponding discount in every line item where this discount is applied. For discounts with RECEIPT level, line_discount for every line item will be generated automatically. |
loyverse_create_receipts_by_receipt_number_refund
Create a refund receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_number | string | Yes | — | The sales receipt number for a refund |
employee_id | string | No | — | The employee id associated with the receipt |
line_items | object[] | Yes | — | The line items included in the refund |
receipt_date | string | No | — | 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. |
source | string | No | — | The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. |
store_id | string | No | — | The store id associated with the refund receipt. By default, it matches the store id of the sales receipt. |
loyverse_create_suppliers
Create or update a single supplierloyverse_create_taxes
Create or update a single taxloyverse_create_variants
Create or update a single variantloyverse_create_webhooks
Create or update a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | The time when of the webhook was created |
id | string | No | — | The webhook id. Including this id in POST request will cause an update of existing webhook |
merchant_id | string | No | — | The id of the merchant which the webhook request originates from |
status | string | No | — | The current status of webhook |
type | string | No | — | The type value |
updated_at | string | No | — | The time when of the webhook was updated |
url | string | No | — | URI where the webhook should send the POST request when the event occurs |
loyverse_delete_categories_by_category_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | string | Yes | — | Category Id |
loyverse_delete_customers_by_customer_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | Customer Id |
loyverse_delete_discounts_by_discount_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_id | string | Yes | — | Discount Id |
loyverse_delete_items_by_item_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
loyverse_delete_items_by_item_id_image
Delete a single image Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
loyverse_delete_modifiers_by_modifier_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_id | string | Yes | — | Modifier Id |
loyverse_delete_pos_devices_by_pos_device_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pos_device_id | string | Yes | — | Pos Device Id |
loyverse_delete_suppliers_by_supplier_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
supplier_id | string | Yes | — | Supplier Id |
loyverse_delete_taxes_by_tax_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_id | string | Yes | — | Tax Id |
loyverse_delete_variants_by_variant_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variant_id | string | Yes | — | Variant Id |
loyverse_delete_webhooks_by_webhook_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook Id |
loyverse_get_categories_by_category_id
Get a single category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | string | Yes | — | Category Id |
loyverse_get_customers_by_customer_id
Get a single customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | Customer Id |
loyverse_get_discounts_by_discount_id
Get a single discount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_id | string | Yes | — | Discount Id |
loyverse_get_employees_by_employee_id
Get a single employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employee_id | string | Yes | — | Employee Id |
loyverse_get_items_by_item_id
Get a single item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
loyverse_get_merchant
Get merchant informationloyverse_get_modifiers_by_modifier_id
Get a single modifier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_id | string | Yes | — | Modifier Id |
loyverse_get_payment_types_by_payment_type_id
Get a single payment type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_type_id | string | Yes | — | Payment Type Id |
loyverse_get_pos_devices_by_pos_device_id
Get a single pos device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pos_device_id | string | Yes | — | Pos Device Id |
loyverse_get_receipts_by_receipt_number
Get a single receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_number | string | Yes | — | The unique number of the receipt |
loyverse_get_shifts_by_shift_id
Get a single shift Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shift_id | string | Yes | — | Shift Id |
loyverse_get_stores_by_store_id
Get a single store Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store Id |
loyverse_get_suppliers_by_supplier_id
Get a single supplier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
supplier_id | string | Yes | — | Supplier Id |
loyverse_get_taxes_by_tax_id
Get a single tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_id | string | Yes | — | Tax Id |
loyverse_get_variants_by_variant_id
Get a single item variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variant_id | string | Yes | — | Variant Id |
loyverse_get_webhooks_by_webhook_id
Get a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook Id |
loyverse_list_categories
Get a list of categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categories_ids | string | No | — | Return only categories specified by a comma-separated list of IDs |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_customers
Get a list of customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_ids | string | No | — | Return only customers specified by a comma-separated list of IDs |
email | string | No | — | Filter customers by email |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_discounts
Get a list of discounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_ids | string | No | — | Return only discounts specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_employees
Get a list of employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employee_ids | string | No | — | Return only employees specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_inventory
Inventory levels for item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | Show inventory levels only for specified stores |
variant_ids | string | No | — | Show inventory levels only for specified variants |
updated_at_min | string | No | — | Show inventory levels updated at or after specified date |
updated_at_max | string | No | — | Show inventory levels updated at or before specified date |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_items
Get a list of items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
items_ids | string | No | — | Return only items specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_modifiers
Get a list of modifiers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_ids | string | No | — | Return only modifiers specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_payment_types
Get a list of payment types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_type_ids | string | No | — | Return only payment types specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_pos_devices
Get a list of pos devices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | No | — | Show pos devices only for specified store |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_receipts
Get a list of receipts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_numbers | string | No | — | Return only receipts specified by a comma-separated list of receipt numbers |
since_receipt_number | string | No | — | Show receipts since date which is equal to created_at date of the receipt with specified number |
before_receipt_number | string | No | — | Show receipts up to date which is equal to created_at date of the receipt with specified number |
store_id | string | No | — | Show receipts only for specified store |
order | string | No | — | Filter receipts by order |
source | string | No | — | The name of the the source this receipt comes from |
updated_at_min | string | No | — | Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_shifts
Get a list of shifts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | A comma-separated list of store ids to filter shifts |
created_at_min | string | No | — | Show shifts opened after date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
created_at_max | string | No | — | Show shifts opened before date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
loyverse_list_stores
Get a list of stores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | Return only store specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_suppliers
Get a list of suppliers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
suppliers_ids | string | No | — | Return only suppliers specified by a comma-separated list of IDs |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_taxes
Get a list of taxes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_ids | string | No | — | Return only taxes specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_variants
Get a list of item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variants_ids | string | No | — | Return only variants specified by a comma-separated list of IDs |
items_ids | string | No | — | Return only variants attached to specified item ids |
sku | string | No | — | Filter variants by sku |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
loyverse_list_webhooks
Get a list of webhooksloyverse_update_inventory
Batch update inventory levels for item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_levels | object[] | No | — | Inventory Levels |
loyverse_upload_items_by_item_id_image
Upload a single image Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
body | string | No | — | Request body |

