Hiboutik MCP by usefulapi

Read Hiboutik products, stock, customers, sales and turnover; edit customers and sale comments.

사용해야 할까요

품질 및 안전성

A
설명 품질
90%
스키마 완전성
85%
이름 품질
79%
오염 위험
100%
권한 일치
100%
프로토콜 준수
100%

발견 사항 (2)

  • LOWTool 'hiboutik_search_products_by_name' name length outside 3-30 rangehiboutik_search_products_by_name에서
  • LOWTool 'hiboutik_find_product_by_barcode' name length outside 3-30 rangehiboutik_find_product_by_barcode에서

도구 정의와 프로토콜 준수에 대한 자동 분석을 기반으로 합니다.

컨텍스트 비용

~7,090토큰 (도구 정의)
~1.8 KB일반적인 응답 크기
상당한 주의 영향 (128k 컨텍스트의 5.54%)

이는 서버의 도구가 모델의 컨텍스트에 로드될 때마다 소비되는 대략적인 토큰 수입니다. 수치가 높을수록 다른 작업에 사용할 수 있는 주의가 줄어듭니다.

설치

원클릭 설치

`claude_desktop_config.json` 파일에 다음을 추가하세요:

{
  "mcpServers": {
    "hiboutik": {
      "url": "https://hiboutik.usefulapi.io/mcp"
    }
  }
}

원격 엔드포인트

https://hiboutik.usefulapi.io/mcpstreamable-http

할 수 있는 일

도구 목록

도구 (31)

🟢 읽기 전용🟡 쓰기🔴 삭제⚪ 알 수 없음
🟢hiboutik_list_stores

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.

입력 스키마

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_warehouses

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

입력 스키마

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_users

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.

입력 스키마

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_taxes

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

