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

POST

/api_v1_system_canceltype/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_canceltype/info"

// POST /api_v1_system_canceltype/info - 受注キャンセル区分情報取得
const params = new URLSearchParams({
  access_token: '<access_token>',
})
const res = await fetch('https://api.next-engine.org/api_v1_system_canceltype/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_canceltype/info - 受注キャンセル区分情報取得
import requests

params = {
    'access_token': '<access_token>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_system_canceltype/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

cancel_type_id

受注キャンセル区分 / 文字列型

string | integer | number | boolean | null

cancel_type_name

受注キャンセル名 / 文字列型

string | integer | number | boolean | null

cancel_type_deleted_flag

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

string | integer | number | boolean | null

key

additional properties

any

Example

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

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