Dotypos MCP by usefulapi
Read orders, sales reports, stock and reservations; add customers, update products in Dotypos.
Should I use this
Quality & Safety
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"dotypos": {
"url": "https://dotypos.usefulapi.io/mcp"
}
}
}Remote endpoints
https://dotypos.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (23)
🟢dotypos_list_branches(deleted, page, limit)
List the branches (shops / points of sale) of the connected Dotypos cloud. Use the ids to filter orders, reservations and reports. GET /clouds/{cloud}/branches.
Input Schema
{
"type": "object",
"properties": {
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_branch(branch_id)
One branch by id. GET /clouds/{cloud}/branches/{id}.
Input Schema
{
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
}
},
"required": [
"branch_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_categories(name, deleted, sort, page, limit)
List product categories (name, VAT, colour, sort order). GET /clouds/{cloud}/categories.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only categories whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_category(category_id)
One product category by id. GET /clouds/{cloud}/categories/{id}.
Input Schema
{
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
}
},
"required": [
"category_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_products(name, category_id, ean, plu, tag, ...)
List or search the product catalog: name, prices with and without VAT, VAT, category, EAN/PLU codes, unit, tags, stock-deduction setting. Filter by name text, category, EAN or PLU code, tag or visibility. GET /clouds/{cloud}/products.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only products whose name contains this text (case insensitive).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"ean": {
"description": "Only products with this exact EAN code.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"plu": {
"description": "Only products with this exact PLU code.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"tag": {
"description": "Only products carrying this tag.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"displayed": {
"description": "true = only products shown at the POS, false = only hidden ones.",
"type": "boolean"
},
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_product(product_id)
One product by id with all its fields (prices, VAT, codes, allergens, packaging, notes). GET /clouds/{cloud}/products/{id}.
Input Schema
{
"type": "object",
"properties": {
"product_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
}
},
"required": [
"product_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_customers(first_name, last_name, company_name, email, phone, ...)
List or search customers (name, company, email, phone, address, points, tags). All given filters must match. Contains personal data. GET /clouds/{cloud}/customers.
Input Schema
{
"type": "object",
"properties": {
"first_name": {
"description": "First name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"last_name": {
"description": "Last name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"company_name": {
"description": "Company name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"email": {
"description": "E-mail contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"phone": {
"description": "Phone contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_customer(customer_id)
One customer by id. Contains personal data. GET /clouds/{cloud}/customers/{id}.
Input Schema
{
"type": "object",
"properties": {
"customer_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
}
},
"required": [
"customer_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_orders(created_from, created_to, status, document_type, branch_id, ...)
List orders and receipts (documents): number, type, status, totals, customer, employee, table, branch, paid flag, created/completed dates. Filter by time, status, type, branch, customer, employee or paid state; newest first by default. Line items are in dotypos_list_order_items. GET /clouds/{cloud}/orders.
Input Schema
{
"type": "object",
"properties": {
"created_from": {
"description": "Only orders created at or after this moment (ISO 8601).",
"type": "string"
},
"created_to": {
"description": "Only orders created before this moment (ISO 8601, exclusive).",
"type": "string"
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"new",
"parked",
"ready_to_pickup",
"ready_for_delivery",
"on_delivery",
"delivery_failed",
"canceled",
"closed"
]
},
"document_type": {
"description": "Document type, e.g. RECEIPT or INVOICE.",
"type": "string",
"enum": [
"RECEIPT",
"INVOICE",
"INVOICE_FROM_RECEIPTS",
"CORRECTIVE_INVOICE",
"EXTERNAL_INVOICE_PAYMENT",
"CASH_IN",
"CASH_OUT"
]
},
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"customer_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"employee_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"paid": {
"description": "true = only paid orders, false = only unpaid.",
"type": "boolean"
},
"document_number": {
"description": "Document number contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sort": {
"description": "Sort, e.g. -created (default) or created. Orders are not counted: follow next_page until it is null.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_order(order_id)
One order / receipt by id: status, totals, document number, customer, employee, table, notes, tags. GET /clouds/{cloud}/orders/{id}.
Input Schema
{
"type": "object",
"properties": {
"order_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_order_items(order_id, product_id, category_id, branch_id, employee_id, ...)
List sold line items: product, name, quantity, unit prices before and after discount, VAT, category, employee, order. Give order_id for one order's lines, or a time range for sales analysis. GET /clouds/{cloud}/order-items.
Input Schema
{
"type": "object",
"properties": {
"order_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"product_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"employee_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"created_from": {
"description": "Only items created at or after this moment (ISO 8601).",
"type": "string"
},
"created_to": {
"description": "Only items created before this moment (ISO 8601, exclusive).",
"type": "string"
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_get_sales_report(branch_id, date_from, date_to, vat_payer, seller_id, ...)
The base sales report of one branch for a time range of at most 26 hours (one business day; Dotypos limits a report to 26 hours, so ask for one day at a time): sales and cancel counts and values, revenue with VAT and payment-type breakdown, discounts, cash in/out, sales by category, product, tag, employee and customer, tips and write-offs. For longer periods use dotypos_list_order_items with a time range. GET /clouds/{cloud}/branches/{id}/sales-report.
Input Schema
{
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"date_from": {
"type": "string",
"description": "Start of the interval (ISO 8601 with a timezone, e.g. 2026-10-01T00:00:00+02:00)."
},
"date_to": {
"type": "string",
"description": "End of the interval (ISO 8601 with a timezone); at most 26 hours after date_from."
},
"vat_payer": {
"description": "Report as a VAT payer (default true).",
"type": "boolean"
},
"seller_id": {
"description": "Count only this seller: the _sellerId field of an employee in dotypos_list_employees (not the employee id). Default: all sellers.",
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
]
},
"lang": {
"description": "2-letter lowercase language code for names in the report (e.g. en, cs).",
"type": "string",
"pattern": "^[a-z]{2}$"
}
},
"required": [
"branch_id",
"date_from",
"date_to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_employees(name, deleted, page, limit)
List employees (name, e-mail, phone, enabled flag, access levels). Login barcodes and PINs are never returned. GET /clouds/{cloud}/employees.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only employees whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_tables(branch_id, page, limit)
List restaurant tables: name, location, seats, branch, enabled flag. GET /clouds/{cloud}/tables.
Input Schema
{
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_reservations(start_from, start_to, branch_id, customer_id, sort, ...)
List table reservations: customer, table, branch, start and end time, seats, status, note. Filter by start time window, branch or customer; each reservation carries its status (NEW, CONFIRMED, CANCELLED). GET /clouds/{cloud}/reservations.
Input Schema
{
"type": "object",
"properties": {
"start_from": {
"description": "Only reservations starting at or after this moment (ISO 8601).",
"type": "string"
},
"start_to": {
"description": "Only reservations starting before this moment (ISO 8601, exclusive).",
"type": "string"
},
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"customer_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_warehouses(deleted, page, limit)
List warehouses (stock locations). Use the ids with dotypos_list_stock. GET /clouds/{cloud}/warehouses.
Input Schema
{
"type": "object",
"properties": {
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_stock(warehouse_id, name, max_quantity, sort, page, ...)
Stock status of the products in one warehouse: each product with its quantity on hand (stockQuantityStatus), last stock change and purchase price. Filter by name or by maximum quantity to find low stock. GET /clouds/{cloud}/warehouses/{id}/products.
Input Schema
{
"type": "object",
"properties": {
"warehouse_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"name": {
"description": "Only products whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"max_quantity": {
"description": "Only products with a stock quantity at or below this number (low-stock check).",
"type": "number"
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"warehouse_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_suppliers(deleted, page, limit)
List suppliers (name, company ids, contact and address). GET /clouds/{cloud}/suppliers.
Input Schema
{
"type": "object",
"properties": {
"deleted": {
"description": "Deleted records: exclude (default), only, or include (both).",
"type": "string",
"enum": [
"exclude",
"only",
"include"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_delivery_notes(branch_id, sort, page, limit)
List imported supplier delivery notes: document number, supplier, branch, dates, status, download URL. GET /clouds/{cloud}/delivery-notes.
Input Schema
{
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"sort": {
"description": "Sort: attribute names, comma separated, a leading - for descending (e.g. -created,name). Only some attributes sort.",
"type": "string",
"maxLength": 200,
"pattern": "^-?[A-Za-z_][A-Za-z0-9_]*(,-?[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢dotypos_list_tags(name, page, limit)
List tags used on products, customers and orders. GET /clouds/{cloud}/tags.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only tags whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡dotypos_create_customer(first_name, last_name, company_name, email, phone, ...)
WRITE: create a customer record. At least one of first_name, last_name or company_name is required. Creates a new record every time (not idempotent). POST /clouds/{cloud}/customers.
Input Schema
{
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 180
},
"last_name": {
"type": "string",
"maxLength": 180
},
"company_name": {
"type": "string",
"maxLength": 180
},
"email": {
"type": "string",
"maxLength": 100
},
"phone": {
"type": "string",
"maxLength": 20
},
"address_line1": {
"type": "string",
"maxLength": 180
},
"city": {
"type": "string",
"maxLength": 255
},
"zip": {
"type": "string",
"maxLength": 20
},
"country": {
"description": "Country code.",
"type": "string",
"maxLength": 10
},
"company_id": {
"description": "Company registration number (CZ/SK: IČO).",
"type": "string",
"maxLength": 255
},
"vat_id": {
"description": "VAT id (CZ/SK: DIČ).",
"type": "string",
"maxLength": 255
},
"note": {
"type": "string",
"maxLength": 500
},
"tags": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^,^?*()[\\]$]+$"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴dotypos_update_customer(customer_id, first_name, last_name, company_name, email, ...)
WRITE: change fields of one customer; only the fields you pass are changed. The record is read first and updated with its ETag, so a concurrent change makes the update fail instead of overwriting it. PATCH /clouds/{cloud}/customers/{id}.
Input Schema
{
"type": "object",
"properties": {
"customer_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"first_name": {
"type": "string",
"maxLength": 180
},
"last_name": {
"type": "string",
"maxLength": 180
},
"company_name": {
"type": "string",
"maxLength": 180
},
"email": {
"type": "string",
"maxLength": 100
},
"phone": {
"type": "string",
"maxLength": 20
},
"address_line1": {
"type": "string",
"maxLength": 180
},
"city": {
"type": "string",
"maxLength": 255
},
"zip": {
"type": "string",
"maxLength": 20
},
"note": {
"type": "string",
"maxLength": 500
},
"internal_note": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"customer_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴dotypos_update_product(product_id, name, price_without_vat, description, displayed)
WRITE: change the name, net price, description or visibility of one product; only the fields you pass are changed. The price with VAT is derived by Dotypos from the net price and the product's VAT. The record is read first and updated with its ETag, so a concurrent change makes the update fail. PATCH /clouds/{cloud}/products/{id}.
Input Schema
{
"type": "object",
"properties": {
"product_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?\\d{1,19}$"
}
],
"description": "Numeric id (as in the replies; default items of a new cloud have negative ids such as -301)."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 400
},
"price_without_vat": {
"description": "New net price without VAT, in the cloud's currency.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"description": {
"type": "string",
"maxLength": 1000
},
"displayed": {
"description": "Show (true) or hide (false) the product at the POS.",
"type": "boolean"
}
},
"required": [
"product_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence