受注キャンセル区分情報取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_system_canceltype/info

リファレンス内容

情報取得について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

情報取得と検索APIの違いは、以下の通りです

情報取得は、対象データを全て取得します（検索条件などの指定が不可能）
情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能）

入力パラメータ

パラメータ	値	省略	備考
`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以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`access_token_end_date`	入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時
`refresh_token_end_date`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時
`count`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型)	検索対象の全フィールドを返却します

受注キャンセル区分

項目名	フィールド名	データ型	備考
受注キャンセル区分	`cancel_type_id`	文字列型
受注キャンセル名	`cancel_type_name`	文字列型
非表示フラグ	`cancel_type_deleted_flag`	数値型	1:非表示になっている区分 0:表示されている区分

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_canceltype/info"

レスポンス

{
  "result": "success",
  "count": "18",
  "data": [
    {
      "cancel_type_id": "0",
      "cancel_type_name": "有効な受注です。"
    },
    {
      "cancel_type_id": "1",
      "cancel_type_name": "顧客依頼によりキャンセル"
    },
    {
      "cancel_type_id": "2",
      "cancel_type_name": "顧客依頼により明細内容をキャンセル"
    },
    {
      "cancel_type_id": "3",
      "cancel_type_name": "他の伝票への統合の為キャンセル"
    },
    {
      "cancel_type_id": "4",
      "cancel_type_name": "カード否決によりキャンセル"
    },
    {
      "cancel_type_id": "5",
      "cancel_type_name": "都合によりキャンセル"
    },
    {
      "cancel_type_id": "11",
      "cancel_type_name": "保留期間満了の為キャンセル"
    },
    {
      "cancel_type_id": "12",
      "cancel_type_name": "伝票を確認後、有効にして下さい。"
    },
    {
      "cancel_type_id": "20",
      "cancel_type_name": "未入金によりキャンセル"
    },
    {
      "cancel_type_id": "7",
      "cancel_type_name": "既に何らか処理が完了しているはず"
    },
    {
      "cancel_type_id": "6",
      "cancel_type_name": "不良返品によるキャンセル"
    },
    {
      "cancel_type_id": "8",
      "cancel_type_name": "顧客都合返品によるキャンセル"
    },
    {
      "cancel_type_id": "15",
      "cancel_type_name": "受取拒否によるキャンセル"
    },
    {
      "cancel_type_id": "14",
      "cancel_type_name": "長期不在戻りによるキャンセル"
    },
    {
      "cancel_type_id": "16",
      "cancel_type_name": "クレームによる戻りでキャンセル"
    },
    {
      "cancel_type_id": "17",
      "cancel_type_name": "誤配の戻りによるキャンセル"
    },
    {
      "cancel_type_id": "18",
      "cancel_type_name": "出荷遅延によるキャンセル"
    },
    {
      "cancel_type_id": "19",
      "cancel_type_name": "住所不明によるキャンセル"
    }
  ],
  "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"
}

エラー

エラーコード

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