POST /1/orders/edit_status

注文情報のステータスを更新 or 後払い決済ステータスを更新
ステータスの更新は注文単位では行う事が出来ません。注文に紐付く商品単位で行います。
注文に紐付く全ての商品が更新されると、その注文のステータスも合わせて更新されます。
注文に紐付く商品のID(order_item_id)に関しては
https://docs.thebase.in/docs/api/orders/detail で取得可能です。

注文情報のステータスは6種類あります。

unshippable (対応開始前)
ordered (未対応)
dispatched (対応済)
cancelled (キャンセル)
unpaid (入金待ち)
shipping (配送中)

orderedから、dispatchedかcancelledにのみ更新できます。cancelledに更新できるのは代金引換決済の注文だけです。その他の注文のキャンセルはBASE管理画面からお願いします。unshippableから他ステータスへの更新はできません。コンビニ決済の注文はコンビニ決済ステータスがpaid(入金済み)の時だけdispatchedに更新できます。銀行振込(BASE口座)決済の注文は銀行振込(BASE口座)決済ステータスがpaid(入金済み)の時だけdispatchedに更新できます。

後払い決済ステータスは4種類あります。

ordered (未発送)
shipping (配送中)
arrived (着荷)
cancelled (キャンセル)

ordered から、shipping にのみ更新できます。後払い決済の場合、後払い決済ステータスの更新しかできません。商品が到着すると後払い決済ステータスが arrived に更新され、ステータスが dispatched に更新されます。order_item_idは注文の中のどれかひとつを指定すれば、全体の後払い決済ステータスが更新されます。

scope

write_orders

リクエストパラメーター

Name	Description
order_item_id	購入商品ID (必須)
status	ステータス。dispatched か cancelled のいずれか (statusを変更する場合は必須)
add_comment	発送メールに添付する一言メッセージ (改行も含めて250文字以内)
atobarai_status	後払い決済ステータス。shippingのみ (atobarai_statusを変更する場合は必須)
delivery_company_id	配送業者ID (atobarai_statusを変更する場合は必須)
tracking_number	送り状番号。半角英数のみ (atobarai_statusを変更する場合は必須)

レスポンスの例

