商品コード紐づけ検索
リクエストURL
ホストhttps://api.next-engine.org
エンドポイント
/api_v1_master_goodsmapping/search
リファレンス内容
Section titled “リファレンス内容”商品コード紐づけ検索
Section titled “商品コード紐づけ検索”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。
検索条件を複数指定した場合、全ての条件がかつ(AND)となります。
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
access_token | access_token取得により取得した値 | 必須(SDKの場合不要) | |
refresh_token | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照) |
wait_flag | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
fields | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | |
| フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | |
offset | オフセットの数値(OFFSET句相当) | 可能(省略時0) | |
limit | 取得数の数値(LIMIT句相当) | 可能(省略時10000) |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
result | success | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
code | エラーコード | 成功(success)時はなし |
count | 検索結果の件数 | |
data | 検索結果の連想配列(JSONのオブジェクト型) | |
access_token | 入力パラメータで指定したaccess_token/新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
access_token_end_date | access_tokenの有効期限切れ日時 | (例)2016-01-01 01:01:01 |
refresh_token | 入力パラメータで指定したrefresh_token/新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
refresh_token_end_date | refresh_tokenの有効期限切れ日時 | (例)2016-01-01 01:01:01 |
検索速度について
Section titled “検索速度について”入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります
検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい
大量の検索結果を取得する場合、アクセスが集中する07:00~22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します
商品コード紐づけ
Section titled “商品コード紐づけ”| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| 店舗コード | goods_mapping_shop_id | 数値型 | |
| 商品コード | goods_mapping_goods_id | 文字列型 | |
| 店舗商品コード | goods_mapping_shop_goods_id | 文字列型 | |
| 削除フラグ | goods_mapping_deleted_flag | 文字列型 | |
| 作成日 | goods_mapping_creation_date | 日時型 | |
| 最終更新日 | goods_mapping_last_modified_date | 日時型 | |
| 最終更新日 | goods_mapping_last_modified_null_safe_date | 日時型 | NULLの場合作成日 |
| 作成担当者ID | goods_mapping_creator_id | 数値型 | |
| 作成担当者名 | goods_mapping_creator_name | 文字列型 | |
| 最終更新者ID | goods_mapping_last_modified_by_id | 数値型 | |
| 最終更新者ID | goods_mapping_last_modified_by_null_safe_id | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | goods_mapping_last_modified_by_name | 文字列型 | |
| 最終更新者名 | goods_mapping_last_modified_by_null_safe_name | 文字列型 | NULLの場合作成者名 |
サンプル
リクエスト
curl -X POST 'https://api.next-engine.org/api_v1_master_goodsmapping/search' \ -d 'access_token=XXX&goods_mapping_shop_id-eq=1&fields=goods_mapping_shop_id,goods_mapping_goods_id,goods_mapping_shop_goods_id,goods_mapping_deleted_flag,goods_mapping_creation_date,goods_mapping_last_modified_date,goods_mapping_last_modified_null_safe_date,goods_mapping_creator_id,goods_mapping_creator_name,goods_mapping_last_modified_by_id,goods_mapping_last_modified_by_null_safe_id,goods_mapping_last_modified_by_name,goods_mapping_last_modified_by_null_safe_name'レスポンス
{ "result": "success", "count": "1", "data": [ { "goods_mapping_shop_id": "1", "goods_mapping_goods_id": "s01", "goods_mapping_shop_goods_id": "s0101", "goods_mapping_deleted_flag": "0", "goods_mapping_creation_date": "2025-08-08 08:48:14", "goods_mapping_last_modified_date": "2025-08-08 08:48:14", "goods_mapping_last_modified_null_safe_date": "2025-08-08 08:48:14", "goods_mapping_creator_id": "2", "goods_mapping_creator_name": "当社担当者", "goods_mapping_last_modified_by_id": "2", "goods_mapping_last_modified_by_null_safe_id": "2", "goods_mapping_last_modified_by_name": "当社担当者", "goods_mapping_last_modified_by_null_safe_name": "当社担当者" }, ], "access_token": "XXX", "access_token_end_date": "2025-08-14 16:12:31", "refresh_token": "XXX", "refresh_token_end_date": "2025-08-16 16:12:31"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/api/operations/api_v1_master_goodsmapping_search/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味)
同じカテゴリの他のエンドポイント (商品コード紐づけ)
Section titled “同じカテゴリの他のエンドポイント (商品コード紐づけ)”- 商品コード紐づけ件数取得 —
POST /api_v1_master_goodsmapping/count