いつもロジクラをご利用いただき、誠にありがとうございます。
このたび、ロジクラの v1 Public API（現在提供中のAPI） に下記の変更を予定しておりますのでご案内いたします。
今回のリリースでは、v1 Public API に以下2点の変更を予定しています。
変更内容 | 区分 | 既存連携への影響 |
|---|---|---|
タグ機能・入荷/出荷理由( | 新規追加 | 原則なし |
ロット番号( | 挙動変更 | ご利用方法によっては修正が必要 |
特に対応要否をご確認いただきたいポイント
ロット管理が「無効」の商品に対して
lot_codeを送信している連携がある場合、リリース前に送信しないよう修正をお願いします(詳細は「3. ロット番号の入力チェック強化」参照)。
2026年9月15日
既存フィールドの仕様変更はなく、レスポンスへの項目追加が中心のため、原則として既存連携への影響はありません。
以下の対象に tags を追加します。
種類
入荷予定・入荷履歴
出荷予定・出荷履歴
商品マスター(
variants配下)在庫(
product_variant配下)
tags はタグ名の文字列配列です。タグが無い場合は空配列を返します。
対象:種類 / 入荷予定 / 出荷予定
項目 | 内容 |
|---|---|
上限 | 一度に20件まで |
タグ無し | null または空配列 |
更新時・省略 | 現在のタグを保持 |
更新時・ | 全解除 |
更新時・配列指定 | 全置換 |
エラー
上限超過、または配列以外の指定 →
400タグ名が255文字超 →
422
対象 | パラメータ |
|---|---|
種類一覧 | tags[] |
入荷予定一覧 | tags[] |
出荷予定一覧 | tags[](出荷予定自身のタグ)、 |
商品マスター一覧 | variant_tags[](配下の種類のタグで絞り込み。商品マスター自体はタグを持ちません) |
出荷予定一覧で両方指定した場合は、双方の条件を満たすものを返します。
共通仕様:部分一致・大文字小文字を無視・複数指定はOR・一度に20件まで
候補表示向け・readスコープ・返却はタグ名のみ。
メソッド | パス | 備考 |
|---|---|---|
GET | /api/v1/product_variants/tag_names | - |
GET | /api/v1/receiving_schedules/tag_names | 作業中の入荷予定が対象(確定済みに残るタグは含まない) |
GET | /api/v1/shipping_schedules/tag_names | 未完了の出荷予定が対象(出荷完了分に残るタグは含まない) |
一覧・詳細レスポンスに
lot_managementを追加します。作成・更新リクエストで指定できます。
作成時に省略 → 「無効」
更新時に省略 → 現在値を保持
無効→有効への変更は可能ですが、有効→無効への変更はできません(
422)。
入荷・出荷の「理由区分」をAPIから取得・指定できるようになります。新規追加の任意項目で、未指定の場合は従来どおりの区分(入荷=仕入/出荷=販売) になるため、原則として既存連携への影響はありません。
区分 | 対象 | 値 |
|---|---|---|
入荷 | 入荷予定・入荷履歴 | purchase(仕入)/ |
出荷 | 出荷予定・出荷履歴 | sales(販売)/ |
stock_transfer(拠点間移動)は在庫移動機能が設定する値です。リクエストで指定するための値ではありません。
区分 | 指定できる値(日本語表記も可) |
|---|---|
入荷 | purchase / |
出荷 | sales / |
省略時の挙動
ケース | 挙動 |
|---|---|
予定の作成 | 既定値(入荷= |
予定の更新 | 現在値を保持 |
履歴の作成 | 省略・ |
エラー
指定できない値、または
stock_transferの指定 →422(予定の作成・更新ではnull・空文字も422)文字列以外の指定 →
400
表記ゆれの吸収
大文字小文字・前後の空白は無視します。
ただし出荷は、全角英数・単語間の空白を受け付けません。
ロット管理が「無効」の商品の明細に、空でない lot_code を指定した場合、今後は 422 エラーになります(従来は登録が受理されていました)。
エンドポイント | 従来 | 変更後 |
|---|---|---|
POST | 200 | 422 |
POST | 200 | 422 |
PUT | 200 | 422 |
POST | stock_id 指定時200 / | 422に統一 |
null・空文字・lot_codeの省略は、従来どおりご利用いただけます。ロット管理が「有効」な商品への
lot_code指定も、従来どおりです。ロット管理が「無効」の商品に
lot_codeを送信している連携がある場合は、リリース前に「送信しない」よう修正をお願いします。
本変更は、ロット管理対象外の商品在庫が「ロット付き」と「無印」に分かれてしまう不整合を防ぐためのものです。
出荷予定更新(PUT
/api/v1/shipping_schedules/{id})は部分更新ではありません。タグのみを変更する場合も、対象を取得のうえ受注情報と明細を再送してください。(挙動は従来どおりで、今回あらためてドキュメントに明記したものです)
ロット管理「無効」の商品に対して
lot_codeを送信していないか、連携先の実装を確認した出荷予定更新時に部分更新を前提とした実装になっていないか確認した
tags/reason_type/lot_managementの新規項目を利用する予定がある場合、対応方針を検討した