コンテンツにスキップ
お問い合わせ

受注伝票出荷確定一括処理

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/bulkupdateshipped

受注情報更新

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

動作は受注伝票出荷確定処理と同じで、有効な納品書印刷済みの受注伝票を、複数まとめて出荷確定済みにします。一度に指定できる受注伝票は1000件までです。

受注伝票は1件ずつ処理します。出荷確定できない受注伝票があっても、ほかの受注伝票は出荷確定済みになります。

処理結果はレスポンスの result と message で確認します。

パラメータ値省略備考
access_tokenaccess_token取得により取得した値必須(SDKの場合不要)
refresh_tokenaccess_token取得により取得した値可能(SDKの場合不要)【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照)
wait_flag1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却可能(省略時は1以外とする)詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
data_typedataのファイル種類必須xml:出荷確定する受注伝票のXML, gz:XMLをgzipで圧縮
data出荷確定する受注伝票必須XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します 形式はこちらを参照

すべての受注伝票を出荷確定できた場合の出力パラメータです。

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

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

階層要素必須繰返属性内容
1<root>○
2<receiveorder>○○receive_order_id receive_order_last_modified_date出荷確定処理をする受注の伝票番号と最終更新日を指定します。 出荷確定する受注伝票が複数ある場合はその分、要素を繰り返します(1000件まで)
1</root>○

最終更新日は、API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。メイン機能またはアプリで受注伝票が更新されている場合、その受注伝票はエラーになります。エラーになったら再度、受注伝票を検索してAPIを実行して下さい。

XML完成サンプル

<?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 receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28"/>
<receiveorder receive_order_id="3" receive_order_last_modified_date="2018-04-13 10:38:28"/>
</root>

出荷確定できない受注伝票があった場合

Section titled “出荷確定できない受注伝票があった場合”

出荷確定できなかった受注伝票が1件でもあると、result は error、code は 031500 になります。

message には、出荷確定できなかった受注伝票だけが入ります。message に入っていない受注伝票は、出荷確定済みになっています。 再度APIを実行するときは、message に入っている受注伝票だけを指定して下さい。

message の各要素には、receive_order_id(伝票番号)、code(エラーコード)、message(エラーの内容)が入ります。

受注伝票出荷確定処理と同じです。以下は受注伝票の項目になります。

  • 伝票番号(receive_order_id):メイン機能に存在する受注伝票
  • 受注キャンセル区分(receive_order_cancel_type_id):0(キャンセルされていない有効な受注伝票)
  • 受注状態区分(receive_order_order_status_id):20または40(納品書印刷待ちまたは納品書印刷済みの受注伝票)
  • 納品書印刷指示日(receive_order_statement_delivery_instruct_printing_date):指定されていない、またはAPI実行日以前であること

リクエスト

ターミナルウィンドウ
curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdateshipped"

すべての受注伝票を出荷確定できた場合のレスポンス

{
"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"
}

出荷確定できない受注伝票があった場合のレスポンス(伝票番号1〜3を指定し、2と3を出荷確定できなかった場合。伝票番号1は出荷確定済みになっています)

{
"result": "error",
"code": "031500",
"message": [
{
"receive_order_id": "2",
"code": "031009",
"message": "すでに出荷確定しています"
},
{
"receive_order_id": "3",
"code": "031008",
"message": "受注伝票[3]は存在しません。"
}
],
"access_token": "xxxxxxxxxx",
"access_token_end_date": "2019-09-28 14:55:24",
"refresh_token": "xxxxxxxxxx",
"refresh_token_end_date": "2019-09-30 14:55:24"
}

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

次のエラーコードは、受注伝票を1件も処理せずに返します。message は文字列です。

エラーコードメッセージ対処方法
031001アクセス情報[xxxxxx]の許可が必要です。ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
031003POSTパラメータにdataが指定されていない、または値が空です。dataを指定してください
031004dataの値を解析できませんでした。正しい形式で指定して下さい。dataの形式を修正してください
0310211000件以内にして再度実行して下さい。1000件以内に分割してください
031022更新対象が1つも指定されていません。出荷確定する受注伝票を指定してください
031023POSTパラメータにdata_typeが指定されていない、または値が空です。data_typeを指定してください
031024data_typeの値を正しい形式で指定して下さい。data_typeを正しい形式で指定してください
031025data_type[xml or gz]とdataの形式が一致しません。正しい形式で指定してください。data_typeとdataの形式を合わせてください

次のエラーコードは、出荷確定できなかった受注伝票が1件でもあった場合に返します。message は、出荷確定できなかった受注伝票の一覧です。

エラーコードメッセージ対処方法
031500出荷確定できなかった受注伝票の一覧一覧の受注伝票ごとのエラーコードを確認してください。一覧に入っていない受注伝票は出荷確定済みになっています

次のエラーコードは、031500 の一覧の中で、受注伝票ごとに返します。

エラーコードメッセージ対処方法
031002receiveorderタグにreceive_order_idが指定されていない、または値が空です。receive_order_idを指定してください
031005receiveorderタグにreceive_order_last_modified_dateが指定されておりません。receive_order_last_modified_dateを指定してください
031006receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。受注伝票を再検索して最新の日時を取得してください
031007受注取込中のため、更新出来ません。しばらく時間を空けて、この受注伝票を指定して再度APIを実行してください
031008受注伝票[xxxxxx]は存在しません。receive_order_idを確認してください
031009xxxxxxx出荷確定処理できる条件を満たしていません。メッセージの内容を確認してください
031011棚卸中のため、更新出来ません。棚卸を終了してから、この受注伝票を指定して再度APIを実行してください
031999出荷確定処理中に例外が発生したため、処理を行いませんでした。しばらく時間を空けて、この受注伝票を指定して再度APIを実行してください

同じカテゴリの他のエンドポイント (受注伝票)

Section titled “同じカテゴリの他のエンドポイント (受注伝票)”