Lillo
開発者ドキュメントユーザーガイド
カスタムストアAPI / カスタムストアAPIの概要

カスタムストアAPI  /  概要

カスタムストアAPIの概要

自社開発のストアでも、この仕様どおりにAPIを公開すれば、LIAが注文・配送・会員・商品を直接確認してお客様に回答します。LilloがストアのAPIを呼び出す方式（pull）なので、ストアからLilloへ別途送るものはありません。

フィールド名はCafe24 Admin APIと同じです（snake_case）。Cafe24のレスポンスを作ったことがあれば、同じ名前で返してください。Lillo独自のフィールドは「拡張」と表記しています。

できること

バージョン使える機能実装
v1.0注文・配送の照会、会員の照会、商品の検索・詳細注文照会のみ必須
v1.1キャンセル・返品・交換の受付、配送先の変更、注文メモ、クーポンの照会・発行、カテゴリ、カタログ同期すべて任意

お金や顧客情報が変わる書き込みは、担当者が承認した後にのみ呼び出します。返金の実行は呼び出しません。

クイックスタート

  1. 1

    APIキーを発行

    コンソールの［設定］>［コネクター］>［カスタムコマース］でAPIのベースURL（例：https://api.mall.example.com）を保存し、APIキーを発行します。［切り替え］を押すと、そのキーが使用中のキーになります。キーはストアのサーバーにのみ保管してください。

  2. 2

    エンドポイントを実装

    最低限、GET /v1/ordersとGET /v1/orders/{order_id}を実装します。GET /v1/capabilitiesで対応機能を知らせると、Lilloはその機能だけを使います。

  3. 3

    コンソールで接続

    同じ画面で［接続テスト］を押します。LilloがGET /v1/capabilitiesを呼び出して接続を確認し、合格するとすぐに相談で使われます。

認証

Lilloはすべてのリクエストに、発行したAPIキーをBearerトークンとして付けます。キーがない、または誤っている場合は401を返してください。

リクエスト例 — 認証ヘッダー
curl "https://api.mall.example.com/v1/capabilities" \
  -H "Authorization: Bearer $LILLO_API_KEY" \
  -H "X-Lillo-Api-Version: 2026-11-01"

Authorizationstring必須

Bearer <APIキー>。キーは定数時間比較（timingSafeEqual、hash_equals）で照合してください

X-Lillo-Api-Versionstring必須

常に2026-11-01

X-Lillo-Request-Idstring任意

リクエストの追跡ID。ある場合のみ付きます。ログに残しておくと、問い合わせ時の確認が早くなります

Idempotency-Keystring条件付き

書き込み（v1.1）リクエストにのみ付きます。最大64文字

キーの管理

APIキーはログに残さないでください。交換はコンソールで「発行 → 切り替え」の2ステップで行います。切り替えるまでは以前のキーも有効です。

共通ルール

項目ルール
ベースURLコンソールに保存したAPIのベースURL + /v1/...
プロトコルHTTPSのみ。Lilloはリダイレクトに従いません
レスポンス形式単件は{ "data": {...} }、一覧は{ "data": [...], "meta": { "next_cursor": ... } }
ID文字列（product_noも"77"）
日時ISO 8601＋タイムゾーン（2026-11-10T21:14:03+09:00）
金額10進数の文字列。オブジェクトごとにcurrencyを1つ（省略時はKRW）
真偽値Cafe24と同じく"T" / "F"
電話番号Lilloは数字のみを送ります（01012345678）
タイムアウト8秒。p95で1秒以内が目標です
レート制限キーごとに毎秒10回以上を推奨します。超えた場合は429

APIリファレンス

バージョン

このドキュメントはAPIバージョン2026-11-01、仕様v1.1を対象としています。「準備中」の項目は、まだLilloでは使用していません。変更点は変更履歴でご確認ください。

前へコマース連携次へ対応機能の宣言
カスタムストアAPIの概要 · 開発者ドキュメント | Lillo