コンテンツにスキップ

受注伝票更新

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'
Media type 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形式で指定します / 詳細なXMLフォーマットは各APIのMarkdownドキュメントの「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

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

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
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
data
Array<object>
object
receive_order_shop_id

店舗コード / 数値型

string | integer | number | boolean | null
receive_order_shop_cut_form_id

受注番号 / 文字列型 / メイン機能内でユニークかのチェックはしない

string | integer | number | boolean | null
receive_order_date

受注日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_confirm_ids

受注確認内容 / 文字列型 / 受注確認内容IDを”:“区切りで設定します。明細行に対する確認は”#“の後に明細行番号が設定されます。 Ex: “AO:AA#1:AA#2”の場合 送り先の郵便番号と住所があってません。 商品コードが商品マスタに存在しません。:1行目 商品コードが商品マスタに存在しません。:2行目

string | integer | number | boolean | null
receive_order_confirm_check_id

確認チェック区分 / 文字列型 / 0:チェックを外す 1:チェックをつける チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る 納品書印刷済み以降はエラーが返る

string | integer | number | boolean | null
receive_order_gruoping_tag

受注分類タグ / 文字列型 / タグを[ ]で括る 例:[テストタグ][倉庫A] メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される

string | integer | number | boolean | null
receive_order_cancel_type_id

受注キャンセル区分 / 文字列型 / 0:有効 1:顧客依頼によりキャンセル 受注キャンセルコードを指定

string | integer | number | boolean | null
receive_order_delivery_id

発送方法区分 / 文字列型 / 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない 整合性が必要な場合は、 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_payment_method_id

支払区分 / 文字列型 / 出荷可能設定の整合性チェックはしない 整合性が必要な場合は、アプリ側で考慮して設定して下さい。

string | integer | number | boolean | null
receive_order_goods_amount

商品計 / 数値型

string | integer | number | boolean | null
receive_order_tax_amount

税金 / 数値型

string | integer | number | boolean | null
receive_order_charge_amount

手数料 / 数値型

string | integer | number | boolean | null
receive_order_delivery_fee_amount

発送代 / 数値型

string | integer | number | boolean | null
receive_order_other_amount

他費用 / 数値型

string | integer | number | boolean | null
receive_order_point_amount

ポイント数 / 数値型

string | integer | number | boolean | null
receive_order_total_amount

総合計 / 数値型

string | integer | number | boolean | null
receive_order_deposit_amount

入金額 / 文字列型

string | integer | number | boolean | null
receive_order_deposit_type_id

入金状況区分 / 文字列型

string | integer | number | boolean | null
receive_order_deposit_date

入金日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_note

備考 / 文字列型

string | integer | number | boolean | null
receive_order_statement_delivery_instruct_printing_date

納品書印刷指示日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_statement_delivery_text

納品書特記事項 / 文字列型

string | integer | number | boolean | null
receive_order_worker_text

作業用欄 / 文字列型

string | integer | number | boolean | null
receive_order_picking_instruct

ピッキング指示内容 / 文字列型

string | integer | number | boolean | null
receive_order_hope_delivery_date

配達希望日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_hope_delivery_time_slot_id

配達希望時間帯区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_delivery_method_id

便種区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_business_office_stop_id

営業止め区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_invoice_id

送り状区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_temperature_id

温度区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_seal1_id

シール1区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_seal2_id

シール2区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_seal3_id

シール3区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_seal4_id

シール4区分 / 文字列型 / 更新する 発送方法別項目タイプの値を指定

string | integer | number | boolean | null
receive_order_gift_flag

ギフトフラグ / 文字列型 / 0:無し 1:有り

string | integer | number | boolean | null
receive_order_delivery_cut_form_id

発送伝票番号 / 文字列型

string | integer | number | boolean | null
receive_order_delivery_cut_form_note

発送伝票備考欄 / 文字列型

string | integer | number | boolean | null
receive_order_credit_type_id

クレジット区分 / 文字列型

string | integer | number | boolean | null
receive_order_credit_approval_no

クレジット承認番号 / 文字列型

string | integer | number | boolean | null
receive_order_credit_approval_amount

クレジット承認額 / 文字列型

string | integer | number | boolean | null
receive_order_credit_approval_type_id

クレジット承認区分 / 文字列型

string | integer | number | boolean | null
receive_order_credit_approval_type_name

クレジット承認名 / 文字列型

string | integer | number | boolean | null
receive_order_credit_approval_date

クレジット承認日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_customer_type_id

