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

Star Printer — ロケーション プリンター設定

在庫ロケーションに Star プリンターの device ID を紐付けます。ピッキングリスト等の物理印刷で、ロケーションから印刷先プリンターを解決するための設定マスターです。設定・解除・取得を API で行えます。

Base URL https://api.lmile.io · 認証 x-ingest-secret ヘッダー(詳細) · set/detach は shop をボディ、取得はクエリに含めます(省略するとキーのアカウント)

マッピングのキーは (shop, locationId) = 1 ロケーションに紐づくプリンターは 1 台のみ。既に device ID が設定済みのロケーションを set すると、新しい device ID に差し替えられます。

エンドポイント

Method
Path
用途

POST

/api/routing/star-printer

プリンター設定(upsert)

POST

/api/routing/star-printer/detach

プリンター解除(物理削除)

GET

/api/routing/star-printer

設定状況の取得(ラベル付き一覧)


POST /api/routing/star-printer

ロケーション↔Star プリンター device ID のマッピングを upsert します。

リクエスト

POST https://api.lmile.io/api/routing/star-printer
x-ingest-secret: {INGEST_SECRET}
Content-Type: application/json
{
  "shop": "demo-store.myshopify.com",
  "locationId": "11111111-1111-1111-1111-111111111111",
  "deviceId": "00:11:62:1a:2b:3c",
  "isActive": true
}

ボディパラメータ

パラメータ
型
必須
説明

shop

string

店舗ドメイン(省略するとキーのアカウント)

locationId

string (uuid)

✓

紐付ける在庫ロケーション(shop 内に実在すること)

deviceId

string

✓

Star プリンターの device ID(空文字不可)

isActive

boolean

有効フラグ(default true。false で論理無効化)

レスポンス

挙動

  • upsert キー: (shop, locationId)。同じロケーションに別の deviceId を set すると device ID が差し替わる(1 ロケーション 1 プリンター)。

  • isActive: false でマッピングを残したまま無効化。完全に消す場合は detach。


POST /api/routing/star-printer/detach

マッピングを物理削除します(ロケーション基準)。

パラメータ
型
必須
説明

shop

string

店舗ドメイン(省略するとキーのアカウント)

locationId

string (uuid)

✓

解除する在庫ロケーション

レスポンス: { "ok": true, "shop": "...", "locationId": "...", "deleted": 1 }(deleted は削除件数。該当無しは 0)。


GET /api/routing/star-printer

shop(任意でロケーション)の設定状況をラベル付きで取得します。

クエリ
必須
説明

shop

店舗ドメイン(省略するとキーのアカウント)

locationId

指定するとそのロケーションの設定のみに絞り込み

レスポンス


エラー

エンドポイント固有:

Status
条件
レスポンス例

400

必須欠落 / locationId が非 UUID / deviceId 空 / shop クエリ無し

{ "ok": false, "error": "deviceId required" }

422

location が shop 内に存在しない

{ "ok": false, "error_kind": "location_unresolved", "error": "location not found for shop" }

共通エラー(401 / 400 / 403 / 405 / 500 / 503)は Error Codes を参照。

データモデル

  • sot.lm_location_star_printers — 在庫ロケーション → Star プリンター device ID 紐付け(UNIQUE shop + location_id で 1 ロケーション 1 プリンターを強制)

  • 読み取り view(管理 UI 用): public.lm_v_location_star_printers

Last updated

Was this helpful?