商品ページ件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_goods_page/count

リファレンス内容

件数取得について

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

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

入力パラメータ

パラメータ	値	省略	備考
`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以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)	検索条件の値(WHERE句の値相当)	可能	例：商品マスタ検索でパラメータ：goods_id-like、値：”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時
`count`	検索結果の件数

商品ページ

項目名	フィールド名	データ型	備考
ページコード（商品コードまたは代表商品コード）	`goods_page_goods_code`	文字列型	代表商品コードがある商品は、代表商品コードが設定されています。代表商品コードがない商品は、商品コードが設定されています。
掲載商品名	`goods_page_goods_name`	文字列型
公開・非公開	`goods_page_display_flag`	数値型	0:非公開, 1:公開
キャッチコピー1	`goods_page_catch_phrase1`	文字列型
キャッチコピー2	`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`	数値型	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`	文字列型
モール基本カテゴリID	`goods_page_mall_category_id`	文字列型
説明文1（PC）	`goods_page_description1`	META型
説明文2（スマホ）	`goods_page_description2`	META型
説明文3（モバイル）	`goods_page_description3`	META型
説明文4	`goods_page_description4`	META型
説明文5	`goods_page_description5`	META型
説明文6	`goods_page_description6`	META型
説明文7	`goods_page_description7`	META型
説明文8	`goods_page_description8`	META型
説明文9	`goods_page_description9`	META型
説明文10	`goods_page_description10`	META型
画像URL1	`goods_page_img1_src`	META型
画像URL2	`goods_page_img2_src`	META型
画像URL3	`goods_page_img3_src`	META型
画像URL4	`goods_page_img4_src`	META型
画像URL5	`goods_page_img5_src`	META型
画像URL6	`goods_page_img6_src`	META型
画像URL7	`goods_page_img7_src`	META型
画像URL8	`goods_page_img8_src`	META型
画像URL9	`goods_page_img9_src`	META型
画像URL10	`goods_page_img10_src`	META型
画像URL11	`goods_page_img11_src`	META型
画像URL12	`goods_page_img12_src`	META型
画像URL13	`goods_page_img13_src`	META型
画像URL14	`goods_page_img14_src`	META型
画像URL15	`goods_page_img15_src`	META型
画像URL16	`goods_page_img16_src`	META型
画像URL17	`goods_page_img17_src`	META型
画像URL18	`goods_page_img18_src`	META型
画像URL19	`goods_page_img19_src`	META型
画像URL20	`goods_page_img20_src`	META型
画像URL1 ALT	`goods_page_img1_alt`	META型
画像URL2 ALT	`goods_page_img2_alt`	META型
画像URL3 ALT	`goods_page_img3_alt`	META型
画像URL4 ALT	`goods_page_img4_alt`	META型
画像URL5 ALT	`goods_page_img5_alt`	META型
画像URL6 ALT	`goods_page_img6_alt`	META型
画像URL7 ALT	`goods_page_img7_alt`	META型
画像URL8 ALT	`goods_page_img8_alt`	META型
画像URL9 ALT	`goods_page_img9_alt`	META型
画像URL10 ALT	`goods_page_img10_alt`	META型
画像URL11 ALT	`goods_page_img11_alt`	META型
画像URL12 ALT	`goods_page_img12_alt`	META型
画像URL13 ALT	`goods_page_img13_alt`	META型
画像URL14 ALT	`goods_page_img14_alt`	META型
画像URL15 ALT	`goods_page_img15_alt`	META型
画像URL16 ALT	`goods_page_img16_alt`	META型
画像URL17 ALT	`goods_page_img17_alt`	META型
画像URL18 ALT	`goods_page_img18_alt`	META型
画像URL19 ALT	`goods_page_img19_alt`	META型
画像URL20 ALT	`goods_page_img20_alt`	META型
スペック1	`goods_page_spec1`	META型
スペック2	`goods_page_spec2`	META型
スペック3	`goods_page_spec3`	META型
スペック4	`goods_page_spec4`	META型
スペック5	`goods_page_spec5`	META型
フリーエリア1	`goods_page_free1`	META型
フリーエリア2	`goods_page_free2`	META型
フリーエリア3	`goods_page_free3`	META型
フリーエリア4	`goods_page_free4`	META型
フリーエリア5	`goods_page_free5`	META型
フリーエリア6	`goods_page_free6`	META型
フリーエリア7	`goods_page_free7`	META型
フリーエリア8	`goods_page_free8`	META型
フリーエリア9	`goods_page_free9`	META型
フリーエリア10	`goods_page_free10`	META型
掲載ステータス	`goods_page_publication_status_id`	数値型	1：新規登録, 2：編集中, 3：アップロード予定, 4：掲載済み
掲載日	`goods_page_publication_date`	日時型
作成日	`goods_page_creation_date`	日時型
最終更新日	`goods_page_last_modified_date`	日時型

サンプル

リクエスト

curl -X POST https://api.next-engine.org/api_v1_master_goods_page/count -H 'cache-control: no-cache' -F access_token=xxxxxxxxxx -F refresh_token=xxxxxxxxxx -F wait_flag=1 -F goods_page_goods_code-like=%syohin

{
  "result": "success",
  "count": "xxx",
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

エラー

エラーコード

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