1. ecforce faq
  2. お知らせ
  3. お知らせ
お知らせ

[ecforce API] 内部ライブラリアップデートに伴う一部検索/詳細APIの挙動変更について

ecforce で提供しております外部サービスAPI連携機能（オプション機能）について、2026年5月のecforceリリースにて内部ライブラリのアップデートを予定しております。
本アップデートに伴い、一部検索/詳細APIのレスポンスが変更となります。

 本機能はオプション機能となります。　お問い合わせの際は以下のフォームよりお問い合わせください。

>> お問い合わせフォーム

オプション費用については、ecforce管理画面内の「アプリ管理 > オプション申込」よりご確認ください。

アップデート内容について

以下の検索／詳細API（※通常版のみ）において、include クエリパラメータをネスト指定（例：orders.billing_address）した場合、これまでレスポンスの included に、指定していない関連データまで意図せず含まれて返却される事象がありました。

本アップデートにより挙動が改善され、APIの取得結果（レスポンスの included）には、取得時に指定したデータ（リクエストの include パラメータ）のみが正しく返却されるようになります（意図しない関連データは混入しません）。

対象の検索/詳細API（※通常版のみ。軽量版は対象外）

Admin API v2 顧客検索API
Admin API v2 顧客詳細API
Admin API v2 受注検索API
Admin API v2 受注詳細API
Admin API v2 定期受注検索API
Admin API v2 定期受注詳細API
Customer API v2 顧客詳細API
Customer API v2 定期受注検索API
Customer API v2 定期受注詳細API

もし、ecforce APIを利用するアプリケーション側で、意図せず混入していた関連データを参照している処理がある場合、本アップデート後は当該データが返却されなくなります。必要に応じて、参照したい関連データを include に明示的に指定するよう改修をお願いいたします。

なお、以下の事業者様には既に弊社より対応内容について連絡済みとなります。各事業者様には期日までに必要な対応を実施いただくこととなりますので、ショップ様でご対応いただく事項はございません。

弊社より連絡済みの事業者様一覧
  • ECロボ/リピロボ/AiR Logi（株式会社コマースロボティクス様）
  • クラウドロジ（株式会社スタークス様）
  • はぴロジ（株式会社はぴロジ様）
  • LOGILESS（株式会社ロジレス様）
  • リピートライン（株式会社スタークス様）
  • カスタマーリングス（株式会社プラスアルファ・コンサルティング様）
  • b→dash（株式会社データX様）
  • LTV-Lab（株式会社LTV-X様）
  • LIneON（株式会社ライフェックス様）
  • U-KOMI（株式会社サブスパイア様）
  • ネクストエンジン（NE株式会社様）
  • AnyGift（AnyReach株式会社様）
  • 売れるD2Cつくーる（売れるネット広告社株式会社様）
  • Yoii Fuel（株式会社Yoii様）
  • ヱヂレコ（ヱヂリウム株式会社様）
  • うちでのこづち（株式会社E-Grant様）
  • Letro Connect （アライドアーキテクツ株式会社様）
  • O-PLUX（かっこ株式会社様）
  • Spider AF（株式会社Spider Labs様）
  • Re:lation（株式会社インゲージ様）
  • Recustomer（Recustomer株式会社様）
  • 共栄物流サービス（株式会社共栄物流様）※2026/4/7 追加
  • LOGIZO（株式会社ネクストロジ様）※2026/4/7 追加
  • ロジザード（株式会社ロジザード様）※2026/4/7 追加
  • STOCKCREW（株式会社STOCKCREW様）※2026/4/7 追加
  • アクションリンク（株式会社アドブレイブ様）※2026/4/7 追加
  • ECAI（株式会社バイモソフト様）※2026/4/7 追加
  • CallCall-IVR（ルーシッド株式会社様）※2026/4/7 追加
  • オープンロジ（株式会社オープンロジ様）※2026/4/7 追加
  • TēPs（テープス株式会社様）※2026/4/7 追加
  • Yoom（Yoom株式会社様）※2026/4/7 追加
  • 株式会社アーツ様 ※2026/4/7 追加
  • 株式会社キレイコム様 ※2026/4/7 追加

ショップ様にて実施いただく内容

上記「弊社より連絡済みの事業者様一覧」に記載のサービスのみをご利用いただいている場合は、ショップ様にてご対応いただく事項はございません。

上記以外のサービスをご利用の場合、もしくは貴社独自でAPIへアクセスするサービス等を開発している場合は、関係者に以下内容をお伝えいただき、2026年5月のecforceリリースまでにご対応いただきますよう手配をお願いいたします。

■対象の検索/詳細API（※通常版のみ。軽量版は対象外）
Admin API v2 顧客検索API
Admin API v2 顧客詳細API
Admin API v2 受注検索API
Admin API v2 受注詳細API
Admin API v2 定期受注検索API
Admin API v2 定期受注詳細API
Customer API v2 顧客詳細API
Customer API v2 定期受注検索API
Customer API v2 定期受注詳細API

■概要
「対象の検索/詳細API」について、includeパラメータをネスト指定（例：orders.billing_address）した場合、
これまでレスポンスのincludedに、指定していない関連データまで意図せず含まれて返却される事象がありました。

2026年5月のecforceリリースにより挙動が改善され、APIの取得結果（レスポンスの included）には、取得時に指定したデータ（リクエストの include パラメータ）のみが正しく返却されるようになります（意図しない関連データは混入しません）。
■対応内容
ecforce APIを利用するアプリケーション側で、意図せず混入していた関連データを参照している処理がある場合、
本アップデート後は当該データが返却されなくなります。

以下「具体的な影響一覧」をご確認いただき、必要に応じて、参照したい関連データをincludeに明示的に指定するよう改修をお願いいたします。

■具体的な影響一覧
①Admin API v2 顧客検索/詳細API、Customer API v2 顧客詳細API
・include: orders.billing_address
 → これまでincludedに混入していたデータ（今後は返りません）：customer.billing_address
・include: orders.notes
 → これまでincludedに混入していたデータ（今後は返りません）：customer.notes
・include: subs_orders.notes
 → これまでincludedに混入していたデータ（今後は返りません）：customer.notes

②Admin API v2 受注検索/詳細API
・include: customer.billing_address
 → これまでincludedに混入していたデータ（今後は返りません）：order.billing_address
・include: customer.notes
 → これまでincludedに混入していたデータ（今後は返りません）：order.notes
・include: subs_order.notes
 → これまでincludedに混入していたデータ（今後は返りません）：order.notes
・include: subs_order.order_items
 → これまでincludedに混入していたデータ（今後は返りません）：order.order_items


③Admin API v2 定期受注検索/詳細API、Customer API v2 定期受注検索/詳細API
・include: customer.notes
 → これまでincludedに混入していたデータ（今後は返りません）：subs_order.notes
・include: orders.notes
 → これまでincludedに混入していたデータ（今後は返りません）：subs_order.notes
・include: orders.order_items
 → これまでincludedに混入していたデータ（今後は返りません）：subs_order.order_items

※例
Admin API v2 顧客検索APIで、以下を指定した場合
/api/v2/admin/customers.json?include=orders.billing_address

・これまで：orders / orders.billing_addressに加え、customer.billing_addressがincludedに含まれていました。
・今後：orders / orders.billing_address のみとなり、customer.billing_addressは含まれません。

この記事の目次

このセクションの記事

お知らせ

  • もっと見る