/orders/{id} | サポートサイト

クエリーパラメータ

select

取得する列名を指定します。指定しない場合は ORDER_NO,ORDER_DISP_NO,PC_MOBILE_KBN,ORDER_DATE,KESSAI_ID,HAISO_ID,SEIKYU,TAX,TEIKA_SUM,TEIKA_SUM_TAX,SHIRE_SUM,SORYO,SORYO_TAX,DAIBIKI,DAIBIKI_TAX,MEMBER_WARIBIKI_SUM,POINT_WARIBIKI,COUPON_WARIBIKI,TAX_RATE,PAYMENT_DATE,CANCEL_DATE,AUTHORIZATION_FIXED_DATE,AUTHORY_DATE,DEL_DATE,BIKO,L_NAME,F_NAME,L_KANA,F_KANA,ZIP,ADDR1,ADDR2,ADDR3,TEL,PC_MAIL,MOBILE_MAIL,MEMBER_ID,SEND_L_NAME,SEND_F_NAME,SEND_L_KANA,SEND_F_KANA,SEND_MAIL,SEND_ZIP,SEND_ADDR1,SEND_ADDR2,SEND_ADDR3,SEND_TEL を指定した場合と同じ動作をします。

member_id

取得する受注に正しく紐づく会員IDを指定することで、誤って別会員の受注を取得することを防ぐ目的で利用できます。
指定しない場合は受注番号のみを条件として受注を取得します。

ボディー文字列

受注情報を格納したJSON値を返します。

クエリーパラメータ

should_send_customize_api

処理カスタマイズAPI common/order/update_committedを送信する場合true。デフォルトはfalseとなります。

execute_order_api_flg

受注データ連携OUT処理を実行する場合true。デフォルトはfalseとなります。

ボディー文字列

受注の情報を格納したJSON文字列、形式はGETと同一です。
更新可能な項目は、ADMIN_UPDATE_USER_ID、AUTHORY_DATE、SEND_DATE、KESSAI_ID、AUTHORIZATION_FIXED_DATE、AUTHORY_STATUS、VERI_TORIHIKI_ID、PAYMENT_STATUS、HAISO_ID、SHIP_SLIP_NO、SYOUKAI_NO、PAYMENT_DATE、SEIKYU、DAIBIKI、DAIBIKI_TAX、SORYO、SORYO_TAX、POINT_WARIBIKI、POINT_USE、COUPON_WARIBIKI、TEIKA_SUM、ATOBARAI_STATUS、ADD_POINT_SUM、SAVED_CARD_VERI_TORIHIKI_ID、DOWNLOAD_DATE、TEIKI_KBN、TEIKI_STOP_DATE、ORDER_API_STATUS、COUPON_ID、YOYAKU_STATUS、SEND_HOPE_DATE、SEND_HOPE_TIME、NEXT_SEND_HOPE_DATE、AUTO_CANCEL_STATUS、AUTO_CANCEL_MAIL_DATE、SEND_L_NAME、SEND_F_NAME、SEND_L_KANA、SEND_F_KANA、SEND_MAIL、SEND_ZIP、SEND_ADDR1、SEND_ADDR2、SEND_ADDR3、SEND_TEL、自由項目、metadataです。
KESSAI_ID、AUTHORY_DATE、AUTHORIZATION_FIXED_DATE、AUTHORY_STATUSを更新しても、決済連携は行われません。また、計算処理も行われません。

クエリーパラメータ

operation

以下の値を指定できます。

• set_payment_flg（入金日の設定）
• clear_payment_flg（入金日の解除）
• delete（受注の論理削除。キャンセル済みの受注に対して論理削除が指定された場合、ポイントおよび在庫の戻しは行いません。）
• set_shipped_flg（出荷情報の更新。出荷情報の更新は複数配送先には対応しておりません）
• send_pricechange_transaction（現在の金額に金額変更連携）
• fix_authorization（オーソリ確定）
• cancel_authorization_only（オーソリ取消のみ。決済設定の取消API連携フラグが「取消連携しない」の場合は連携を行いません。「取消連携しない」の場合も行うにはignore_cancel_api_flgを指定してください。）

use_stock_allocation

operationでdeleteを指定した際に有効なパラメータです。trueを設定すると、在庫の戻しを行います。

set_payment_flg_cash_on_delivery

operationでset_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、受注が代引き決済の場合に入金済みにします。

set_payment_flg_deferred_payment

operationでset_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、受注が後払い決済の場合に入金済みにします。

fix_authorization

operationでset_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、受注がクレジット決済の場合にオーソリ確定にします。

cancel_authorization_only

trueを設定すると、受注がクレジット決済の場合に決済代行会社に対してオーソリ取消処理を行います。受注情報の各ステータスはなにも変更されません。

send_mail_flg

operationでset_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、出荷お知らせメールを送信します。

ship_slip_connect_flg

operationでset_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、宅配伝票番号API連携を実施します。

ship_slip_type

operationでset_shipped_flgを指定した際に有効なパラメータです。ヤマト決済の出荷連携伝票番号種別を指定する場合に設定する項目となります。1を設定した場合、ヤマト伝票として宅配伝票番号API処理を行います。それ以外はヤマト伝票以外として宅配伝票番号API処理を行います。

ignore_transaction_check

operationでsend_pricechange_transaction、set_shipped_flgを指定した際に有効なパラメータです。trueを設定すると、トランザクション使用した状態でも処理が行えます。
※send_pricechange_transactionに関してはGMOPGキャリア決済（Docomo、AU）の場合のみ使用可能です。

ignore_cancel_api_flg

operationでcancel_authorization_onlyを指定した際に有効なパラメータです。trueを設定すると、決済設定の取消API連携フラグの設定によらず連携を行います。

ボディー文字列

operation=set_payment_flgを指定した場合、PAYMENT_DATEを指定することができます。PAYMENT_DATEが未指定の場合、現在の日付を入金日として使用します。