{
  "order":{
    "unique_key":"154D88A39E454289",
    "ordered":1396419762,
    "cancelled":null,
    "dispatched":1396509935,
    "payment":"代金引換",
    "shipping_method":"ヤマト運輸",
    "shipping_fee":500,
    "cod_fee":300,
    "total":5800
    "first_name":"太郎",
    "last_name":"山田",
    "country":"Japan",
    "country_code":"JP",
    "zip_code":"106-0032",
    "prefecture":"東京都",
    "address":"港区六本木",
    "address2":"4-11-4 六本木ビル 301",
    "mail_address":"mail@example.com",
    "tel":"03-1234-5678",
    "remark":"午前中の配送を希望します。",
    "add_comment":"[配送業者]佐川急便 [送り状番号]123412341234",
    "delivery_company_id":3,
    "tracking_number":"123412341234",
    "delivery_date":"2018-03-19",
    "delivery_time_zone":"0812",
    "terminated":false,
    "dispatch_status":"dispatched",
    "modified":1396509935,
    "order_receiver":{
      "first_name":"花子",
      "last_name":"山田",
      "zip_code":"150-0043",
      "prefecture":"東京都",
      "address":"渋谷区道玄坂",
      "address2":"2-10-12 新大宗ビル3号館 531号",
      "tel":"03-1234-5678"
      "country":"Japan",
      "country_code":"JP"
    },
    "order_discount":{
      "discount":1000,
      "note":"初売りクーポン",
      "is_allocate_user_balance_log":0
    },
    "order_amount_adjustment":{
      "adjusted_amount":-100
    },
    "order_header_coin":{
      "discount":1000,
      "note":"コイン「HOGEコイン」の利用"
    },
    "order_charge":{
      "collected_fee":100
    },
    "additional_charges":[
      {
        "name":"オプション機能名1",
        "collected_fee":100
      },
      {
        "name":"オプション機能名2",
        "collected_fee":200
      }
    ],
    "fee_type":"base",
    "c_c_payment_transaction":{
      "collected_fee":200,
      "status":"captured"
    },
    "cvs_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "bt_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "atobarai_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "carrier_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "paypal_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "amazon_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "coin_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "bnpl_payment_transaction":{
      "collected_fee":null,
      "status":null
    },
    "user_balance_logs":[
      {
        "text":"154D88A39E454289の売上が確定しました",
        "price":7048,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289のヤマト配送料",
        "price":-500,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289のヤマト配送料の差額",
        "price":-200,
        "created":1396519935
      },
      {
        "text":"154D88A39E454289のの日本郵便配送料",
        "price":-500,
        "created":1396509935
      },
      {
        "text":"154D88A39E454289の日本郵便配送料の差額",
        "price":-200,
        "created":1396519935
       }
    ],
    "order_items":[
      {
        "order_item_id":123,
        "item_id":1001,
        "variation_id":101,
        "title":"Tシャツ",
        "item_identifier":"abcd-1234",
        "variation":"サイズM",
        "variation_identifier":"abcd-1234-w",
        "barcode":"abcd-1234-w",
        "price":2000,
        "amount":2,
        "total":4000,
        "shipping_method":null, // shipping_lines を持っている場合は null
        "shipping_fee":0, // shipping_lines を持っている場合は 0
        "status":"dispatched",
        "modified":1398231452
      },
      {
        "order_item_id":124,
        "item_id":1002,
        "variation_id":201,
        "title":"ロングTシャツ",
        "item_identifier":"abcd-1234",
        "variation":"サイズL",
        "variation_identifier":"abcd-1234-w",
        "barcode":"abcd-1234-w",
        "price":3000,
        "amount":1,
        "total":3000,
        "shipping_method":null,
        "shipping_fee":0,
        "status":"ordered",
        "modified":1396419762
      }
    ],
    "subscription": {
      "unique_key": "SABCDEF123456780",
      "repeat_number": 1,
      "repeat_times": 12
    },
    "shipping_lines":[
      {
          "order_item_ids": [100, 200],
          "shipping_method": "配送方法名(size_name)",
          "shipping_fee": 100,
      }
    ],
    "membership_rewards":[
      {
        "name": "特典名A",
        "status": "dispatched",
      },
      {
        "name": "特典名B",
        "status": "cancelled"
      }
    ]
  }
}

解説

