受注伝票更新
curl -X POST \ https://api.next-engine.org/api_v1_receiveorder_base/update \ -d 'access_token=xxx&refresh_token=xxx&receive_order_id=1&receive_order_last_modified_date=xxx&data=xxx&receive_order_shipped_update_flag=1'// POST /api_v1_receiveorder_base/update - 受注伝票更新const params = new URLSearchParams({ access_token: '<access_token>', receive_order_id: '<receive_order_id>', receive_order_last_modified_date: '<receive_order_last_modified_date>', data: '<data>', // receive_order_shipped_update_flag: '...', // optional})const res = await fetch('https://api.next-engine.org/api_v1_receiveorder_base/update', { method: 'POST', headers: { 'content-type': 'application/x-www-form-urlencoded' }, body: params,})const json = await res.json()if (json.result !== 'success') throw new Error(json.message ?? json.code)console.log(json.data)# POST /api_v1_receiveorder_base/update - 受注伝票更新import requests
params = { 'access_token': '<access_token>', 'receive_order_id': '<receive_order_id>', 'receive_order_last_modified_date': '<receive_order_last_modified_date>', 'data': '<data>', # 'receive_order_shipped_update_flag': '...', # optional}res = requests.post( 'https://api.next-engine.org/api_v1_receiveorder_base/update', data=params,)json = res.json()if json['result'] != 'success': raise RuntimeError(json.get('message') or json.get('code'))print(json.get('data'))<?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 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 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>Request Body required
Section titled “Request Body required ”object
OAuth2 アクセストークン (必須)
OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)
同期実行フラグ。“1” 指定で処理完了を待つ
取得するフィールドをカンマ区切りで指定 (search 系のみ)
検索開始位置 (search 系のみ)
取得件数 (search 系のみ)
伝票番号 / 更新する受注の伝票番号
最終更新日 / 更新する受注の最終更新日 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します メイン機能またはアプリで受注伝票が更新されている場合はエラーになります エラーになったら再度、受注伝票を検索してAPIを実行して下さい
更新するデータ / XML形式で指定します / 詳細なXMLフォーマットは各APIのMarkdownドキュメントの「XML形式」セクションを参照
1:受注状態が「出荷確定済(完了)」でも更新可 1以外:受注状態が「出荷確定済(完了)」は更新不可
1:受注伝票の受注キャンセル区分を0(有効)に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0(有効)に変更しても明細行のキャンセルフラグに影響なし / このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。
1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない / 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目(インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額(0%)、請求金額(8%)、請求金額(10%)、請求額に対する税額(8%)、請求額に対する税額(10%)を加えた11項目)を指します
Responses
Section titled “ Responses ”実行結果 (result が success / error / redirect のいずれか)
object
実行結果ステータス
エラー時のエラーコード
object
更新後のアクセストークン
アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)
更新後のリフレッシュトークン
リフレッシュトークン有効期限
エンドポイント固有のレスポンスデータ
Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)
object
店舗コード / 数値型
受注番号 / 文字列型 / メイン機能内でユニークかのチェックはしない
受注日 / 日時型 / YYYY-MM-DD hh:mm:ss
受注確認内容 / 文字列型 / 受注確認内容IDを”:“区切りで設定します。明細行に対する確認は”#“の後に明細行番号が設定されます。 Ex: “AO:AA#1:AA#2”の場合 送り先の郵便番号と住所があってません。 商品コードが商品マスタに存在しません。:1行目 商品コードが商品マスタに存在しません。:2行目
確認チェック区分 / 文字列型 / 0:チェックを外す 1:チェックをつける チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る 納品書印刷済み以降はエラーが返る
受注分類タグ / 文字列型 / タグを[ ]で括る 例:[テストタグ][倉庫A] メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される
受注キャンセル区分 / 文字列型 / 0:有効 1:顧客依頼によりキャンセル 受注キャンセルコードを指定
発送方法区分 / 文字列型 / 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない 整合性が必要な場合は、 発送方法別項目タイプの値を指定
支払区分 / 文字列型 / 出荷可能設定の整合性チェックはしない 整合性が必要な場合は、アプリ側で考慮して設定して下さい。
商品計 / 数値型
税金 / 数値型
手数料 / 数値型
発送代 / 数値型
他費用 / 数値型
ポイント数 / 数値型
総合計 / 数値型
入金額 / 文字列型
入金状況区分 / 文字列型
入金日 / 日時型 / YYYY-MM-DD hh:mm:ss
備考 / 文字列型
納品書印刷指示日 / 日時型 / YYYY-MM-DD hh:mm:ss
納品書特記事項 / 文字列型
作業用欄 / 文字列型
ピッキング指示内容 / 文字列型
配達希望日 / 日時型 / YYYY-MM-DD hh:mm:ss
配達希望時間帯区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
便種区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
営業止め区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
送り状区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
温度区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
シール1区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
シール2区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
シール3区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
シール4区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定
ギフトフラグ / 文字列型 / 0:無し 1:有り
発送伝票番号 / 文字列型
発送伝票備考欄 / 文字列型
クレジット区分 / 文字列型
クレジット承認番号 / 文字列型
クレジット承認額 / 文字列型
クレジット承認区分 / 文字列型
クレジット承認名 / 文字列型
クレジット承認日 / 日時型 / YYYY-MM-DD hh:mm:ss
顧客区分 / 文字列型
顧客コード / 文字列型
購入者名 / 文字列型
購入者カナ / 文字列型
購入者郵便番号 / 文字列型 / ハイフンは不要
購入者住所1 / 文字列型
購入者住所2 / 文字列型
購入者電話番号 / 文字列型 / ハイフンは不要
購入者メールアドレス / 文字列型 / メールアドレス形式で指定
送り先名 / 文字列型
送り先カナ / 文字列型
送り先郵便番号 / 文字列型 / ハイフンは不要
送り先住所1 / 文字列型
送り先住所2 / 文字列型
送り先電話番号 / 文字列型 / ハイフンは不要
重要チェック区分 / 文字列型 / 0:チェックしない 1:チェックする
納品書発行日 / 日時型 / YYYY-MM-DD hh:mm:ss
クレジット支払い回数 / 数値型
出荷予定日 / 日時型 / YYYY-MM-DD hh:mm:ss
請求金額(0%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)
請求金額(8%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)
請求金額(10%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)
請求額に対する税額(8%) / 数値型 / 税率ごとの請求金額から割り戻した消費税額
請求額に対する税額(10%) / 数値型 / 税率ごとの請求金額から割り戻した消費税額
手数料(0%) / 数値型
手数料(8%) / 数値型
手数料(10%) / 数値型
他費用(0%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)
他費用(8%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)
他費用(10%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)
クーポン割引額(0%) / 数値型
クーポン割引額(8%) / 数値型
クーポン割引額(10%) / 数値型
クーポン割引額(按分) / 数値型
ポイント(0%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)
ポイント(8%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)
ポイント(10%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)
ポイント(按分) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(按分されるポイント)
ポイント(支払い) / 数値型
Example
{ "message": "変更された項目はありませんでした。", "result": "success", "access_token": "xxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxx", "refresh_token_end_date": "2017-04-20 11:19:26"}クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)
object
実行結果ステータス
エラー時のエラーコード
object
更新後のアクセストークン
アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)
更新後のリフレッシュトークン
リフレッシュトークン有効期限
エンドポイント固有のレスポンスデータ
Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)
Example
{ "result": "success"}