索引

受注伝票更新

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

受注伝票の項目をパラメータで指定した値で更新します。

処理結果はレスポンスのステータスコードで確認します。

入力パラメータ

パラメータ 値 省略 備考
access_token access_token取得により取得した値 必須(SDKの場合不要)
refresh_token access_token取得により取得した値 可能(SDKの場合不要) 【指定してaccess_tokenの有効期限が切れた場合】

正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます

【省略してaccess_tokenの有効期限が切れた場合】

出力パラメータ「result」の値がredirectになります（
成功時以外の出力パラメータ参照)
wait_flag 1:メイン機能過負荷でも可能な限りエラーにせず実行

1以外:メイン機能過負荷の場合、003002のエラーを返却		 可能(省略時は1以外とする) 詳細は
パラメータ共通事項「待機フラグについて」を参照して下さい
receive_order_id 伝票番号 必須 更新する受注の伝票番号
receive_order_last_modified_date 最終更新日 必須 更新する受注の最終更新日

API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します

メイン機能またはアプリで受注伝票が更新されている場合はエラーになります

エラーになったら再度、受注伝票を検索してAPIを実行して下さい

data 更新するデータ 必須 XML形式で指定します

形式はこちらを参照
receive_order_shipped_update_flag 1:受注状態が「出荷確定済（完了）」でも更新可

1以外:受注状態が「出荷確定済（完了）」は更新不可		 可能(省略時は1以外とする)
receive_order_row_cancel_update_flag 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする

1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし		 可能(省略時は1以外とする) このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。
receive_order_recalculate_flag 1:受注伝票の金額系項目の再計算を有効にする

1以外:再計算を行わない		 可能(省略時は1以外とする)

受注明細項目である小計金額は再計算の対象にならないためご注意ください

金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します

出力パラメータ

パラメータ名 値 備考
result success success以外の場合の出力パラメータは
成功時以外の出力パラメータ参照
access_token 入力パラメータで指定したaccess_token／新たに発行されたaccess_token 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
access_token_end_date access_tokenの有効期限切れ日時
refresh_token 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
refresh_token_end_date refresh_tokenの有効期限切れ日時

XML形式

入力パラメータのdataで指定する値です

完成サンプルは
こちらを参照

階層 要素 必須 繰返 属性 内容
1 <root> ○
2 <receiveorder_base> 受注伝票の項目を指定する要素

更新する
受注伝票のフィールド名と値を指定します
3 <receive_order_date>
3 <receive_order_shop_cut_form_id>
2 </receiveorder_base>
2 <receiveorder_option> 受注伝票オプションの項目を指定する要素

更新する
受注伝票オプションのフィールド名と値を指定します
3 <receive_order_option_single_word_memo>
3 <receive_order_option_5>
2 </receiveorder_option>
2 <receiveorder_row> 受注明細の項目を指定する要素
3 <receive_order_row_no> ○ value 属性に更新対象の明細行を指定します

更新する明細行が複数ある場合はその分、要素を繰り返します
4 <receive_order_row_goods_name> 更新する
受注明細のフィールド名と値を指定します
4 <receive_order_row_cancel_flag>
3 </receive_order_row_no>
2 </receiveorder_row>
1 </root> ○

XML完成サンプル1（受注伝票と受注明細を更新）

<?xml version="1.0" encoding="utf-8"?>
<root>
	<receiveorder_base>
		<receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
		<receive_order_date>2014-05-01 00:00:00</receive_order_date>
	</receiveorder_base>
	<receiveorder_row>
		<receive_order_row_no value="1">
			<receive_order_row_goods_name>テスト商品</receive_order_row_goods_name>
			<receive_order_row_cancel_flag>1</receive_order_row_cancel_flag>
		</receive_order_row_no>
		<receive_order_row_no value="2">
			<receive_order_row_goods_name>テスト商品2</receive_order_row_goods_name>
		</receive_order_row_no>
		<receive_order_row_no value="3">
			<receive_order_row_quantity>3</receive_order_row_quantity>
		</receive_order_row_no>
	</receiveorder_row>
</root>

XML完成サンプル2（受注伝票の更新と、受注明細の更新と追加）

<?xml version="1.0" encoding="utf-8"?>
<root>
	<receiveorder_base>
		<receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
		<receive_order_date>2014-05-01 00:00:00</receive_order_date>
	</receiveorder_base>
	<receiveorder_row>
		<receive_order_row_no value="1">
			<receive_order_row_goods_name>テスト商品</receive_order_row_goods_name>
			<receive_order_row_cancel_flag>1</receive_order_row_cancel_flag>
		</receive_order_row_no>
		<receive_order_row_no value="2">
			<receive_order_row_goods_name>テスト商品2</receive_order_row_goods_name>
		</receive_order_row_no>
		<receive_order_row_no value="3">
			<receive_order_row_quantity>3</receive_order_row_quantity>
		</receive_order_row_no>
	</receiveorder_row>
</root>