unique_key - 注文情報を識別するユニークなキー
ordered - 注文日時
cancelled - キャンセル日時
dispatched - 発送日時
payment - 決済方法。creditcard:クレジットカード決済、cod:代金引換、cvs:コンビニ決済、base_bt:銀行振込(BASE口座)、atobarai:後払い決済、carrier_01:キャリア決済ドコモ、carrier_02:キャリア決済au、carrier_03:キャリア決済ソフトバンク、paypal:PayPal決済、coin:コイン決済、amazon_pay:Amazon Pay、bnpl:Pay ID あと払い、bnpl_installment:Pay ID 3回あと払い
shipping_method - 配送方法 (注文に対して指定している場合と、商品ごとに指定している場合がある) ※ shipping_lines を持っている場合はnull
shipping_fee - 送料 (注文ごと、商品ごと、配送ラインごとに指定している場合がある)
cod_fee 代引き手数料
total - 合計金額 (消費税、手数料含む)
country_code - ISO 3166-1 alpha-2 に対応した国名コード。一部のコードが割り当てられていない国・地域については空文字列。
remark - 備考欄
add_comment - 発送メールに添付する一言メッセージ
delivery_date - 配送日(yyyy-mm-dd)
delivery_time_zone - 配送時間帯。4ケタの数字(午前中 -> 0812、12時~14時 -> 1214)
terminated - [非推奨] dispatch_statusを使ってください。すべてが発送済みかキャンセルになっていればtrue
dispatch_status - 注文ステータス。unshippable:対応開始前、ordered:未対応、cancelled:キャンセル、dispatched:対応済、unpaid:入金待ち、shipping:配送中
modified - 更新日時
order_receiver - お届け先情報
order_discount - 割引情報
- discount - 割引金額
- note - 割引名
- is_allocate_user_balance_log - BASE負担割引フラグ。0:ショップ負担割引、1:BASE負担割引
order_amount_adjustment - 金額調整情報
- adjusted_amount - 調整金額
order_header_coin - コイン割引情報
- discount - 割引金額
- note - 割引名
order_charge - サービス利用料情報
- collected_fee - サービス利用料(2017年9月20日から徴収開始)
additional_charges - オプション機能利用料情報
- name - オプション機能名
- collected_fee - オプション機能利用料
fee_type - 手数料の種類。base: Webショップで購入されたさいの手数料、payid_app:Pay IDアプリで購入されたさいの手数料
c_c_payment_transaction - クレジットカード決済情報
- collected_fee - クレジット決済手数料
- status - クレジットカード決済ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
cvs_payment_transaction - コンビニ決済情報
- collected_fee - コンビニ決済手数料
- status - コンビニ決済ステータス。unpaid:入金待ち、paid:入金済み、cancelled:キャンセル
bt_payment_transaction - 銀行振込(BASE口座)決済情報
- collected_fee - 銀行振込(BASE口座)決済手数料
- status - 銀行振込(BASE口座)決済ステータス。unpaid:入金待ち、paid:入金済み、cancelled:キャンセル、shortage:不足入金
atobarai_payment_transaction - 後払い決済情報
- collected_fee - 後払い決済手数料
- status - 後払い決済ステータス。ordered:未発送、shipping:配送中、arrived:着荷、cancelled:キャンセル
carrier_payment_transaction - キャリア決済情報
- collected_fee - キャリア決済手数料
- status - キャリア決済ステータス。authorized:与信確保、captured:売上確定、cancelled:キャンセル
paypal_payment_transaction - PayPal決済情報
- collected_fee - PayPal決済手数料
- status - PayPal決済ステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
amazon_payment_transaction - Amazon Pay情報
- collected_fee - Amazon Pay手数料
- status - Amazon Payステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
bnpl_payment_transaction - Pay ID あと払い決済情報
- collected_fee - Pay ID あと払い手数料
- status - Pay ID あと払いステータス。creditable:与信確保、captured:売上確定、cancelled:キャンセル
user_balance_logs - お金履歴情報
- text - 見出しテキスト
- price - 金額
- created - 作成日時
order_items - 購入商品情報
- order_item_id - 購入商品ID
- item_id - 商品ID
- variation_id - バリエーションID
- title - 商品名
- item_identifier - 商品コード
- variation - バリエーションの種類
- variation_identifier - バリエーションの種類コード
- barcode - バリエーションのJAN/GTIN
- price - 単価
- amount - 数量
- total - 合計金額 (単価 * 数量)
- item_tax_type - 商品の税率設定。1:標準税率、2:軽減税率
- consumption_tax_rate - 消費税率
- status - ステータス。ordered:未対応、cancelled:キャンセル、dispatched:対応済
- shipping_method - 配送方法 ※ shipping_lines を持っている場合はnull
- shipping_fee - 送料 ※ shipping_lines を持っている場合は0
- shipping_start - 発送開始予定日（予約注文でない場合はnull）
- shipping_end - 発送終了予定日（予約注文でないか、予約注文であっても設定されていない場合はnull）
- modified - 更新日時
subscription - 定期便注文情報
- unique_key - 定期便ID（定期便注文でないときはnull）
- repeat_number - 注文回数。今回の注文が定期便で何回目の注文であるか。（定期便注文でないときはnull）
- repeat_times - 継続回数。この定期便が全部で何回継続されるか。回数無制限のときは0。（定期便注文でないときはnull）
shipping_lines - 配送ライン情報
- order_item_ids - 配送ライン毎の購入商品ID配列
- shipping_method - 配送方法名(サイズ名)。ショップの送料の場合は null
- shipping_fee - 配送ライン別送料
membership_rewards - 特典申請情報
- name - 特典名
- status - ステータス。ordered:未対応、cancelled:キャンセル、dispatched:対応済

