商品ページ検索

POST

/api_v1_master_goods_page/search

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%

// POST /api_v1_master_goods_page/search - 商品ページ検索
const params = new URLSearchParams({
  access_token: '<access_token>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
  // extension_execution_id: '...', // optional
})
const res = await fetch('https://api.next-engine.org/api_v1_master_goods_page/search', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_master_goods_page/search - 商品ページ検索
import requests

params = {
    'access_token': '<access_token>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
    # 'extension_execution_id': '...',  # optional
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_goods_page/search',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

extension_execution_id

拡張機能実行ID / 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。

string

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

goods_page_goods_code

ページコード（商品コードまたは代表商品コード） / 文字列型 / 代表商品コードがある商品は、代表商品コードが設定されています。代表商品コードがない商品は、商品コードが設定されています。