発送方法別区分件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

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

発送方法区分

項目名	フィールド名	データ型	備考
発送方法区分	`forwarding_agent_id`	文字列型	発送方法区分のdelivery_idと紐付きます
発送方法別項目タイプ	`forwarding_agent_type`	文字列型	値は次の通り。binsyu_kbn:便種、eigyosyo_dome_kbn:営業所止め、jikantaisitei_kbn:時間帯、okurijyo_kbn:送り状、ondo_kbn:温度帯、seal1_kbn:シール1、seal2_kbn:シール2、seal3_kbn:シール3、seal4_kbn:シール4
発送方法別項目区分	`forwarding_agent_type_id`	文字列型	各項目の区分値
発送方法別項目名	`forwarding_agent_type_name`	文字列型	各項目の名称
表示順序	`forwarding_agent_display_order`	数値型
削除フラグ	`forwarding_agent_deleted_flag`	文字列型	1:有効 1以外:無効

サンプル

リクエスト

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

レスポンス

{
  "result": "success",
  "count": "396",
  "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"
}

エラー

エラーコード

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