カスタムストアAPI / 対応機能の宣言(capabilities)

カスタムストアAPI  /  対応機能の宣言

対応機能の宣言(capabilities)

ストアが対応している機能をLilloに知らせます。[接続テスト]がこのエンドポイントを呼び出し、Lilloはここで有効にした機能だけをエージェントと自動化に表示します。

GET/v1/capabilities
リクエスト
curl "https://api.mall.example.com/v1/capabilities" \
  -H "Authorization: Bearer $LILLO_API_KEY" \
  -H "X-Lillo-Api-Version: 2026-11-01"
レスポンス — 200 OK
{
  "data": {
    "api_version": "2026-11-01",
    "spec_version": "1.1",
    "orders": true,
    "shipments_endpoint": false,
    "members": true,
    "products": true,
    "claims": ["cancel", "return", "exchange"],
    "receiver_update": true,
    "memos": true,
    "coupons": true,
    "coupon_issue": true,
    "categories": true,
    "catalog": true,
    "pagination": "cursor",
    "webhooks": []
  }
}

レスポンスフィールド

api_versionstring必須

2026-11-01

spec_versionstring任意

実装した仕様のバージョン。v1.1の機能を有効にした場合は"1.1"

ordersboolean必須

注文照会。常にtrue

shipments_endpointboolean任意

配送照会エンドポイントへの対応

membersboolean任意

会員照会

productsboolean任意

商品の検索・詳細

claimsstring[]任意

v1.1の受付種別 — cancel・return・exchangeのうち対応しているもの

receiver_updateboolean任意

v1.1 配送先の変更

memosboolean任意

v1.1 注文メモ

couponsboolean任意

v1.1 クーポン一覧・会員の保有クーポン

coupon_issueboolean任意

v1.1 クーポン発行

categoriesboolean任意

v1.1 カテゴリ一覧

catalogboolean任意

v1.1 カタログ全件一覧(ナレッジの「商品」フォルダを同期)

paginationstring任意

"cursor"(デフォルト)または"offset"(Cafe24互換)

webhooksstring[]任意

準備中。現在は[]

動作ルール

  • 指定のないキーは未対応(false)とみなします。
  • このエンドポイントが404の場合は「注文照会のみ対応」とみなし、接続は成功として扱います。
  • 機能を有効にしたのに該当エンドポイントが404の場合、その機能は「ストア未対応」として失敗扱いになり、担当者に表示されます。
  • 機能を変更したら、コンソールで[接続テスト]をもう一度押してください。そのときにcapabilitiesを読み直します。
対応機能の宣言(capabilities) · 開発者ドキュメント | Lillo