XML完成サンプル3（受注伝票のみ更新）

<?xml version="1.0" encoding="utf-8"?>
<root>
	<receiveorder_base>
		<receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
		<receive_order_date>2014-05-01 00:00:00</receive_order_date>
	</receiveorder_base>
</root>

更新仕様

APIで指定出来るフィールドの一覧です。

ここに記載されていないフィールドは指定できません。

以下のフィールドはAPIで更新成功した場合、自動的に登録・更新されます。

  • 最終更新日
  • 最終更新者ID
  • 重要チェックをつけた場合、重要チェック担当者ID
  • 更新した受注伝票の操作履歴

受注メール取込済の伝票は、以下のフィールドのみAPIで更新できます。

  • 受注キャンセル区分
  • 作業用欄
  • 受注分類タグ

受注伝票

項目名 フィールド名 データ型 備考
店舗コード receive_order_shop_id 数値型
受注番号 receive_order_shop_cut_form_id 文字列型 メイン機能内でユニークかのチェックはしない
受注日 receive_order_date 日時型 YYYY-MM-DD hh:mm:ss
受注確認内容 receive_order_confirm_ids 文字列型 受注確認内容IDを":"区切りで設定します。明細行に対する確認は"#"の後に明細行番号が設定されます。

Ex: "AO:AA#1:AA#2"の場合

送り先の郵便番号と住所があってません。

商品コードが商品マスタに存在しません。：1行目

商品コードが商品マスタに存在しません。：2行目
確認チェック区分 receive_order_confirm_check_id 文字列型 0：チェックを外す　1：チェックをつける

チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る

納品書印刷済み以降はエラーが返る
受注分類タグ receive_order_gruoping_tag 文字列型 タグを[ ]で括る

例：[テストタグ][倉庫A]

メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される
受注キャンセル区分 receive_order_cancel_type_id 文字列型 0：有効　1：顧客依頼によりキャンセル

受注キャンセルコードを指定
発送方法区分 receive_order_delivery_id 文字列型 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない

整合性が必要な場合は、
発送方法別項目タイプの値を指定
支払区分 receive_order_payment_method_id 文字列型 出荷可能設定の整合性チェックはしない

