コンテンツにスキップ
NEXT ENGINE API NEXT ENGINE API NEXT ENGINE API

商品ページ検索

リクエストURL

Section titled “リクエストURL”

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_goods_page/search

リファレンス内容

Section titled “リファレンス内容”

検索について

Section titled “検索について”

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

入力パラメータ

Section titled “入力パラメータ”
パラメータ値省略備考
access_tokenaccess_token取得により取得した値必須(SDKの場合不要)
refresh_tokenaccess_token取得により取得した値可能(SDKの場合不要)【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
wait_flag1:メイン機能過負荷でも可能な限りエラーにせず実行 1以外:メイン機能過負荷の場合、003002のエラーを返却可能(省略時は1以外とする)詳細は パラメータ共通事項「待機フラグについて」を参照して下さい
fields検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当)必須例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します
フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)検索条件の値(WHERE句の値相当)可能例：商品マスタ検索でパラメータ：goods_id-like、値：”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します
extension_execution_id拡張機能実行ID可能検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。
offsetオフセットの数値(OFFSET句相当)可能(省略時0)0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・
limit取得数の数値(LIMIT句相当)可能(省略時600)

出力パラメータ

Section titled “出力パラメータ”
パラメータ名値備考
resultsuccesssuccess以外の場合の出力パラメータは 成功時以外の出力パラメータ参照
access_token入力パラメータで指定したaccess_token／新たに発行されたaccess_token有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
access_token_end_dateaccess_tokenの有効期限切れ日時
refresh_token入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenaccess_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
refresh_token_end_daterefresh_tokenの有効期限切れ日時
count検索結果の件数
data検索結果の連想配列(JSONのオブジェクト型)

検索速度について

Section titled “検索速度について”

入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります

検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい

大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します

商品ページ

Section titled “商品ページ”
項目名フィールド名データ型備考
ページコード（商品コードまたは代表商品コード）goods_page_goods_code文字列型代表商品コードがある商品は、代表商品コードが設定されています。代表商品コードがない商品は、商品コードが設定されています。
掲載商品名goods_page_goods_name文字列型
公開・非公開goods_page_display_flag数値型0:非公開, 1:公開
キャッチコピー1goods_page_catch_phrase1文字列型
キャッチコピー2goods_page_catch_phrase2文字列型
キーワードgoods_page_keyword文字列型
項目選択肢 横軸名goods_page_v_horizontal_category文字列型
項目選択肢 縦軸名goods_page_v_vertical_category文字列型
セール価格goods_page_sale_amount数値型
セール開始日goods_page_sale_start_date日付型
セール開始時間goods_page_sale_start_time時間型
セール終了日goods_page_sale_end_date日付型
セール終了時間goods_page_sale_end_time時間型
関連商品goods_page_related_goods文字列型
送料区分goods_page_postage_type数値型0:送料別（個別）, 1:送料別（通常）, 2:送料込（無料）, 3:その他
個別送料goods_page_postage_amount数値型
代引料（代引区分）goods_page_cash_on_delivery_type数値型0:代引料別（個別）, 1:代引料込（無料）
代引料（個別代引料）goods_page_cash_on_delivery_amount数値型
注文受付区分goods_page_order_type数値型0:指定しない（自由入力）, 1:指定欄なし（1個限定）, 2:個数選択（プルダウン）
注文受付数goods_page_order_amount数値型注文受付区分:2 の場合のみ有効
在庫表示goods_page_stock_display_type数値型0:残り在庫数表示しない, 1:残り在庫数表示する, 2:在庫僅少表示
在庫僅少表示閾値goods_page_stock_display_threshold数値型在庫僅少表示閾値:2 の場合のみ有効
ポイントgoods_page_point数値型
表示順位goods_page_display_order数値型
シークレットパスワードgoods_page_secret_password文字列型
モール基本カテゴリIDgoods_page_mall_category_id文字列型
説明文1（PC）goods_page_description1META型
説明文2（スマホ）goods_page_description2META型
説明文3（モバイル）goods_page_description3META型
説明文4goods_page_description4META型
説明文5goods_page_description5META型
説明文6goods_page_description6META型
説明文7goods_page_description7META型
説明文8goods_page_description8META型
説明文9goods_page_description9META型
説明文10goods_page_description10META型
画像URL1goods_page_img1_srcMETA型
画像URL2goods_page_img2_srcMETA型
画像URL3goods_page_img3_srcMETA型
画像URL4goods_page_img4_srcMETA型
画像URL5goods_page_img5_srcMETA型
画像URL6goods_page_img6_srcMETA型
画像URL7goods_page_img7_srcMETA型
画像URL8goods_page_img8_srcMETA型
画像URL9goods_page_img9_srcMETA型
画像URL10goods_page_img10_srcMETA型
画像URL11goods_page_img11_srcMETA型
画像URL12goods_page_img12_srcMETA型
画像URL13goods_page_img13_srcMETA型
画像URL14goods_page_img14_srcMETA型
画像URL15goods_page_img15_srcMETA型
画像URL16goods_page_img16_srcMETA型
画像URL17goods_page_img17_srcMETA型
画像URL18goods_page_img18_srcMETA型
画像URL19goods_page_img19_srcMETA型
画像URL20goods_page_img20_srcMETA型
画像URL1 ALTgoods_page_img1_altMETA型
画像URL2 ALTgoods_page_img2_altMETA型
画像URL3 ALTgoods_page_img3_altMETA型
画像URL4 ALTgoods_page_img4_altMETA型
画像URL5 ALTgoods_page_img5_altMETA型
画像URL6 ALTgoods_page_img6_altMETA型
画像URL7 ALTgoods_page_img7_altMETA型
画像URL8 ALTgoods_page_img8_altMETA型
画像URL9 ALTgoods_page_img9_altMETA型
画像URL10 ALTgoods_page_img10_altMETA型
画像URL11 ALTgoods_page_img11_altMETA型
画像URL12 ALTgoods_page_img12_altMETA型
画像URL13 ALTgoods_page_img13_altMETA型
画像URL14 ALTgoods_page_img14_altMETA型
画像URL15 ALTgoods_page_img15_altMETA型
画像URL16 ALTgoods_page_img16_altMETA型
画像URL17 ALTgoods_page_img17_altMETA型
画像URL18 ALTgoods_page_img18_altMETA型
画像URL19 ALTgoods_page_img19_altMETA型
画像URL20 ALTgoods_page_img20_altMETA型
スペック1goods_page_spec1META型
スペック2goods_page_spec2META型
スペック3goods_page_spec3META型
スペック4goods_page_spec4META型
スペック5goods_page_spec5META型
フリーエリア1goods_page_free1META型
フリーエリア2goods_page_free2META型
フリーエリア3goods_page_free3META型
フリーエリア4goods_page_free4META型
フリーエリア5goods_page_free5META型
フリーエリア6goods_page_free6META型
フリーエリア7goods_page_free7META型
フリーエリア8goods_page_free8META型
フリーエリア9goods_page_free9META型
フリーエリア10goods_page_free10META型
掲載ステータスgoods_page_publication_status_id数値型1：新規登録, 2：編集中, 3：アップロード予定, 4：掲載済み
掲載日goods_page_publication_date日時型
作成日goods_page_creation_date日時型
最終更新日goods_page_last_modified_date日時型