顧客区分 / 文字列型

string | integer | number | boolean | null
receive_order_customer_id

顧客コード / 文字列型

string | integer | number | boolean | null
receive_order_purchaser_name

購入者名 / 文字列型

string | integer | number | boolean | null
receive_order_purchaser_kana

購入者カナ / 文字列型

string | integer | number | boolean | null
receive_order_purchaser_zip_code

購入者郵便番号 / 文字列型 / ハイフンは不要

string | integer | number | boolean | null
receive_order_purchaser_address1

購入者住所1 / 文字列型

string | integer | number | boolean | null
receive_order_purchaser_address2

購入者住所2 / 文字列型

string | integer | number | boolean | null
receive_order_purchaser_tel

購入者電話番号 / 文字列型 / ハイフンは不要

string | integer | number | boolean | null
receive_order_purchaser_mail_address

購入者メールアドレス / 文字列型 / メールアドレス形式で指定

string | integer | number | boolean | null
receive_order_consignee_name

送り先名 / 文字列型

string | integer | number | boolean | null
receive_order_consignee_kana

送り先カナ / 文字列型

string | integer | number | boolean | null
receive_order_consignee_zip_code

送り先郵便番号 / 文字列型 / ハイフンは不要

string | integer | number | boolean | null
receive_order_consignee_address1

送り先住所1 / 文字列型

string | integer | number | boolean | null
receive_order_consignee_address2

送り先住所2 / 文字列型

string | integer | number | boolean | null
receive_order_consignee_tel

送り先電話番号 / 文字列型 / ハイフンは不要

string | integer | number | boolean | null
receive_order_important_check_id

重要チェック区分 / 文字列型 / 0:チェックしない 1:チェックする

string | integer | number | boolean | null
receive_order_statement_delivery_printing_date

納品書発行日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_credit_number_payments

クレジット支払い回数 / 数値型

string | integer | number | boolean | null
receive_order_send_plan_date

出荷予定日 / 日時型 / YYYY-MM-DD hh:mm:ss

string | integer | number | boolean | null
receive_order_request_amount_tax0

請求金額(0%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null
receive_order_request_amount_tax8

請求金額(8%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null
receive_order_request_amount_tax10

請求金額(10%) / 数値型 / 税率毎の(商品計+送料+手数料) - (クーポン+ポイント)

string | integer | number | boolean | null
receive_order_request_amount_tax_tax8

請求額に対する税額(8%) / 数値型 / 税率ごとの請求金額から割り戻した消費税額

string | integer | number | boolean | null
receive_order_request_amount_tax_tax10

請求額に対する税額(10%) / 数値型 / 税率ごとの請求金額から割り戻した消費税額

string | integer | number | boolean | null
receive_order_charge_amount_tax0

手数料(0%) / 数値型

string | integer | number | boolean | null
receive_order_charge_amount_tax8

手数料(8%) / 数値型

string | integer | number | boolean | null
receive_order_charge_amount_tax10

手数料(10%) / 数値型

string | integer | number | boolean | null
receive_order_other_amount_tax0

他費用(0%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)

string | integer | number | boolean | null
receive_order_other_amount_tax8

他費用(8%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)

string | integer | number | boolean | null
receive_order_other_amount_tax10

他費用(10%) / 数値型 / 受注伝票の「他費用」のうち、加算する金額(税率毎)

string | integer | number | boolean | null
receive_order_coupon_amount_tax0

クーポン割引額(0%) / 数値型

string | integer | number | boolean | null
receive_order_coupon_amount_tax8

クーポン割引額(8%) / 数値型

string | integer | number | boolean | null
receive_order_coupon_amount_tax10

クーポン割引額(10%) / 数値型

string | integer | number | boolean | null
receive_order_coupon_amount_distribute

クーポン割引額(按分) / 数値型

string | integer | number | boolean | null
receive_order_point_amount_tax0

ポイント(0%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)

string | integer | number | boolean | null
receive_order_point_amount_tax8

ポイント(8%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)

string | integer | number | boolean | null
receive_order_point_amount_tax10

ポイント(10%) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(税率毎)

string | integer | number | boolean | null
receive_order_point_amount_distribute

ポイント(按分) / 数値型 / ポイントのうち、値引(=請求金額の算出に含めるもの)となるもの(按分されるポイント)

string | integer | number | boolean | null
receive_order_point_amount_payment

ポイント(支払い) / 数値型

string | integer | number | boolean | null
key
additional properties
any
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 で返ることが多い)

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
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"
}