注文情報のステータスを更新 or 後払い決済ステータスを更新ステータスの更新は注文単位では行う事が出来ません。注文に紐付く商品単位で行います。
注文に紐付く全ての商品が更新されると、その注文のステータスも合わせて更新されます。
注文に紐付く商品のID(order_item_id)に関してはhttps://docs.thebase.in/docs/api/orders/detail で取得可能です。
注文情報のステータスは6種類あります。
orderedから、dispatchedかcancelledにのみ更新できます。cancelledに更新できるのは代金引換決済の注文だけです。その他の注文のキャンセルはBASE管理画面からお願いします。unshippableから他ステータスへの更新はできません。コンビニ決済の注文はコンビニ決済ステータスがpaid(入金済み)の時だけdispatchedに更新できます。銀行振込(BASE口座)決済の注文は銀行振込(BASE口座)決済ステータスがpaid(入金済み)の時だけdispatchedに更新できます。
後払い決済ステータスは4種類あります。
ordered から、shipping にのみ更新できます。後払い決済の場合、後払い決済ステータスの更新しかできません。商品が到着すると後払い決済ステータスが arrived に更新され、ステータスが dispatched に更新されます。order_item_idは注文の中のどれかひとつを指定すれば、全体の後払い決済ステータスが更新されます。
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 } ],"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":"配送方法名(サイズ名)","shipping_fee":100, } ],"membership_rewards":[ {"name":"特典名A","status":"dispatched", }, {"name":"特典名B","status":"cancelled" } ] }}{"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":"ステータスの変更ができませんでした。"}