仕入先マスタ件数取得
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_master_supplier/count
リファレンス内容
Section titled “リファレンス内容”件数取得について
Section titled “件数取得について”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります
検索条件を複数指定した場合、全ての条件がかつ(AND)となります
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
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の商品マスタを検索します |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
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 | 検索結果の件数 |
仕入先マスタ
Section titled “仕入先マスタ”| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| 仕入先コード | supplier_id | 文字列型 | |
| 仕入先名 | supplier_name | 文字列型 | |
| 仕入先カナ | supplier_kana | 文字列型 | |
| 郵便番号 | supplier_zip_code | 文字列型 | |
| 住所1 | supplier_address1 | 文字列型 | |
| 住所2 | supplier_address2 | 文字列型 | |
| 電話番号 | supplier_tel | 文字列型 | |
| FAX番号 | supplier_fax | 文字列型 | |
| メールアドレス | supplier_mail_address | 文字列型 | |
| 部署名 | supplier_post | 文字列型 | |
| 担当者名 | supplier_pic_name | 文字列型 | |
| 担当者カナ | supplier_pic_kana | 文字列型 | |
| 部署郵便番号 | supplier_post_zip_code | 文字列型 | |
| 部署住所1 | supplier_post_address1 | 文字列型 | |
| 部署住所2 | 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の場合作成者名 |
サンプル
リクエスト
curl -X POST https://api.next-engine.org/api_v1_master_supplier/count -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F supplier_name-like=%VENDOR -F supplier_id-eq=8888レスポンス
{ "result": "success", "count": "1", "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/openapi/operations/api_v1_master_supplier_count/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味)
同じカテゴリの他のエンドポイント (仕入先マスタ)
Section titled “同じカテゴリの他のエンドポイント (仕入先マスタ)”- 仕入先マスタ検索 —
POST /api_v1_master_supplier/search