発送方法区分情報取得

POST

/api_v1_system_delivery/info

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"

// POST /api_v1_system_delivery/info - 発送方法区分情報取得
const params = new URLSearchParams({
  access_token: '<access_token>',
})
const res = await fetch('https://api.next-engine.org/api_v1_system_delivery/info', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_system_delivery/info - 発送方法区分情報取得
import requests

params = {
    'access_token': '<access_token>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_system_delivery/info',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

ネクストエンジン API 共通リクエストパラメータ

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

delivery_id

発送方法区分 / 文字列型

string | integer | number | boolean | null

delivery_name

発送方法名 / 文字列型

string | integer | number | boolean | null

delivery_deleted_flag

非表示フラグ / 数値型 / 1:非表示になっている区分 0:表示されている区分

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "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"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

発送方法区分情報取得

Request Body required

Responses

200

Example

4XX

Example

Request Body^required