受注伝票更新

POST

/api_v1_receiveorder_base/update

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

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

receive_order_id

required

伝票番号 / 更新する受注の伝票番号

string

receive_order_last_modified_date

required

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

string

data

required

更新するデータ / XML形式で指定します形式はこちらを参照

string

receive_order_shipped_update_flag

1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可

string

receive_order_row_cancel_update_flag

1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし / このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。

string

receive_order_recalculate_flag

1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない / 受注明細項目である小計金額は再計算の対象にならないためご注意ください金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します

string

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

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

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

受注伝票更新

Request Bodyrequired

Responses

200

Example

4XX

Example

Request Body^required