整合性が必要な場合は、アプリ側で考慮して設定して下さい。
商品計 receive_order_goods_amount 数値型
税金 receive_order_tax_amount 数値型
手数料 receive_order_charge_amount 数値型
発送代 receive_order_delivery_fee_amount 数値型
他費用 receive_order_other_amount 数値型
ポイント数 receive_order_point_amount 数値型
総合計 receive_order_total_amount 数値型
入金額 receive_order_deposit_amount 文字列型
入金状況区分 receive_order_deposit_type_id 文字列型
入金日 receive_order_deposit_date 日時型 YYYY-MM-DD hh:mm:ss
備考 receive_order_note 文字列型
納品書印刷指示日 receive_order_statement_delivery_instruct_printing_date 日時型 YYYY-MM-DD hh:mm:ss
納品書特記事項 receive_order_statement_delivery_text 文字列型
作業用欄 receive_order_worker_text 文字列型
ピッキング指示内容 receive_order_picking_instruct 文字列型
配達希望日 receive_order_hope_delivery_date 日時型 YYYY-MM-DD hh:mm:ss
配達希望時間帯区分 receive_order_hope_delivery_time_slot_id 文字列型 更新する
発送方法別項目タイプの値を指定
便種区分 receive_order_delivery_method_id 文字列型 更新する
発送方法別項目タイプの値を指定
営業止め区分 receive_order_business_office_stop_id 文字列型 更新する
発送方法別項目タイプの値を指定
送り状区分 receive_order_invoice_id 文字列型 更新する
発送方法別項目タイプの値を指定
温度区分 receive_order_temperature_id 文字列型 更新する
発送方法別項目タイプの値を指定
シール1区分 receive_order_seal1_id 文字列型 更新する
発送方法別項目タイプの値を指定
シール2区分 receive_order_seal2_id 文字列型 更新する
発送方法別項目タイプの値を指定
シール3区分 receive_order_seal3_id 文字列型 更新する
発送方法別項目タイプの値を指定
シール4区分 receive_order_seal4_id 文字列型 更新する
発送方法別項目タイプの値を指定
ギフトフラグ receive_order_gift_flag 文字列型 0：無し　1：有り
発送伝票番号 receive_order_delivery_cut_form_id 文字列型
発送伝票備考欄 receive_order_delivery_cut_form_note 文字列型
クレジット区分 receive_order_credit_type_id 文字列型
クレジット承認番号 receive_order_credit_approval_no 文字列型
クレジット承認額 receive_order_credit_approval_amount 文字列型
クレジット承認区分 receive_order_credit_approval_type_id 文字列型
クレジット承認名 receive_order_credit_approval_type_name 文字列型
クレジット承認日 receive_order_credit_approval_date 日時型 YYYY-MM-DD hh:mm:ss
顧客区分 receive_order_customer_type_id 文字列型
顧客コード receive_order_customer_id 文字列型
購入者名 receive_order_purchaser_name 文字列型
購入者カナ receive_order_purchaser_kana 文字列型
購入者郵便番号 receive_order_purchaser_zip_code 文字列型 ハイフンは不要
購入者住所1 receive_order_purchaser_address1 文字列型
購入者住所2 receive_order_purchaser_address2 文字列型
購入者電話番号 receive_order_purchaser_tel 文字列型 ハイフンは不要
購入者メールアドレス receive_order_purchaser_mail_address 文字列型 メールアドレス形式で指定
送り先名 receive_order_consignee_name 文字列型
送り先カナ receive_order_consignee_kana 文字列型
送り先郵便番号 receive_order_consignee_zip_code 文字列型 ハイフンは不要
送り先住所1 receive_order_consignee_address1 文字列型
送り先住所2 receive_order_consignee_address2 文字列型
送り先電話番号 receive_order_consignee_tel 文字列型 ハイフンは不要
重要チェック区分 receive_order_important_check_id 文字列型 0：チェックしない　1：チェックする
納品書発行日 receive_order_statement_delivery_printing_date 日時型 YYYY-MM-DD hh:mm:ss
クレジット支払い回数 receive_order_credit_number_payments 数値型
出荷予定日 receive_order_send_plan_date 日時型 YYYY-MM-DD hh:mm:ss
請求金額（0%） receive_order_request_amount_tax0 数値型 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求金額（8%） receive_order_request_amount_tax8 数値型 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求金額（10%） receive_order_request_amount_tax10 数値型 税率毎の（商品計+送料+手数料) - (クーポン+ポイント)
請求額に対する税額（8%） receive_order_request_amount_tax_tax8 数値型 税率ごとの請求金額から割り戻した消費税額
請求額に対する税額（10%） receive_order_request_amount_tax_tax10 数値型 税率ごとの請求金額から割り戻した消費税額
手数料（0%） receive_order_charge_amount_tax0 数値型
手数料（8%） receive_order_charge_amount_tax8 数値型
手数料（10%） receive_order_charge_amount_tax10 数値型
他費用（0%） receive_order_other_amount_tax0 数値型 受注伝票の「他費用」のうち、加算する金額（税率毎）
他費用（8%） receive_order_other_amount_tax8 数値型 受注伝票の「他費用」のうち、加算する金額（税率毎）
他費用（10%） receive_order_other_amount_tax10 数値型 受注伝票の「他費用」のうち、加算する金額（税率毎）
クーポン割引額（0%） receive_order_coupon_amount_tax0 数値型
クーポン割引額（8%） receive_order_coupon_amount_tax8 数値型
クーポン割引額（10%） receive_order_coupon_amount_tax10 数値型
クーポン割引額（按分） receive_order_coupon_amount_distribute 数値型
ポイント（0%） receive_order_point_amount_tax0 数値型 ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（8%） receive_order_point_amount_tax8 数値型 ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（10%） receive_order_point_amount_tax10 数値型 ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎）
ポイント（按分） receive_order_point_amount_distribute 数値型 ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント）
ポイント（支払い） receive_order_point_amount_payment 数値型

受注伝票オプション

項目名 フィールド名 データ型 備考
一言メモ receive_order_option_single_word_memo 文字列型
メッセージ receive_order_option_message 文字列型
のし receive_order_option_noshi 文字列型
ラッピング receive_order_option_rapping 文字列型
オプション1 receive_order_option_1 文字列型
オプション2 receive_order_option_2 文字列型
オプション3 receive_order_option_3 文字列型
オプション4 receive_order_option_4 文字列型
オプション5 receive_order_option_5 文字列型
オプション6 receive_order_option_6 文字列型
オプション7 receive_order_option_7 文字列型
オプション8 receive_order_option_8 文字列型
オプション9 receive_order_option_9 文字列型
オプション10 receive_order_option_10 文字列型

受注明細

項目名 フィールド名 データ型 登録 更新 備考
明細行番号 receive_order_row_no 数値型 必須 更新のキーとして利用

空の場合、商品コード＋受注数＋αで明細行を最後尾に登録する
商品コード receive_order_row_goods_id 文字列型 必須 更新不可　登録時のみ必須

メイン機能の商品マスタにない商品は登録できない
商品名 receive_order_row_goods_name 文字列型
受注数 receive_order_row_quantity 数値型 必須
単価 receive_order_row_unit_price 数値型
消費税率（%） receive_order_row_tax_rate 数値型
掛率 receive_order_row_wholesale_retail_ratio 数値型
小計金額 receive_order_row_sub_total_price 数値型 金額の再計算および整合性チェックはしない

整合性が必要な場合は、アプリ側で計算して設定する
商品OP receive_order_row_goods_option 文字列型
キャンセルフラグ receive_order_row_cancel_flag 文字列型 0：有効　1：キャンセル

明細は削除できない

キャンセルフラグを指定してキャンセルにする