受注伝票分割-入出力パラメータ
- 受注伝票分割
- 入力パラメータ
- 出力パラメータ
- XML形式
受注伝票分割
Section titled “受注伝票分割”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。
動作は分割処理と同じで、受注伝票をパラメータで指定した値で分割処理します。
処理結果はレスポンスのステータスコードで確認します。
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
receive_order_id | 伝票番号 | 必須 | 分割する受注の伝票番号 |
receive_order_last_modified_date | 最終更新日 | 必須 | 分割する受注の最終更新日 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します メイン機能またはアプリで受注伝票が更新されている場合はエラーになります エラーになったら再度、受注伝票を検索してAPIを実行して下さい |
data | 更新するデータ | 必須 | XML形式で指定します 形式はこちらを参照 |
credit_unauthorized_flag | 1:条件を満たす場合（備考欄参照）、分割先・分割元ともに、受注伝票の請求情報を「未承認の状態(※1)」にする。1以外:分割元伝票の請求情報はそのまま、分割先伝票も分割元から請求情報を引き継ぐ。 | 可能(省略時は1以外とする) | 1で、次の条件を全て満たす場合、「未承認の状態(※1)」にする。 オーソリ区分ID(shop_authorization_type_id)=0 支払区分(receive_order_payment_method_id)=[0:クレジット] クレジット承認区分(receive_order_credit_approval_type_id) が [20:承認中]以上。 |
※1 未承認の状態
- 入金日(receive_order_deposit_date)=空
- 入金状況区分(receive_order_deposit_type_id)=[0:未入金]
- 入金額(receive_order_deposit_amount)=0
- クレジット承認区分(receive_order_credit_approval_type_id)=[10:未承認]
- クレジット承認額(receive_order_credit_approval_amount)=0
- クレジット承認日(receive_order_credit_approval_date)=空
- クレジット承認センター区分(receive_order_credit_authorization_center_id)=空
- クレジット承認FAX印刷日(receive_order_credit_approval_fax_printing_date)=空
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
result | success | 成功時以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
receive_order_id | 分割先の伝票番号 | |
access_token | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
refresh_token | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
入力パラメータのdataで指定する値です。
分割先の明細行、受注数を指定します。
引当数・予約引当数の指定は出来ません。分割元から引当数・予約引当数が割り当てられ、余った値が分割先の引当数・予約引当数となります。
有効な明細行のみを全て、明細行順に指定してください。
完成サンプルはこちらを参照。
| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
|---|---|---|---|---|---|
| 1 | ○ | ||||
| 2 | <receiveorder_row> | ○ | 受注明細の項目を指定する要素 | ||
| 3 | <receive_order_row_no> | ○ | value | 属性に更新対象の明細行を指定します更新する明細行が複数ある場合はその分、要素を繰り返します | |
| 4 | <receive_order_row_quantity> | ○ | 分割先の受注数を正の整数で指定します | ||
| 3 | </receive_order_row_no> | ||||
| 2 | </receiveorder_row> | ||||
| 1 | ○ |
XML完成サンプル（有効な受注明細行のみを、受注明細行順に全て指定する）
<?xml version="1.0" encoding="utf-8"?><root> <receiveorder_row> <receive_order_row_no value="2"> <receive_order_row_quantity>1</receive_order_row_quantity> </receive_order_row_no> <receive_order_row_no value="4"> <receive_order_row_quantity>0</receive_order_row_quantity> </receive_order_row_no> <receive_order_row_no value="5"> <receive_order_row_quantity>0</receive_order_row_quantity> </receive_order_row_no> </receiveorder_row></root>