エラーレスポンスの例

{
  "error":"access_denied",
  "error_description":"httpsでアクセスしてください。"
}

{
  "error":"invalid_request",
  "error_description":"アクセストークンが無効です。"
}

{
  "error":"invalid_scope",
  "error_description":"スコープが無効です。"
}

{
  "error":"not_post_method",
  "error_description":"POSTで送信してください。"
}

{
  "error":"no_params",
  "error_description":"order_item_idとstatusは必須です。"
}

{
  "error":"no_params",
  "error_description":"order_item_idとatobarai_statusとdelivery_company_idとtracking_numberは必須です。"
}

{
  "error":"no_order",
  "error_description":"注文情報が見つかりませんでした。"
}

{
  "error":"bad_params",
  "error_description":"不正なパラメーターです。"
}

{
  "error":"not_change_status",
  "error_description":"この注文のステータスは変更できません。"
}

{
  "error":"not_change_status_takeout",
  "error_description":"テイクアウト注文のステータスは変更できません。"
}

{
  "error":"not_cancel_credit_card",
  "error_description":"クレジットカード決済のキャンセルはできません。"
}

{
  "error":"not_cancel_cvs",
  "error_description":"コンビニ決済のキャンセルはできません。"
}

{
  "error":"not_cancel_base_bt",
  "error_description":"銀行振込(BASE口座)決済のキャンセルはできません。"
}

{
  "error":"not_cancel_atobarai",
  "error_description":"後払い決済のキャンセルはできません。"
}

{
  "error":"not_cancel_carrier",
  "error_description":"キャリア決済のキャンセルはできません。"
}

{
  "error":"not_cancel_coin",
  "error_description":"コイン決済のキャンセルはできません。"
}

{
  "error":"not_change_status_ClubT",
  "error_description":"ClubTの商品は発注することにより、ステータスの変更が可能です。"
}

{
  "error":"not_change_status_SpCase",
  "error_description":"SpCaseの商品は発注することにより、ステータスの変更が可能です。"
}

{
  "error":"not_change_status_JapanPostDelivery",
  "error_description":"日本郵便かんたん発送Appを利用した注文の発送はできません。"
}

{
  "error":"not_change_status_YamatoDelivery",
  "error_description":"ヤマトかんたん発送Appを利用した注文の発送はできません。"
}

{
  "error":"not_change_status_cvs",
  "error_description":"コンビニ決済の入金が完了していないのでステータスを変更できません。"
}

{
  "error":"not_change_status_base_bt",
  "error_description":"銀行振込(BASE口座)決済の入金が完了していないのでステータスを変更できません。"
}

{
  "error":"not_change_status_atobarai",
  "error_description":"後払い決済のステータスは変更できません。"
}

{
  "error":"not_cancel_carrier",
  "error_description":"キャリア決済のステータスは変更できません。"
}

{
  "error":"not_dispatch_creditcard_payment_maintenance",
  "error_description":"現在、クレジットカード決済がメンテナンス中のため、この注文を対応済にすることができません。"
}

{
  "error":"not_dispatch_paypal_payment_maintenance",
  "error_description":"現在、PayPal決済がメンテナンス中のため、この注文を対応済にすることができません。"
}

{
  "error":"not_dispatch_amazon_payment_maintenance",
  "error_description":"現在、AmazonPay決済がメンテナンス中のため、この注文を対応済にすることができません。"
}

{
  "error":"not_dispatch_carrier_payment_maintenance",
  "error_description":"現在、キャリア決済がメンテナンス中のため、この注文を対応済にすることができません。"
}

{
  "error":"not_dispatch_order_header_stop_dispatch",
  "error_description":"現在、該当注文は調査中のため、発送処理が正常に完了しませんでした。"
}

{
  "error":"db_error",
  "error_description":"ステータスの変更ができませんでした。"
}

scope​

リクエストパラメーター​

レスポンスの例​

解説​

エラーレスポンスの例​

scope

リクエストパラメーター

レスポンスの例

解説

エラーレスポンスの例