For the complete documentation index, see llms.txt. This page is also available as Markdown.

概要

LMile は、マルチストアの商品・在庫・受注データを集約し、受注ルーティングから出荷実行までを担うプラットフォームです。外部アプリが API でデータを push し、LMile が SoT(source of truth)を維持します。

データの流れ

外部アプリ ──── push API ────▶ LMile ──── ルーティング / 出荷 ────▶ WMS / キャリア
(EC・POS・基幹)                  │
                                ├──▶ webhook 通知(在庫変動・出荷ステータス)──▶ 外部アプリ
                                └──▶ LMile AI(売上・在庫の自然言語分析)

すべてのエンドポイントは https://api.lmile.io でホストされ、x-ingest-secret ヘッダーで認証します(認証)。shop はリクエストボディに含めます(キーが 1 つのアカウントにひも付いていれば省略できます)。

API 一覧

Ingestion API — データ取込

Method
Path
用途

POST

/api/ingest/products

商品マスター一括 upsert

GET

付帯サービスにした商品の一覧

POST

在庫スナップショット(絶対値)一括投入

POST

販売可能在庫のリアルタイム更新(absolute / delta)

POST

外部倉庫の拠点で、販売チャネルでの販売可能数を伝える(0 以下なら販売可能在庫を 0 に)

POST

/api/ingest/mfc-inventory

出荷元ロケーションへ棚付き在庫を入庫(棚別 + barcode 集約。mode=absolute 絶対値 / adjust 差分)

POST

/api/inventory/hold

在庫の一部を参照 ID ごとに取り置き、販売可能在庫から外す(在庫の取込で消えない・Shopify にも反映)

POST

/api/inventory/release

参照 ID の取り置きをまとめて解除し、販売可能在庫に戻す

POST

受注明細一括 upsert(per-unit)

POST

店舗→EC送客(共有・共有商品・追跡イベント)の batch 投入(冪等 upsert・PII は hash 化)

Routing API — 受注ルーティング

Method
Path
用途

POST

/api/routing/orders

受注ルーティング(出荷元判定 → 出荷指示生成・dispatch)

POST

取込元で引き渡しが終わっている注文(店頭販売など)を、その拠点から出荷済みで登録

POST

/api/routing/update

注文更新(全量再ルーティング)

POST

/api/routing/cancel

注文取消

POST

WMS 出荷指示の記録 + 倉庫への送信(shadow / live)

POST

店舗の棚卸で出た差分を、外部システムに当てるコネクタが取りに来る

POST

当てた結果を返す(applied / failed / unknown)

Fulfillment API — 出荷実行

Method
Path
用途

POST

/api/routing/fulfillment

出荷ステータス遷移・出荷ラベル

POST

/api/routing/secure

単位の在庫確保

POST

/api/routing/picking-list

ピッキングリスト生成(1 注文・JSON / PDF)

POST

バッチピッキングリスト生成(複数注文・JSON / PDF / CSV)

POST

宛先住所修正

POST

配送ラベル再発行

POST

ラベル手動再印刷

POST

出荷メモ追記

POST

配達希望日・時間帯の設定/変更

POST

出荷配下の全単位を集荷済み(出荷準備中)にする(ラベル発行はオプション)

POST

確保済みの単位を確保前へ戻す

GET

外部フルフィルメント発注に必要な情報の取得(配送先・明細・外部 SKU)

POST

外部発注結果(受理 / 失敗)の書き戻し

GET

受理済み・未出荷の出荷一覧(追跡ポーリング用)

POST

1 出荷を出荷済みに報告(追跡番号の同時確定に対応)

GET

/api/ingest/sku-mappings

外部システム SKU ↔ barcode 対応表の取得

GET

/api/ingest/products

商品マスターを barcode で引く(登録済みかの確認・SKU の取得)

POST

/api/routing/pickup

キャリア集荷(オンコールピックアップ)の依頼

POST

集荷依頼の取消

Oversell API — 売越し対応

Method
Path
用途

POST

/api/routing/oversell

売越しマーク

POST

/api/routing/reallocate

別メンバーへ再引き当て

POST

売越しケース管理(8 ステップ)

POST

出荷元変更(返送 → 別拠点出荷)

Transfer API — 倉庫間移動バルク

Method
Path
用途

POST

バルク(箱)作成

GET

バルク一覧(status / 送り側 / 受け側 + 単位数)

POST

ユニットQR スキャンで移動対象を追加

POST

誤スキャン取消(open 中のみ)

POST

発送確定(内容物リスト PDF + 一括 return_in_transit)

POST

宛先側の入荷照合(1 点ずつスキャン受領)

POST

出荷元への入荷転送を登録(転送便の追跡番号)

Transfer API は operator JWT(Authorization: Bearer)認証です(認証)。

Stock Transfer API — 拠点間在庫移動

拠点間で商品を 数量ベースで移動します(作成 →(承認)→ 出庫 → 入庫)。実数量が動くのは自社在庫(MFC 自己在庫)の拠点だけです。返送バルク(上記 Transfer API・注文 unit の返送)とは別機能です。

Method
Path
用途

POST

移動を作成(承認なし)

POST

承認が要る移動として作成(出庫依頼)

POST

配送ラベルを発行できる出庫元・入庫先

POST

明細の追加・数量置換(出庫前)

POST

明細の削除(出庫前)

POST

ヘッダ・明細の更新

