商品マスタ件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_goods/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_id`	文字列型
代表商品コード	`goods_representation_id`	文字列型
商品名	`goods_name`	文字列型
英語商品名	`goods_foreign_name`	文字列型
商品区分	`goods_type_id`	文字列型
商品区分名	`goods_type_name`	文字列型
取扱区分	`goods_merchandise_id`	文字列型
取扱区分名	`goods_merchandise_name`	文字列型
輸送方法指定	`goods_forwarding_method_id`	文字列型
輸送方法指定名	`goods_forwarding_method_name`	文字列型
商品ステータス区分	`goods_status_id`	文字列型
商品ステータス名	`goods_status_name`	文字列型
発送方法区分	`goods_delivery_id`	文字列型	商品マスタの配送業者の区分値
発送方法名	`goods_delivery_name`	文字列型	商品マスタの配送業者の名称
仕入先コード	`goods_supplier_id`	文字列型
JANコード	`goods_jan_code`	文字列型
メーカー名	`goods_maker_name`	文字列型
メーカーカナ	`goods_maker_kana`	文字列型
メーカー住所	`goods_maker_address`	文字列型
メーカー郵便番号	`goods_maker_zip_code`	文字列型
型番	`goods_model_number`	文字列型
色	`goods_color`	文字列型
モールカテゴリ	`goods_mall_category`	文字列型
店舗カテゴリ	`goods_shop_category`	文字列型
原価	`goods_cost_price`	数値型
定価	`goods_display_price`	数値型
売価単価	`goods_selling_price`	数値型
外国売価単価	`goods_foreign_selling_price`	数値型
消費税率（%）	`goods_tax_rate`	数値型
掛率	`goods_wholesale_retail_ratio`	数値型
重さ	`goods_weight`	数値型
幅	`goods_width`	数値型
奥行き	`goods_length`	数値型
高さ	`goods_height`	数値型
発売日	`goods_release_date`	日時型
初販売日	`goods_first_time_sold_date`	日時型
最終販売日	`goods_last_time_sold_date`	日時型
初仕入れ日	`goods_first_time_supplied_date`	日時型
最終仕入れ日	`goods_last_time_supplied_date`	日時型
在庫定数	`goods_stock_constant`	数値型
発注点	`goods_order_point`	数値型
ロット	`goods_lot`	数値型
掲載日	`goods_publication_date`	日時型
在庫管理フラグ	`goods_stock_management_flag`	文字列型
備考	`goods_note`	文字列型
表示フラグ	`goods_visible_flag`	文字列型
商品分類タグ	`goods_tag`	文字列型	値は名称値(goods_tag_name)が設定されている。複数設定可能。
ロケーション	`goods_location`	文字列型
メール便可否フラグ	`goods_delivery_mail_flag`	数値型
メール便最大数量	`goods_delivery_mail_maximum_quality`	文字列型
ギフト可フラグ	`goods_gift_ok_flg`	数値型
サイズ	`goods_size`	文字列型
メーカー型番	`goods_maker_model_number`	文字列型
在庫アラートメール閾値	`goods_stock_alert_mail_threshold`	数値型
卸引当用敷居値	`goods_wholesale_mortgage_threshold`	数値型
発送元コード	`goods_shipping_base_id`	文字列型
メールタグ	`goods_mail_tag_id`	文字列型
項目１	`goods_1_item`	文字列型
項目２	`goods_2_item`	文字列型
項目３	`goods_3_item`	文字列型
項目４	`goods_4_item`	文字列型
項目５	`goods_5_item`	文字列型
項目６	`goods_6_item`	文字列型
項目７	`goods_7_item`	文字列型
項目８	`goods_8_item`	文字列型
項目９	`goods_9_item`	文字列型
項目１０	`goods_10_item`	文字列型
項目１１	`goods_11_item`	文字列型
項目１２	`goods_12_item`	文字列型
項目１３	`goods_13_item`	文字列型
項目１４	`goods_14_item`	文字列型
項目１５	`goods_15_item`	文字列型
項目１６	`goods_16_item`	文字列型
項目１７	`goods_17_item`	文字列型
項目１８	`goods_18_item`	文字列型
項目１９	`goods_19_item`	文字列型
項目２０	`goods_20_item`	文字列型
選択肢ID１	`goods_1_select_id`	数値型
選択肢名１	`goods_1_select_name`	文字列型
選択肢ID２	`goods_2_select_id`	数値型
選択肢名２	`goods_2_select_name`	文字列型
選択肢ID３	`goods_3_select_id`	数値型
選択肢名３	`goods_3_select_name`	文字列型
選択肢ID４	`goods_4_select_id`	数値型
選択肢名４	`goods_4_select_name`	文字列型
選択肢ID５	`goods_5_select_id`	数値型
選択肢名５	`goods_5_select_name`	文字列型
選択肢ID６	`goods_6_select_id`	数値型
選択肢名６	`goods_6_select_name`	文字列型
選択肢ID７	`goods_7_select_id`	数値型
選択肢名７	`goods_7_select_name`	文字列型
選択肢ID８	`goods_8_select_id`	数値型
選択肢名８	`goods_8_select_name`	文字列型
選択肢ID９	`goods_9_select_id`	数値型
選択肢名９	`goods_9_select_name`	文字列型
選択肢ID１０	`goods_10_select_id`	数値型
選択肢名１０	`goods_10_select_name`	文字列型
掲載担当者ID	`goods_publication_pic_id`	数値型
掲載担当者名	`goods_publication_pic_name`	文字列型
卸在庫数	`goods_stock_wholesale_quantity`	数値型
商品説明（テキスト）	`goods_description_text`	文字列型
商品説明（HTML）	`goods_description_html`	文字列型
スペック（テキスト）	`goods_spec_text`	文字列型
スペック（HTML）	`goods_spec_html`	文字列型
注意事項（テキスト）	`goods_caution_text`	文字列型
注意事項（HTML）	`goods_caution_html`	文字列型
商品状態説明	`goods_condition_description`	文字列型
商品状態ID	`goods_condition_id`	文字列型	01:新品 10:中古 99:その他
ヒット商品お知らせ個数	`goods_hit_syohin_alert_quantity`	数値型
納期ID	`goods_delivery_date_id`	文字列型
納期指定日	`goods_designated_delivery_date`	文字列型	納期IDが’date’の場合のみ有効
パッケージ込みの高さ(cm)	`goods_package_height`	数値型
パッケージ込みの幅(cm)	`goods_package_width`	数値型
パッケージ込みの奥行き(cm)	`goods_package_length`	数値型
パッケージ込みの重さ(g)	`goods_package_weight`	数値型
販売開始日	`goods_first_available_date`	日時型
販売終了日	`goods_last_available_date`	日時型
消費税	`goods_tax_id`	数値型	0:税別 1:税込 2:非課税
ブランド名	`goods_brand_name`	文字列型
原産地	`goods_origin_place`	文字列型
原材料	`goods_raw_materials`	文字列型
保存方法	`goods_preservation_method`	文字列型
保証書の有無	`goods_warranty`	数値型	0:なし 1:あり
のし対応	`goods_option_noshi_id`	数値型	0:対応しない 1:対応する
当日・翌日配送	`goods_same_day_delivery_id`	数値型	1:当日 2:翌日
作成日	`goods_creation_date`	日時型
最終更新日	`goods_last_modified_date`	日時型
最終更新日	`goods_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`goods_creator_id`	数値型
作成担当者名	`goods_creator_name`	文字列型
最終更新者ID	`goods_last_modified_by_id`	数値型
最終更新者ID	`goods_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`goods_last_modified_by_name`	文字列型
最終更新者名	`goods_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&goods_id-eq=TestP001' https://api.next-engine.org/api_v1_master_goods/count

レスポンス

{
  "result": "success",
  "count": "1",
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-15 13:03:47",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2017-04-17 13:03:47"
}

エラー

エラーコード

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