お知らせ

[ecforce API]一部検索系APIの軽量版リリースにつきまして

ecforce で提供しておりますAPI(オプション機能)について、先日一部検索系APIの軽量版をリリースいたしました。
リリースに伴い、2023年4月11日(火)以降に新規構築されるショップ様のAPIのデフォルト挙動が変更となります。

本機能はオプション機能となります。 本機能をご利用いただく際は、以下オプション申し込みフォームからお申し込みください。

>> オプション申し込み

一部検索系APIの軽量版リリースと、2023/4/11以降に新規構築されるショップのデフォルト挙動変更について

先日のリリースで、以下の検索系APIについて、レスポンス軽量版オプションを追加いたしました。

軽量版オプションを追加した検索系API

v2 admin 受注検索API
v2 admin 定期受注検索API
v2 admin 顧客検索API
v2 admin 商品検索API
v2 customer 定期受注検索API

軽量版オプションを有効化すると、通常版と比較してデフォルトでレスポンス項目に含めるデータが少なくなる代わりに、レスポンスの速度が向上します。 (※取得したいパラメータは、明示的に includeパラメータで指定するような仕様となります)

こちらの軽量版オプションについて、2023年4月11日(火)以降に新規発行されるショップ様のecforce環境では、デフォルト挙動が軽量版ON(有効化)の状態となります。
複数環境で上記のAPIいずれかをご利用いただいている場合、環境によってデフォルト挙動が変わる可能性がございますので、通常版と軽量版どちらかで挙動を統一させたい場合、②に記載させていただいた内容の対応をお願いいたします。

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

弊社より連絡済みの事業者様一覧

[WMS/ロジスティクス]

  • 株式会社共栄物流様
  • ECロボ/リピロボ/AiR Logi(株式会社コマースロボティクス様)
  • クラウドロジ(株式会社スタークス様)
  • はぴロジ(株式会社はぴロジ様)
  • LOGIZO(株式会社ネクストロジ様)
  • ロジザード(株式会社ロジザード様)
  • LOGILESS(株式会社ロジレス様)
  • STOCKCREW(株式会社STOCKCREW様)

[CRM]

  • アクションリンク(株式会社アドブレイブ様)
  • うちでのこづち(株式会社E-Grant様)
  • リピートライン(株式会社スタークス様)
  • カスタマーリングス(株式会社プラスアルファ・コンサルティング様)
  • b→dash(株式会社データX様)
  • LTV-Lab(株式会社LTV-X様)
  • LIneON(株式会社ライフェックス様)

[マーケ支援]

  • Letro Connect (アライドアーキテクツ株式会社様)

[ eギフト/ソーシャルギフト]

  • AnyGift(AnyReach株式会社様)

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

上記以外のサービスをご利用の場合、もしくは貴社独自でAPIへアクセスするサービス等を開発している場合に、「対象の検索API」をご利用中でしたら、関係者に以下内容をお伝えいただき、期日までにご対応いただきますよう手配をお願いいたします。

以下がお伝え、ご対応いただく内容となります。

■対象の検索API
v2 admin 受注検索API
v2 admin 定期受注検索API
v2 admin 顧客検索API
v2 admin 商品検索API
v2 customer 定期受注検索API
■概要 先日のリリースで、「対象の検索API」について、レスポンス軽量版オプションを追加いたしました。 軽量版オプションを有効化すると、通常版と比較してデフォルトでレスポンス項目に含めるデータが少なくなる代わりに、レスポンスの速度が向上します。 (※取得したいパラメータは、明示的に includeパラメータで指定するような仕様となります)
こちらの軽量版オプションについて、2023年4月11日(火)以降に新規発行されるショップ様のecforce環境では、デフォルト挙動が軽量版ON(有効化)の状態となります。
複数のショップ様で「対象の検索API」のいずれかをご利用いただいている場合、ショップ様によってデフォルト挙動が変わる可能性がございますので、 通常版と軽量版どちらかで挙動を統一させたい場合は以下「対応内容」に記載の対応をお願いいたします。
■対応内容 「対象の検索API」について、リクエスト時にlighterオプションの明示的な指定をお願いいたします。
lighter=0 : 軽量化OFF 現状と同じレスポンスとなります。 lighter=1 : 軽量化ON 通常版と比較し、デフォルトでレスポンス項目に含めるデータが少なくなっております(少なくすることでレスポンスの速度が向上しております。差し支えなければ、軽量版への切り替えも合わせてご検討いただけますと幸いです)。
例)受注検索APIの場合、現状と同じレスポンス(軽量化OFF)にしたい場合は、 https://(ドメイン)/api/v2/admin/orders.json?lighter=0 のようにパラメータ指定をお願いいたします。 ■対応期日 2023年4月10日(月)まで (※2023年4月11日以降に新規構築されたショップ様の環境で、「対象の検索API」を利用するタイミングまでにご対応いただければ問題ございません)

この記事の目次

このセクションの記事

お知らせ