Hiboutik MCP by usefulapi

List the shops (stores) of the account: id, name, warehouse id, currency, time zone, address. Use store ids for sales, payment types and reports. GET /stores.

无需输入参数。

List warehouses (stock locations) with id and name. Use the ids for stock levels. GET /warehouses.

无需输入参数。

List the Hiboutik users (staff, sales vendors): id, name, email, access level. The id is the vendor_id of a sale. Passwords and keys are never returned. GET /users.

无需输入参数。

List the tax (VAT) rates with id, name, value and default flag. GET /taxes.

无需输入参数。

List the payment types enabled in a store (cash, card, cheque...) with currency and flags. GET /payment_types/{store_id}/.

List product categories (newest id first) with parent id and flags. GET /categories.

List product brands (newest id first). GET /brands.

List the suppliers with id, name and contact details. GET /suppliers/.

List the variant (size) types, such as clothing sizes or colours. Use an id with hiboutik_list_sizes. GET /size_types.

无需输入参数。

List the variants (sizes) of one variant type: size_id and name. The size_id identifies a variant of a product in stock and sales. GET /sizes/{size_type_id}.

List products (default newest id first) with model, barcode, price, supply price, brand, category, supplier and stock management flag. 250 per page. GET /products/.

One product with its full details. GET /products/{product_id}.

Find products whose model (name) matches the text. GET /products/search/name/{q}.

Find the product (and variant) with this barcode. GET /products/search/barcode/{barcode}/.

Search products by model, category, brand, supplier, archived state, supplier or external reference. GET /products/search/.

Available stock per product and variant across warehouses, optionally filtered by category, brand, supplier or archived state. GET /stock_available/all_wh.

Available stock per product and variant in one warehouse, optionally filtered. GET /stock_available/warehouse_id/{warehouse_id}.

Available stock of one product per variant and warehouse, with the inventory alert level. GET /stock_available/product_id/{product_id}.

List the stock orders / goods receipts. GET /inventory_inputs/.

List customers (newest id first) with name, email, phone, country, loyalty points and store credit. Personal data of the shop's customers. GET /customers/.

Search customers by last name, first name, email, phone, VAT number, country, customer code or external reference (each text value needs at least 3 characters). Dates: yyyy-mm-dd, or prefix with > < >= <= to compare. GET /customers/search/.

One customer with full details. GET /customer/{customers_id}.

List the sales made to one customer (newest first). GET /customer/{customers_id}/sales/.

One sale with its header, totals, payment and line items. GET /sales/{sale_id}.

List the sales not yet closed in a store (newest first). GET /open_sales/{store_id}.

List the closed (completed) sales of a store for one day, or for a whole month when day is omitted. GET /closed_sales/{store_id}/{year}/{month}[/{day}].

Sales total (turnover) of a store for one day, or per day for a whole month when day is omitted. GET /reports/turnover/{store_id}/{year}/{month}[/{day}].

Products sold in a store during one month: quantities and revenue per product. GET /reports/products/{store_id}/{year}/{month}.

WRITE: create a customer in Hiboutik. Needs at least a last name, first name, company or email. Returns the new customer id. POST /customers/.

WRITE: change ONE attribute of a customer (it overwrites the current value). Attributes: gender (0 unknown, 1 male, 2 female), last_name, first_name, email, company, phone, vat, country, date_of_birth, customers_code, comments, validity, customers_ref_ext, customers_misc. PUT /customer/{customers_id}/.

WRITE: add or replace the comment of a sale (it overwrites any existing comment). POST /sales/comments/.