発送方法区分情報取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_system_delivery/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のオブジェクト型)	検索対象の全フィールドを返却します

発送方法区分

項目名	フィールド名	データ型	備考
発送方法区分	`delivery_id`	文字列型
発送方法名	`delivery_name`	文字列型
非表示フラグ	`delivery_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_delivery/info"

レスポンス

{
  "result": "success",
  "count": "41",
  "data": [
    {
      "delivery_id": "10",
      "delivery_name": "佐川急便(e飛伝PRO)"
    },
    {
      "delivery_id": "12",
      "delivery_name": "佐川急便(e飛伝)"
    },
    {
      "delivery_id": "13",
      "delivery_name": "佐川急便(e飛伝2)"
    },
    {
      "delivery_id": "11",
      "delivery_name": "佐川メール便(e飛伝PRO)"
    },
    {
      "delivery_id": "14",
      "delivery_name": "佐川メール便(e飛伝)"
    },
    {
      "delivery_id": "15",
      "delivery_name": "佐川メール便(e飛伝2)"
    },
    {
      "delivery_id": "16",
      "delivery_name": "楽天コンビニ受取(佐川急便)"
    },
    {
      "delivery_id": "20",
      "delivery_name": "ヤマト(発払い)B2v6"
    },
    {
      "delivery_id": "21",
      "delivery_name": "ヤマト(コレクト)B2v6"
    },
    {
      "delivery_id": "22",
      "delivery_name": "ヤマト(DM便)B2v6"
    },
    {
      "delivery_id": "23",
      "delivery_name": "ヤマト(メール速達)B2v6"
    },
    {
      "delivery_id": "24",
      "delivery_name": "ヤマト(発払い)B2v5"
    },
    {
      "delivery_id": "25",
      "delivery_name": "ヤマト(コレクト)B2v5"
    },
    {
      "delivery_id": "26",
      "delivery_name": "ヤマト(DM便)B2v5"
    },
    {
      "delivery_id": "27",
      "delivery_name": "ヤマト(メール速達)B2v5"
    },
    {
      "delivery_id": "28",
      "delivery_name": "ヤマト(ネコポス)"
    },
    {
      "delivery_id": "30",
      "delivery_name": "ゆうパック"
    },
    {
      "delivery_id": "31",
      "delivery_name": "レターパック500"
    },
    {
      "delivery_id": "32",
      "delivery_name": "レターパック350"
    },
    {
      "delivery_id": "33",
      "delivery_name": "ゆうメール"
    },
    {
      "delivery_id": "34",
      "delivery_name": "ポスパケット"
    },
    {
      "delivery_id": "35",
      "delivery_name": "ゆうパケット"
    },
    {
      "delivery_id": "36",
      "delivery_name": "楽天コンビニ受取(ゆうパック)"
    },
    {
      "delivery_id": "40",
      "delivery_name": "定形外郵便(代引)"
    },
    {
      "delivery_id": "41",
      "delivery_name": "定形外郵便"
    },
    {
      "delivery_id": "50",
      "delivery_name": "日本通運e発行"
    },
    {
      "delivery_id": "55",
      "delivery_name": "福山通運istar2"
    },
    {
      "delivery_id": "60",
      "delivery_name": "西濃運輸カンガルm2"
    },
    {
      "delivery_id": "70",
      "delivery_name": "Air Mail"
    },
    {
      "delivery_id": "71",
      "delivery_name": "エコ配"
    },
    {
      "delivery_id": "72",
      "delivery_name": "伝助"
    },
    {
      "delivery_id": "80",
      "delivery_name": "EMS"
    },
    {
      "delivery_id": "90",
      "delivery_name": "個別対応用_発送区分予約行1"
    },
    {
      "delivery_id": "91",
      "delivery_name": "個別対応用_発送区分予約行2"
    },
    {
      "delivery_id": "92",
      "delivery_name": "個別対応用_発送区分予約行3"
    },
    {
      "delivery_id": "93",
      "delivery_name": "個別対応用_発送区分予約行4"
    },
    {
      "delivery_id": "94",
      "delivery_name": "個別対応用_発送区分予約行5"
    },
    {
      "delivery_id": "95",
      "delivery_name": "店頭渡し"
    },
    {
      "delivery_id": "96",
      "delivery_name": "メーカー直送"
    },
    {
      "delivery_id": "98",
      "delivery_name": "楽天国際配送"
    },
    {
      "delivery_id": "99",
      "delivery_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"
}

エラー

エラーコード

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