サンプル

サンプル

Section titled “サンプル”

リクエスト

Terminal window
curl -X POST https://api.next-engine.org/api_v1_master_goods_page/search -H 'cache-control: no-cache' -F access_token=xxxxxxxx -F refresh_token=xxxxxxx -F wait_flag=1 -F 'fields=goods_page_goods_code,goods_page_goods_name,goods_page_display_flag,goods_page_catch_phrase1,goods_page_catch_phrase2,goods_page_keyword,goods_page_v_horizontal_category,goods_page_v_vertical_category,goods_page_sale_amount,goods_page_sale_start_date,goods_page_sale_start_time,goods_page_sale_end_date,goods_page_sale_end_time,goods_page_related_goods,goods_page_postage_type,goods_page_postage_amount,goods_page_cash_on_delivery_type,goods_page_cash_on_delivery_amount,goods_page_order_type,goods_page_order_amount,goods_page_stock_display_type,goods_page_stock_display_threshold,goods_page_point,goods_page_display_order,goods_page_secret_password,goods_page_mall_category_id,goods_page_description1,goods_page_description2,goods_page_description3,goods_page_description4,goods_page_description5,goods_page_description6,goods_page_description7,goods_page_description8,goods_page_description9,goods_page_description10,goods_page_img1_src,goods_page_img2_src,goods_page_img3_src,goods_page_img4_src,goods_page_img5_src,goods_page_img6_src,goods_page_img7_src,goods_page_img8_src,goods_page_img9_src,goods_page_img10_src,goods_page_img11_src,goods_page_img12_src,goods_page_img13_src,goods_page_img14_src,goods_page_img15_src,goods_page_img16_src,goods_page_img17_src,goods_page_img18_src,goods_page_img19_src,goods_page_img20_src,goods_page_img1_alt,goods_page_img2_alt,goods_page_img3_alt,goods_page_img4_alt,goods_page_img5_alt,goods_page_img6_alt,goods_page_img7_alt,goods_page_img8_alt,goods_page_img9_alt,goods_page_img10_alt,goods_page_img11_alt,goods_page_img12_alt,goods_page_img13_alt,goods_page_img14_alt,goods_page_img15_alt,goods_page_img16_alt,goods_page_img17_alt,goods_page_img18_alt,goods_page_img19_alt,goods_page_img20_alt,goods_page_spec1,goods_page_spec2,goods_page_spec3,goods_page_spec4,goods_page_spec5,goods_page_free1,goods_page_free2,goods_page_free3,goods_page_free4,goods_page_free5,goods_page_free6,goods_page_free7,goods_page_free8,goods_page_free9,goods_page_free10,goods_page_publication_status_id,goods_page_publication_date,goods_page_creation_date,goods_page_last_modified_date' -F offset=0 -F limit=1 -F goods_page_goods_code-like=%test-0%
{
  "result": "success",
  "data": [
    {
      "goods_page_goods_code": "test-01",
      "goods_page_goods_name": "test-01-name",
      "goods_page_display_flag": "1",
      "goods_page_catch_phrase1": "",
      "goods_page_catch_phrase2": "",
      "goods_page_keyword": "",
      "goods_page_v_horizontal_category": "",
      "goods_page_v_vertical_category": "",
      "goods_page_sale_amount": "",
      "goods_page_sale_start_date": "0000-00-00",
      "goods_page_sale_start_time": "00:00:00",
      "goods_page_sale_end_date": "0000-00-00",
      "goods_page_sale_end_time": "00:00:00",
      "goods_page_related_goods": "",
      "goods_page_postage_type": "",
      "goods_page_postage_amount": "",
      "goods_page_cash_on_delivery_type": "",
      "goods_page_cash_on_delivery_amount": "",
      "goods_page_order_type": "",
      "goods_page_order_amount": "",
      "goods_page_stock_display_type": "",
      "goods_page_stock_display_threshold": "",
      "goods_page_point": "",
      "goods_page_display_order": "",
      "goods_page_secret_password": "",
      "goods_page_mall_category_id": "",
      "goods_page_description1": "",
      "goods_page_description2": "",
      "goods_page_description3": "",
      "goods_page_description4": "",
      "goods_page_description5": "",
      "goods_page_description6": "",
      "goods_page_description7": "",
      "goods_page_description8": "",
      "goods_page_description9": "",
      "goods_page_description10": "",
      "goods_page_img1_src": "",
      "goods_page_img2_src": "",
      "goods_page_img3_src": "",
      "goods_page_img4_src": "",
      "goods_page_img5_src": "",
      "goods_page_img6_src": "",
      "goods_page_img7_src": "",
      "goods_page_img8_src": "",
      "goods_page_img9_src": "",
      "goods_page_img10_src": "",
      "goods_page_img11_src": "",
      "goods_page_img12_src": "",
      "goods_page_img13_src": "",
      "goods_page_img14_src": "",
      "goods_page_img15_src": "",
      "goods_page_img16_src": "",
      "goods_page_img17_src": "",
      "goods_page_img18_src": "",
      "goods_page_img19_src": "",
      "goods_page_img20_src": "",
      "goods_page_img1_alt": "",
      "goods_page_img2_alt": "",
      "goods_page_img3_alt": "",
      "goods_page_img4_alt": "",
      "goods_page_img5_alt": "",
      "goods_page_img6_alt": "",
      "goods_page_img7_alt": "",
      "goods_page_img8_alt": "",
      "goods_page_img9_alt": "",
      "goods_page_img10_alt": "",
      "goods_page_img11_alt": "",
      "goods_page_img12_alt": "",
      "goods_page_img13_alt": "",
      "goods_page_img14_alt": "",
      "goods_page_img15_alt": "",
      "goods_page_img16_alt": "",
      "goods_page_img17_alt": "",
      "goods_page_img18_alt": "",
      "goods_page_img19_alt": "",
      "goods_page_img20_alt": "",
      "goods_page_spec1": "",
      "goods_page_spec2": "",
      "goods_page_spec3": "",
      "goods_page_spec4": "",
      "goods_page_spec5": "",
      "goods_page_free1": "",
      "goods_page_free2": "",
      "goods_page_free3": "",
      "goods_page_free4": "",
      "goods_page_free5": "",
      "goods_page_free6": "",
      "goods_page_free7": "",
      "goods_page_free8": "",
      "goods_page_free9": "",
      "goods_page_free10": "",
      "goods_page_publication_status_id": 1,
      "goods_page_publication_date": "",
      "goods_page_creation_date": "2019-02-28 14:57:12",
      "goods_page_last_modified_date": "2019-02-28 14:57:12"
    }
  ],
  "count": 1,
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2021-06-26 08:13:52",
  "refresh_token": "xxxxxxxxxx",
  "refresh_token_end_date": "2021-06-28 08:13:52"
}

エラー

Section titled “エラー”

エラーコード

Section titled “エラーコード”

エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。

関連リンク

Section titled “関連リンク”

同じカテゴリの他のエンドポイント (商品ページ)

Section titled “同じカテゴリの他のエンドポイント (商品ページ)”