Skip to main content
Server path: /loyverse | Type: Application | PCID required: Yes

Tools

ToolDescription
loyverse_create_categoriesCreate or update a single category
loyverse_create_customersCreate or update a single customer
loyverse_create_discountsCreate or update a single discount
loyverse_create_itemsCreate or update a single item
loyverse_create_modifiersCreate or update a single modifier
loyverse_create_pos_devicesCreate or update a single pos device
loyverse_create_receiptsCreate a sales receipt
loyverse_create_receipts_by_receipt_number_refundCreate a refund receipt
loyverse_create_suppliersCreate or update a single supplier
loyverse_create_taxesCreate or update a single tax
loyverse_create_variantsCreate or update a single variant
loyverse_create_webhooksCreate or update a single webhook
loyverse_delete_categories_by_category_idDelete a single resource
loyverse_delete_customers_by_customer_idDelete a single resource
loyverse_delete_discounts_by_discount_idDelete a single resource
loyverse_delete_items_by_item_idDelete a single resource
loyverse_delete_items_by_item_id_imageDelete a single image
loyverse_delete_modifiers_by_modifier_idDelete a single resource
loyverse_delete_pos_devices_by_pos_device_idDelete a single resource
loyverse_delete_suppliers_by_supplier_idDelete a single resource
loyverse_delete_taxes_by_tax_idDelete a single resource
loyverse_delete_variants_by_variant_idDelete a single resource
loyverse_delete_webhooks_by_webhook_idDelete a single resource
loyverse_get_categories_by_category_idGet a single category
loyverse_get_customers_by_customer_idGet a single customer
loyverse_get_discounts_by_discount_idGet a single discount
loyverse_get_employees_by_employee_idGet a single employee
loyverse_get_items_by_item_idGet a single item
loyverse_get_merchantGet merchant information
loyverse_get_modifiers_by_modifier_idGet a single modifier
loyverse_get_payment_types_by_payment_type_idGet a single payment type
loyverse_get_pos_devices_by_pos_device_idGet a single pos device
loyverse_get_receipts_by_receipt_numberGet a single receipt
loyverse_get_shifts_by_shift_idGet a single shift
loyverse_get_stores_by_store_idGet a single store
loyverse_get_suppliers_by_supplier_idGet a single supplier
loyverse_get_taxes_by_tax_idGet a single tax
loyverse_get_variants_by_variant_idGet a single item variant
loyverse_get_webhooks_by_webhook_idGet a single webhook
loyverse_list_categoriesGet a list of categories
loyverse_list_customersGet a list of customers
loyverse_list_discountsGet a list of discounts
loyverse_list_employeesGet a list of employees
loyverse_list_inventoryInventory levels for item variants
loyverse_list_itemsGet a list of items
loyverse_list_modifiersGet a list of modifiers
loyverse_list_payment_typesGet a list of payment types
loyverse_list_pos_devicesGet a list of pos devices
loyverse_list_receiptsGet a list of receipts
loyverse_list_shiftsGet a list of shifts
loyverse_list_storesGet a list of stores
loyverse_list_suppliersGet a list of suppliers
loyverse_list_taxesGet a list of taxes
loyverse_list_variantsGet a list of item variants
loyverse_list_webhooksGet a list of webhooks
loyverse_update_inventoryBatch update inventory levels for item variants
loyverse_upload_items_by_item_id_imageUpload a single image

loyverse_create_categories

Create or update a single category

loyverse_create_customers

Create or update a single customer

loyverse_create_discounts

Create or update a single discount

loyverse_create_items

Create or update a single item Parameters:
ParameterTypeRequiredDefaultDescription
variantsany[]NoThe variants value

loyverse_create_modifiers

Create or update a single modifier

loyverse_create_pos_devices

Create or update a single pos device

loyverse_create_receipts

