商品マスタ検索

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_goods/search

リファレンス内容

検索について

入力パラメータは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以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`fields`	検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当)	必須	例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します
フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)	検索条件の値(WHERE句の値相当)	可能	例：商品マスタ検索でパラメータ：goods_id-like、値：”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します
`offset`	オフセットの数値(OFFSET句相当)	可能(省略時0)	0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・
`limit`	取得数の数値(LIMIT句相当)	可能(省略時10000)

出力パラメータ

パラメータ名	値	備考
`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`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型)

検索速度について

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

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

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

商品マスタ

項目名	フィールド名	データ型	備考
商品コード	`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の場合作成者名

商品画像

項目名	フィールド名	データ型	備考
商品画像ID	`goods_image_id`	数値型
商品コード	`goods_image_goods_id`	文字列型
ファイル名	`goods_image_file_name`	文字列型
画像URL(HTTP)	`goods_image_url_http`	文字列型
画像URL(HTTPS)	`goods_image_url_https`	文字列型
サイズ	`goods_image_size`	数値型	単位はバイト。500KB(1024計算)以下
幅	`goods_image_width`	数値型	単位：ピクセル。2100px以下
高さ	`goods_image_height`	数値型	単位：ピクセル。2100px以下
画像説明	`goods_image_alt`	文字列型	HTMLのimg要素のalt属性
自動変換フラグ	`goods_image_convert_flg`	数値型	自動作成したJPEG画像がある場合、1。このフラグが1の場合、URLはjpg以外が設定されており、拡張子をjpgにしてアクセスすることでjpgファイルにもアクセス出来ます
並び順	`goods_image_display_order`	文字列型
ファイル状態	`goods_image_status`	数値型	0:未ダウンロード 1:ダウンロード中 2:ダウンロード済み 3:アップロード済み 4:アップロード中 9:削除済み ※ファイル選択でアップロードされた場合は、1になります
削除フラグ	`goods_image_deleted_flag`	文字列型
作成日	`goods_image_creation_date`	日時型
最終更新日	`goods_image_last_modified_date`	日時型
最終更新日	`goods_image_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`goods_image_creator_id`	数値型
作成担当者名	`goods_image_creator_name`	文字列型
最終更新者ID	`goods_image_last_modified_by_id`	数値型
最終更新者ID	`goods_image_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`goods_image_last_modified_by_name`	文字列型
最終更新者名	`goods_image_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

在庫マスタ

項目名	フィールド名	データ型	備考
商品コード	`stock_goods_id`	文字列型
在庫数	`stock_quantity`	数値型
引当数	`stock_allocation_quantity`	数値型
不良在庫数	`stock_defective_quantity`	数値型
発注残数	`stock_remaining_order_quantity`	数値型
欠品数	`stock_out_quantity`	数値型
フリー在庫数	`stock_free_quantity`	数値型
予約在庫数	`stock_advance_order_quantity`	数値型
予約引当数	`stock_advance_order_allocation_quantity`	数値型
予約フリー在庫数	`stock_advance_order_free_quantity`	数値型
削除フラグ	`stock_deleted_flag`	文字列型
作成日	`stock_creation_date`	日時型
最終更新日	`stock_last_modified_date`	日時型
最終更新日	`stock_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`stock_creator_id`	数値型
作成担当者名	`stock_creator_name`	文字列型
最終更新者ID	`stock_last_modified_by_id`	数値型
最終更新者ID	`stock_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`stock_last_modified_by_name`	文字列型
最終更新者名	`stock_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

仕入先マスタ

項目名	フィールド名	データ型	備考
仕入先コード	`supplier_id`	文字列型
仕入先名	`supplier_name`	文字列型
仕入先カナ	`supplier_kana`	文字列型
郵便番号	`supplier_zip_code`	文字列型
住所１	`supplier_address1`	文字列型
住所２	`supplier_address2`	文字列型
電話番号	`supplier_tel`	文字列型
FAX番号	`supplier_fax`	文字列型
メールアドレス	`supplier_mail_address`	文字列型
部署名	`supplier_post`	文字列型
担当者名	`supplier_pic_name`	文字列型
担当者カナ	`supplier_pic_kana`	文字列型
部署郵便番号	`supplier_post_zip_code`	文字列型
部署住所１	`supplier_post_address1`	文字列型
部署住所２	`supplier_post_address2`	文字列型
部署電話番号	`supplier_post_tel`	文字列型
部署FAX	`supplier_post_fax`	文字列型
部署メールアドレス	`supplier_post_mail_address`	文字列型
発注区分	`supplier_order_id`	文字列型
発注名	`supplier_order_name`	文字列型
数量条件	`supplier_condition_quantity`	数値型
金額条件	`supplier_condition_money`	数値型
発注条件区分	`supplier_order_condition_id`	文字列型
発注条件名	`supplier_order_condition_name`	文字列型
発注保留日	`supplier_order_pending_date`	文字列型
支払方法区分	`supplier_pay_out_id`	文字列型
支払方法名	`supplier_pay_out_name`	文字列型
締日	`supplier_closing_day`	文字列型
支払サイト日	`supplier_usance_date`	文字列型
発注無効フラグ	`supplier_order_invalid_flag`	文字列型
発注禁止日	`supplier_order_forbid_date`	日時型
備考	`supplier_note`	文字列型
掛率	`supplier_wholesale_retail_ratio`	数値型
削除フラグ	`supplier_deleted_flag`	文字列型
作成日	`supplier_creation_date`	日時型
最終更新日	`supplier_last_modified_date`	日時型
最終更新日	`supplier_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`supplier_creator_id`	数値型
作成担当者名	`supplier_creator_name`	文字列型
最終更新者ID	`supplier_last_modified_by_id`	数値型
最終更新者ID	`supplier_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`supplier_last_modified_by_name`	文字列型
最終更新者名	`supplier_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

納期

項目名	フィールド名	データ型
納期ID	`delivery_date_id`	文字列型
納期名	`delivery_date_name`	文字列型
納期日数	`delivery_date_days`	文字列型
備考	`delivery_date_note`	文字列型

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=goods_id,goods_name,stock_quantity,supplier_name&goods_id-eq=TestP001&offset=0&limit=100' https://api.next-engine.org/api_v1_master_goods/search

レスポンス

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "goods_id": "TestP001",
      "goods_name": "登録時必須",
      "stock_quantity": "27",
      "supplier_name": "設定なし"
    }
  ],
  "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"
}

エラー

エラーコード

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