店舗マスタ件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_shop/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`	検索結果の件数

店舗マスタ

項目名	フィールド名	データ型	備考
店舗ID	`shop_id`	数値型
店舗名	`shop_name`	文字列型
店舗名カナ	`shop_kana`	文字列型
店舗略名	`shop_abbreviated_name`	文字列型
取扱商品名	`shop_handling_goods_name`	文字列型
閉店日	`shop_close_date`	日時型
備考	`shop_note`	文字列型
モールID	`shop_mall_id`	数値型
オーソリ区分ID	`shop_authorization_type_id`	文字列型
オーソリ区分名	`shop_authorization_type_name`	文字列型
税区分ID	`shop_tax_id`	文字列型
税区分名	`shop_tax_name`	文字列型
通貨単位区分ID	`shop_currency_unit_id`	文字列型
通貨単位区分名	`shop_currency_unit_name`	文字列型
税計算順序	`shop_tax_calculation_sequence_id`	文字列型	0:商品計で税計算,1:単価から税計算
後払い.com サイトID	`shop_type_id`	文字列型
削除フラグ	`shop_deleted_flag`	文字列型
作成日	`shop_creation_date`	日時型
最終更新日	`shop_last_modified_date`	日時型
最終更新日	`shop_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`shop_creator_id`	数値型
作成担当者名	`shop_creator_name`	文字列型
最終更新者ID	`shop_last_modified_by_id`	数値型
最終更新者ID	`shop_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`shop_last_modified_by_name`	文字列型
最終更新者名	`shop_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

サンプル

リクエスト

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \
 -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id-eq=xxx' \
 https://api.next-engine.org/api_v1_master_shop/count

レスポンス

{
  "result": "success",
  "count": "xxx",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-20 11:19:26"
}

エラー

エラーコード

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