Create a sales receipt Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringNoThe customer id associated with the receipt
employee_idstringNoThe employee id associated with the receipt
line_itemsobject[]NoThe line items included in the receipt
notestringNoThe receipt’s note
orderstringNoThe order name or number associated with the receipt
paymentsobject[]NoThe list of payments. There is a restriction that only one payment can be applied to receipt when using POST request.
receipt_datestringNoBy 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.
sourcestringNoThe 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_idstringNoThe store id associated with the receipt
total_discountsobject[]NoThe 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:
ParameterTypeRequiredDefaultDescription
receipt_numberstringYesThe sales receipt number for a refund
employee_idstringNoThe employee id associated with the receipt
line_itemsobject[]YesThe line items included in the refund
receipt_datestringNoBy 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.
sourcestringNoThe name of the the source this receipt comes from. By default it is the name of the application that created the receipt.
store_idstringNoThe 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 supplier

loyverse_create_taxes

Create or update a single tax

loyverse_create_variants

Create or update a single variant

loyverse_create_webhooks

Create or update a single webhook Parameters:
ParameterTypeRequiredDefaultDescription
created_atstringNoThe time when of the webhook was created
idstringNoThe webhook id. Including this id in POST request will cause an update of existing webhook
merchant_idstringNoThe id of the merchant which the webhook request originates from
statusstringNoThe current status of webhook
typestringNoThe type value
updated_atstringNoThe time when of the webhook was updated
urlstringNoURI where the webhook should send the POST request when the event occurs

loyverse_delete_categories_by_category_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
category_idstringYesCategory Id

loyverse_delete_customers_by_customer_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesCustomer Id

loyverse_delete_discounts_by_discount_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
discount_idstringYesDiscount Id

loyverse_delete_items_by_item_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
item_idstringYesItem Id

loyverse_delete_items_by_item_id_image

Delete a single image Parameters:
ParameterTypeRequiredDefaultDescription
item_idstringYesItem Id

loyverse_delete_modifiers_by_modifier_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
modifier_idstringYesModifier Id

loyverse_delete_pos_devices_by_pos_device_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
pos_device_idstringYesPos Device Id

loyverse_delete_suppliers_by_supplier_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
supplier_idstringYesSupplier Id

loyverse_delete_taxes_by_tax_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
tax_idstringYesTax Id

loyverse_delete_variants_by_variant_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
variant_idstringYesVariant Id

loyverse_delete_webhooks_by_webhook_id

Delete a single resource Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesWebhook Id

loyverse_get_categories_by_category_id

Get a single category Parameters:
ParameterTypeRequiredDefaultDescription
category_idstringYesCategory Id

loyverse_get_customers_by_customer_id

Get a single customer Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesCustomer Id

loyverse_get_discounts_by_discount_id

Get a single discount Parameters:
ParameterTypeRequiredDefaultDescription
discount_idstringYesDiscount Id

loyverse_get_employees_by_employee_id

Get a single employee Parameters:
ParameterTypeRequiredDefaultDescription
employee_idstringYesEmployee Id

loyverse_get_items_by_item_id

Get a single item Parameters:
ParameterTypeRequiredDefaultDescription
item_idstringYesItem Id

loyverse_get_merchant

Get merchant information

loyverse_get_modifiers_by_modifier_id

Get a single modifier Parameters:
ParameterTypeRequiredDefaultDescription
modifier_idstringYesModifier Id

loyverse_get_payment_types_by_payment_type_id

Get a single payment type Parameters:
ParameterTypeRequiredDefaultDescription
payment_type_idstringYesPayment Type Id

loyverse_get_pos_devices_by_pos_device_id

Get a single pos device Parameters:
ParameterTypeRequiredDefaultDescription
pos_device_idstringYesPos Device Id

loyverse_get_receipts_by_receipt_number

Get a single receipt Parameters:
ParameterTypeRequiredDefaultDescription
receipt_numberstringYesThe unique number of the receipt

loyverse_get_shifts_by_shift_id

Get a single shift Parameters:
ParameterTypeRequiredDefaultDescription
shift_idstringYesShift Id

loyverse_get_stores_by_store_id

Get a single store Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore Id

loyverse_get_suppliers_by_supplier_id

Get a single supplier Parameters:
ParameterTypeRequiredDefaultDescription
supplier_idstringYesSupplier Id

loyverse_get_taxes_by_tax_id

Get a single tax Parameters:
ParameterTypeRequiredDefaultDescription
tax_idstringYesTax Id