POST

承認(既定で出庫まで実行)

POST

承認却下

POST

出庫確定(自社在庫は棚 −)

POST

発行済みの配送ラベルを再印刷

POST

入庫検品(自社在庫は棚 +)

POST

業務取消(出庫済みは棚復元)

POST

出庫前の移動を物理削除

GET

移動の一覧

GET

移動 1 件(ヘッダ + 明細)

GET

移動 1 件の明細

POST

出庫内容の修正依頼(起票 / /complete / /delete)

GET

修正依頼の一覧(単体は /modification-request)

Stock Transfer API は x-ingest-secret ヘッダー または operator JWT(Authorization: Bearer)認証です(書き込みは shop をボディ、読み取りは shop をクエリに含めます)。

Customer Orders API — 顧客注文照会

Method
Path
用途

POST

/api/customer-orders/list

顧客メールアドレス → 注文一覧(集約ステータス付き)

POST

注文詳細(明細 / 金額 / 配送先 / 出荷元別ステータス・追跡番号)

Shelf API — 棚(シェルフ)運用

Method
Path
用途

POST

/api/shelf/link

追跡番号 + 棚コードで棚に shipment を割り当て

POST

棚への入庫(qty 増)

POST

/api/shelf/inventory/pick

棚からのピック(qty 減)

POST

/api/shelf/inventory/move

同じ拠点内で棚→棚へ動かす / barcode を付け替える

POST

1 セルの数量を絶対値で直す(0 で棚から削除)

POST

同じ棚・同じ商品の数を商品状態(良品 ⇄ 良品以外)の間で動かす

POST

/api/shelf/master/upsert

棚マスタの登録・区分・有効 / 無効

GET

ユニットQR → ユニット + 棚 + 出荷/注文 + picked 状態

GET

棚コード → アクティブ紐付け shipment + 棚在庫

POST

/api/operator/shelf/pick

ユニットQR スキャンで unit を picked / unpick

/api/operator/* はピッキングアプリ向けで operator JWT(Authorization: Bearer)認証です(認証)。

Operator API — 倉庫スタッフ(picking-ios)

Method
Path
用途

POST

/api/operator/login

ログイン(email+password → JWT 発行)

POST

Google サインイン(Google ID token → JWT 発行)

POST

/api/operator/login/apple

Apple サインイン(Apple identity token → JWT 発行)

POST

確認コードをメールで送る

POST

確認コードでログイン(email+code → JWT 発行)

POST

/api/operator/refresh

refresh token で JWT 更新

GET

/api/operator/me

ログイン中スタッフの id / email / 束縛 shop

POST

本人アカウントを即時削除(退会。デモは保護)

GET

/api/operator/locations

アクティブな拠点一覧(店舗(location)選択用・type / memberOnly 絞り込み)

GET

追跡番号 → shipment + 注文 + 明細(棚番号付き)+ 配送先 + 状態

GET

バーコード → 商品の基本情報

GET

追跡番号 / ステータスで売越しケースを検索

GET

/api/operator/shipments

出荷作業キュー一覧(location × status × 期間 + 件数サマリ)

GET

引当不能(no_stock)注文の一覧

GET

出荷元変更(拠点間移動)ケースの一覧(移動キュー / 入荷待ちキュー)

POST

/api/operator/secure-scan

ユニットQR スキャンで 1 unit 確保(全確保でヘッダ secured + ラベル生成)

POST

追跡番号スキャンで shipment 配下の allocated ユニットを一括確保(全確保でヘッダ secured・picked 済も含む)

POST

棚卸セッションを開く(拠点ごとに 1 つ。MFC は棚ごと・店舗は拠点全体)

POST

棚を数え始める(締めた棚なら再計数)

POST

数えた数をまとめて送って棚を締める(帳簿数を固定・差異を返す)

POST

提出(店舗は商品ごとの帳簿数をここで固定)/ 取消 / 提出の取り下げ

POST

承認して反映(MFC は棚へ・店舗は外部システムへの調整へ。商品単位の部分反映)

GET

拠点で進行中の棚卸と棚の進捗・商品状態の一覧

/api/operator/* は operator JWT(Authorization: Bearer)認証です(認証)。棚運用(/api/operator/shelf/*)は Shelf Lookup を参照してください。

Configuration — 設定

Method
Path
用途

POST

出荷元 ↔ 在庫ロケーション マッピング設定

POST

マッピング解除

GET

マッピング一覧

POST

WMS 連携(dispatch)設定

POST

/api/routing/star-printer

ロケーション ↔ Star プリンター device ID 設定

POST

プリンター設定解除

GET

/api/routing/star-printer

プリンター設定一覧

Webhooks — 通知設定

Method
Path
用途

POST

在庫変動 webhook 設定

POST

引き当て暫定確定 webhook 設定

POST

出荷ステータス webhook 設定

POST

売越しケース受付完了 webhook 設定

POST

受注情報更新(住所修正など)webhook 設定

Apps — ホスト型ミニアプリ

イベント駆動の自動処理(検知 → 判断 → API write-back)をコードで実装し、LMile 上でホストできます(プレビュー・公開エンドポイントなし)。Apps を参照してください。

次のステップ

  1. 認証で API キーとヘッダーを確認する

  2. クイックスタートで商品と在庫を登録する

  3. Data Model でテーブル構造を理解する

Last updated

Was this helpful?