입력 스키마

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_payment_types(store_id)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Store id (hiboutik_list_stores)."
    }
  },
  "required": [
    "store_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_categories(page, limit, offset, order_by, sort)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    },
    "order_by": {
      "description": "Field to order by, e.g. product_id or product_model.",
      "type": "string",
      "pattern": "^[A-Za-z_]{1,60}$"
    },
    "sort": {
      "description": "Sort direction: asc or desc.",
      "type": "string",
      "pattern": "^(asc|desc)$"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_brands(page, limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_suppliers(limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_size_types

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

입력 스키마

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_sizes(size_type_id)

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}.

입력 스키마

{
  "type": "object",
  "properties": {
    "size_type_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Variant type id (hiboutik_list_size_types)."
    }
  },
  "required": [
    "size_type_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_products(page, limit, offset, order_by, sort)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    },
    "order_by": {
      "description": "Field to order by, e.g. product_id or product_model.",
      "type": "string",
      "pattern": "^[A-Za-z_]{1,60}$"
    },
    "sort": {
      "description": "Sort direction: asc or desc.",
      "type": "string",
      "pattern": "^(asc|desc)$"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_get_product(product_id)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Product id."
    }
  },
  "required": [
    "product_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_search_products_by_name(q, page, limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Text to look for in the product name."
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "required": [
    "q"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_find_product_by_barcode(barcode)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "barcode": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Product barcode."
    }
  },
  "required": [
    "barcode"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_search_products(product_model, product_category, product_brand, product_supplier, product_arch, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "product_model": {
      "description": "Model (name) to match.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "product_category": {
      "description": "Only products of this category id (hiboutik_list_categories).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_brand": {
      "description": "Only products of this brand id (hiboutik_list_brands).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_supplier": {
      "description": "Only products of this supplier id (hiboutik_list_suppliers).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_arch": {
      "description": "1 = archived products only, 0 = active only.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "product_supplier_reference": {
      "description": "Supplier reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "products_ref_ext": {
      "description": "External reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    },
    "order_by": {
      "description": "Field to order by, e.g. product_id or product_model.",
      "type": "string",
      "pattern": "^[A-Za-z_]{1,60}$"
    },
    "sort": {
      "description": "Sort direction: asc or desc.",
      "type": "string",
      "pattern": "^(asc|desc)$"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_stock_all_warehouses(product_category, product_brand, product_supplier, product_arch, product_supplier_reference, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "product_category": {
      "description": "Only products of this category id (hiboutik_list_categories).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_brand": {
      "description": "Only products of this brand id (hiboutik_list_brands).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_supplier": {
      "description": "Only products of this supplier id (hiboutik_list_suppliers).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_arch": {
      "description": "1 = archived products only, 0 = active only.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "product_supplier_reference": {
      "description": "Supplier reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "products_ref_ext": {
      "description": "External reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_stock_by_warehouse(warehouse_id, product_category, product_brand, product_supplier, product_arch, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "warehouse_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Warehouse id (hiboutik_list_warehouses)."
    },
    "product_category": {
      "description": "Only products of this category id (hiboutik_list_categories).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_brand": {
      "description": "Only products of this brand id (hiboutik_list_brands).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_supplier": {
      "description": "Only products of this supplier id (hiboutik_list_suppliers).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "product_arch": {
      "description": "1 = archived products only, 0 = active only.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "product_supplier_reference": {
      "description": "Supplier reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "products_ref_ext": {
      "description": "External reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000
    }
  },
  "required": [
    "warehouse_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_stock_by_product(product_id)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Product id."
    }
  },
  "required": [
    "product_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_stock_orders(page, limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_customers(page, limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_search_customers(last_name, first_name, email, phone, vat, ...)

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/.

입력 스키마

{
  "type": "object",
  "properties": {
    "last_name": {
      "description": "Last name.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "first_name": {
      "description": "First name.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "email": {
      "description": "Email address.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "phone": {
      "description": "Phone number.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "vat": {
      "description": "VAT number.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "country": {
      "description": "Country code (ISO 3166 alpha-3, e.g. FRA).",
      "type": "string",
      "minLength": 2,
      "maxLength": 3
    },
    "customers_code": {
      "description": "Customer code.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "customers_ref_ext": {
      "description": "External reference.",
      "type": "string",
      "minLength": 3,
      "maxLength": 200
    },
    "loyalty_points": {
      "description": "Loyalty points: a number, or prefixed with > < >= <=.",
      "type": "string",
      "pattern": "^(>=|<=|>|<)?\\d{1,9}$"
    },
    "last_order_date": {
      "description": "Last order date yyyy-mm-dd, optionally prefixed with > < >= <=.",
      "type": "string",
      "pattern": "^(>=|<=|>|<)?\\d{4}-\\d{2}-\\d{2}$"
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_get_customer(customers_id)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "customers_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Customer id."
    }
  },
  "required": [
    "customers_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_customer_sales(customers_id, page, limit, offset)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "customers_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Customer id."
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "required": [
    "customers_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_get_sale(sale_id)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Sale id."
    }
  },
  "required": [
    "sale_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_open_sales(store_id, page, limit, offset, order_by, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Store id."
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    },
    "order_by": {
      "description": "Field to order by, e.g. product_id or product_model.",
      "type": "string",
      "pattern": "^[A-Za-z_]{1,60}$"
    },
    "sort": {
      "description": "Sort direction: asc or desc.",
      "type": "string",
      "pattern": "^(asc|desc)$"
    }
  },
  "required": [
    "store_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_list_closed_sales(store_id, year, month, day, page, ...)

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}].

입력 스키마

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Store id."
    },
    "year": {
      "type": "integer",
      "minimum": 2000,
      "maximum": 2100,
      "description": "Year, e.g. 2026."
    },
    "month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "description": "Month 1-12."
    },
    "day": {
      "description": "Day of the month 1-31. Omit for the whole month.",
      "type": "integer",
      "minimum": 1,
      "maximum": 31
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "required": [
    "store_id",
    "year",
    "month"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_report_turnover(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}].

입력 스키마

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Store id."
    },
    "year": {
      "type": "integer",
      "minimum": 2000,
      "maximum": 2100,
      "description": "Year, e.g. 2026."
    },
    "month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "description": "Month 1-12."
    },
    "day": {
      "description": "Day of the month 1-31. Omit for the whole month.",
      "type": "integer",
      "minimum": 1,
      "maximum": 31
    }
  },
  "required": [
    "store_id",
    "year",
    "month"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢hiboutik_report_products_sold(store_id, year, month, page, limit, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Store id."
    },
    "year": {
      "type": "integer",
      "minimum": 2000,
      "maximum": 2100,
      "description": "Year, e.g. 2026."
    },
    "month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "description": "Month 1-12."
    },
    "page": {
      "description": "Vendor page number from 1 (default 1); a page holds up to 250 rows. Continue with the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Rows returned per call, 1-250 (default 50). Large replies are cut by the server, so keep it small.",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "offset": {
      "description": "Row to start from inside the vendor page (default 0). Continue with the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 249
    }
  },
  "required": [
    "store_id",
    "year",
    "month"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟡hiboutik_create_customer(customers_last_name, customers_first_name, customers_company, customers_email, customers_phone_number, ...)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "customers_last_name": {
      "description": "Last name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "customers_first_name": {
      "description": "First name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "customers_company": {
      "description": "Company.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "customers_email": {
      "description": "Email address.",
      "type": "string",
      "minLength": 3,
      "maxLength": 254
    },
    "customers_phone_number": {
      "description": "Phone number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "customers_country": {
      "description": "Country code (ISO alpha-3, e.g. FRA).",
      "type": "string",
      "minLength": 2,
      "maxLength": 3
    },
    "customers_tax_number": {
      "description": "Tax / VAT number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "customers_birth_date": {
      "description": "Birth date yyyy-mm-dd.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "customers_ref_ext": {
      "description": "External reference.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "customers_misc": {
      "description": "Free-text note.",
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴hiboutik_update_customer(customers_id, customers_attribute, new_value)

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}/.

입력 스키마

{
  "type": "object",
  "properties": {
    "customers_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Customer id."
    },
    "customers_attribute": {
      "type": "string",
      "enum": [
        "gender",
        "last_name",
        "first_name",
        "email",
        "company",
        "phone",
        "vat",
        "country",
        "date_of_birth",
        "customers_code",
        "comments",
        "validity",
        "customers_ref_ext",
        "customers_misc"
      ],
      "description": "The attribute to change."
    },
    "new_value": {
      "type": "string",
      "maxLength": 500,
      "description": "The new value (for gender: 0, 1 or 2; for dates: yyyy-mm-dd). An empty string clears the attribute."
    }
  },
  "required": [
    "customers_id",
    "customers_attribute",
    "new_value"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴hiboutik_set_sale_comment(sale_id, comments)

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

입력 스키마

{
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Sale id."
    },
    "comments": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The comment text."
    }
  },
  "required": [
    "sale_id",
    "comments"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

커뮤니티

이 서버 평가하기

증거

최근 관측

검증됨버전이 기록되지 않음도구 31개