受注伝票一括更新

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/bulkupdate

リファレンス内容

受注伝票一括更新について

入力パラメータは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以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`data_type`	dataのファイル種類	必須	xml:更新データXML, gz:更新データをgzipで圧縮
`data`	更新するデータ	必須	XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します形式はこちらを参照
`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以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`message`	一括更新処理の状態を表すメッセージ	更新が成功している場合は空になります更新が失敗した場合は失敗した各伝票ごとにreceive_order_id, code, messageが返ります。詳細はサンプルをご覧ください。
`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		○
2		○	○	receive_order_id receive_order_last_modified_date	受注伝票番号と最終更新日を指定します。更新する受注伝票が複数ある場合はその分、要素を繰り返します
3	<receiveorder_base>				受注伝票の項目を指定する要素更新する受注伝票のフィールド名と値を指定します
4	<receive_order_date>
4	<receive_order_shop_cut_form_id>
3	</receiveorder_base>
3	<receiveorder_option>				受注伝票オプションの項目を指定する要素更新する受注伝票オプションのフィールド名と値を指定します
4	<receive_order_option_single_word_memo>
4	<receive_order_option_5>
3	</receiveorder_option>
3	<receiveorder_row>				受注明細の項目を指定する要素
4	<receive_order_row_no>		○	`value`	属性に更新対象の明細行を指定します更新する明細行が複数ある場合はその分、要素を繰り返します
5	<receive_order_row_goods_name>				更新する受注明細のフィールド名と値を指定します
5	<receive_order_row_cancel_flag>
4	<\receive_order_row_no>		○
3	<\receiveorder_row>
2		○	○
1		○

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

<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <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>
</root>

XML完成サンプル2（複数の受注伝票の更新）

<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <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>
 <receiveorder receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12346-8879</receive_order_shop_cut_form_id>
 <receive_order_date>2014-06-02 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
</root>

XML完成サンプル3（受注伝票の更新、オプション項目を含む）

<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <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_option>
 <receive_order_option_single_word_memo>xxx</receive_order_option_single_word_memo>
 </receiveorder_option>
 </receiveorder>
</root>

XML完成サンプル4（複数の受注伝票と明細の更新）

<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <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>テスト商品1</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>
 </receiveorder>
 <receiveorder receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12346-8879</receive_order_shop_cut_form_id>
 <receive_order_date>2014-06-02 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
</root>

更新仕様

更新内容の詳細は受注伝票受注伝票更新ページを参照してください

サンプル

リクエスト

curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx&receive_order_shipped_update_flag=1' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdate"

更新成功レスポンス

{
 "result": "success",
 "message": "",
 "access_token":"xxxxxxxx",
 "refresh_token":"xxxxxxxx",
 "access_token_end_date":"2017-04-15 18:24:53"
 "refresh_token_end_date":"2017-04-15 18:24:53"
}

更新失敗レスポンス

{
 "result": "error",
 "message": [
 {
 "receive_order_id": "7",
 "code": "020006",
 "message": "receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。",
 },
 {
 "receive_order_id": "8",
 "code": "020015",
 "message": "[receive_order_date]日付の形式ではありません。"
 }
 ],
 "access_token":"xxxxxxxx",
 "refresh_token":"xxxxxxxx",
 "access_token_end_date":"2017-04-15 18:24:53"
 "refresh_token_end_date":"2017-04-15 18:24:53"
}

エラー

エラーコード

エンドポイント固有のエラーコードを以下に示します。共通エラーコードはメッセージコード一覧を参照してください。

エラーコード	メッセージ	対処方法
`020001`	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
`020002`	receiveorderタグにreceive_order_idが指定されていない、または値が空です。	receive_order_idを指定してください
`020003`	POSTパラメータにdataが指定されていない、または値が空です。	dataを指定してください
`020004`	dataの値を解析できませんでした。正しい形式で指定して下さい。	dataの形式を修正してください
`020005`	receiveorderタグにreceive_order_last_modified_dateが指定されておりません。	receive_order_last_modified_dateを指定してください
`020006`	receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。	受注伝票を再検索して最新の日時を取得してください
`020007`	受注取込中のため、更新出来ません。	受注伝票を再検索してAPIを実行してください
`020008`	受注伝票[xxxxxx]は存在しません。	receive_order_idを確認してください
`020009`	[xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。	該当項目は受注メール取込済伝票では更新不可です
`020010`	受注状態が出荷確定済の伝票は更新できません。	出荷確定済伝票は更新できません
`020011`	棚卸中のため、更新出来ません。	棚卸を終了してから再度APIを実行してください
`020014`	更新フィールドが1つも設定されておりません。	更新するフィールドを設定してください
`020015`	[xxxx]xxxxxxxxxx	フィールド名xxxx についてエラー内容を確認してください
`020016`	明細行xx[xxxx]xxxxxxxxxx	明細行xx のフィールド名xxxx についてエラーを確認してください
`020017`	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx	受注明細追加の条件を確認してください
`020018`	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx	受注伝票と明細の更新条件を確認してください
`020019`	xxxx[xx]は、メイン機能に登録されていない値です。	フィールド名xxxx の値xx を確認してください
`020021`	一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。	1000件以内に分割してください
`020022`	更新対象が１つも指定されていません。	更新対象を指定してください
`020023`	POSTパラメータにdata_typeが指定されていない、または値が空です。	data_typeを指定してください
`020024`	data_typeの値を正しい形式で指定して下さい。	data_typeを正しい形式で指定してください
`020025`	data_type[xxx]とdataの形式が一致しません。正しい形式で指定してください。	data_typeとdataの形式を合わせてください
`020030`	所属拠点が異なる店舗に変更することはできません。	異なる拠点の店舗への変更はできません。複写後キャンセル処理を実施してください
`020500`	xxxxxxx	更新に失敗した伝票を確認してください
`020999`	更新処理中に例外が発生したため、処理を行いませんでした。	処理エラーを確認して対応してください