loyverse_get_variants_by_variant_id

Get a single item variant Parameters:
ParameterTypeRequiredDefaultDescription
variant_idstringYesVariant Id

loyverse_get_webhooks_by_webhook_id

Get a single webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesWebhook Id

loyverse_list_categories

Get a list of categories Parameters:
ParameterTypeRequiredDefaultDescription
categories_idsstringNoReturn only categories specified by a comma-separated list of IDs
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_customers

Get a list of customers Parameters:
ParameterTypeRequiredDefaultDescription
customer_idsstringNoReturn only customers specified by a comma-separated list of IDs
emailstringNoFilter customers by email
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_discounts

Get a list of discounts Parameters:
ParameterTypeRequiredDefaultDescription
discount_idsstringNoReturn only discounts specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_employees

Get a list of employees Parameters:
ParameterTypeRequiredDefaultDescription
employee_idsstringNoReturn only employees specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_inventory

Inventory levels for item variants Parameters:
ParameterTypeRequiredDefaultDescription
store_idsstringNoShow inventory levels only for specified stores
variant_idsstringNoShow inventory levels only for specified variants
updated_at_minstringNoShow inventory levels updated at or after specified date
updated_at_maxstringNoShow inventory levels updated at or before specified date
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_items

Get a list of items Parameters:
ParameterTypeRequiredDefaultDescription
items_idsstringNoReturn only items specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_modifiers

Get a list of modifiers Parameters:
ParameterTypeRequiredDefaultDescription
modifier_idsstringNoReturn only modifiers specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_payment_types

Get a list of payment types Parameters:
ParameterTypeRequiredDefaultDescription
payment_type_idsstringNoReturn only payment types specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_pos_devices

Get a list of pos devices Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringNoShow pos devices only for specified store
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_receipts

Get a list of receipts Parameters:
ParameterTypeRequiredDefaultDescription
receipt_numbersstringNoReturn only receipts specified by a comma-separated list of receipt numbers
since_receipt_numberstringNoShow receipts since date which is equal to created_at date of the receipt with specified number
before_receipt_numberstringNoShow receipts up to date which is equal to created_at date of the receipt with specified number
store_idstringNoShow receipts only for specified store
orderstringNoFilter receipts by order
sourcestringNoThe name of the the source this receipt comes from
updated_at_minstringNoShow receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_shifts

Get a list of shifts Parameters:
ParameterTypeRequiredDefaultDescription
store_idsstringNoA comma-separated list of store ids to filter shifts
created_at_minstringNoShow shifts opened after date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)
created_at_maxstringNoShow shifts opened before date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination

loyverse_list_stores

Get a list of stores Parameters:
ParameterTypeRequiredDefaultDescription
store_idsstringNoReturn only store specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_suppliers

Get a list of suppliers Parameters:
ParameterTypeRequiredDefaultDescription
suppliers_idsstringNoReturn only suppliers specified by a comma-separated list of IDs
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_taxes

Get a list of taxes Parameters:
ParameterTypeRequiredDefaultDescription
tax_idsstringNoReturn only taxes specified by a comma-separated list of IDs
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_variants

Get a list of item variants Parameters:
ParameterTypeRequiredDefaultDescription
variants_idsstringNoReturn only variants specified by a comma-separated list of IDs
items_idsstringNoReturn only variants attached to specified item ids
skustringNoFilter variants by sku
created_at_minstringNoShow resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
created_at_maxstringNoShow resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_minstringNoShow resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
updated_at_maxstringNoShow resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)
limitintegerNoUsed for pagination
cursorstringNoUsed for pagination
show_deletedbooleanNoShow deleted modifiers and modifier options

loyverse_list_webhooks

Get a list of webhooks

loyverse_update_inventory

Batch update inventory levels for item variants Parameters:
ParameterTypeRequiredDefaultDescription
inventory_levelsobject[]NoInventory Levels

loyverse_upload_items_by_item_id_image

Upload a single image Parameters:
ParameterTypeRequiredDefaultDescription
item_idstringYesItem Id
bodystringNoRequest body