納品書印刷済み一括更新

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/bulkupdatereceipted

リファレンス内容

納品書印刷済み一括更新について

入力パラメータは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形式で指定します形式はこちらを参照

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`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	< receive_order_label_print_flag>				ラベル発行フラグ。1：配送情報出力対象にする
2		○	○
1		○

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

サンプル

リクエスト

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

更新成功レスポンス

{
 "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",
  "code": "021500",
  "message": [
    {
      "receive_order_id": "2",
      "code": "021005",
      "message": "受注伝票[2]は納品書印刷待ちではありません。"
    },
    {
      "receive_order_id": "3",
      "code": "021004",
      "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"
}

エラー

エラーコード

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

エラーコード	メッセージ	対処方法
`024001`	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
`024002`	receiveorderタグにreceive_order_idが指定されていない、または値が空です。	receive_order_idを指定してください
`024003`	受注取込中のため、更新出来ません。	しばらく時間を空けて再度APIを実行してください
`024004`	受注伝票[xxxxxx]は存在しません。	receive_order_idを確認してください
`024005`	受注伝票[xxxxxx]は納品書印刷待ちではありません。	伝票の状態を確認してください
`024006`	受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。	キャンセルされた伝票は処理できません
`024007`	納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。	納品書印刷処理終了後に実行してください
`024008`	receiveorderタグにreceive_order_last_modified_dateが指定されておりません。	receive_order_last_modified_dateを指定してください
`024009`	receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。	受注伝票を再検索して最新の日時を取得してください
`024010`	棚卸中のため、更新出来ません。	棚卸を終了してから再度APIを実行してください
`024011`	納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。	納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください
`024013`	受注伝票[xxxxxx]は配送情報出力済みです。	配送情報出力済みの伝票は処理できません
`024014`	data_typeの値を正しい形式で指定して下さい。	data_typeを正しい形式で指定してください
`024015`	dataの値を解析できませんでした。正しい形式で指定して下さい。	dataの形式を修正してください
`024016`	data_type[xml or gz]とdataの形式が一致しません。正しい形式で指定してください。	data_typeとdataの形式を合わせてください
`024018`	POSTパラメータにdata_typeが指定されていない、または値が空です。	data_typeを指定してください
`024019`	POSTパラメータにdataが指定されていない、または値が空です。	dataを指定してください
`024020`	一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。	1000件以内に分割してください
`024021`	更新対象の受注伝票が１つも指定されていません。	更新対象を指定してください
`024500`	xxxxxxx	納品書印刷済み一括更新エラーを確認してください
`024999`	更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx	例外内容を確認して対応してください