受注伝票分割
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_receiveorder_base/divide
リファレンス内容
Section titled “リファレンス内容”- 受注伝票分割
- 入力パラメータ
- 出力パラメータ
- 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>| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| 店舗コード | receive_order_shop_id | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | receive_order_id | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | receive_order_shop_cut_form_id | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | receive_order_date | 日時型 | 店舗側で受注した日 |
| 取込日 | receive_order_import_date | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | receive_order_important_check_id | 文字列型 | 1:重要 |
| 重要チェック名 | receive_order_important_check_name | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | receive_order_confirm_check_id | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | receive_order_confirm_check_name | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | receive_order_confirm_ids | 文字列型 | 受注確認内容IDが”:“区切りで設定されます。明細行に対する確認は”#“の後に明細行番号が設定されます。Ex: “AO:AA#1:AA#2”の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | receive_order_mail_status | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | receive_order_gruoping_tag | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | receive_order_import_type_id | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | receive_order_import_type_name | 文字列型 | |
| 受注キャンセル区分 | receive_order_cancel_type_id | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | receive_order_cancel_type_name | 文字列型 | |
| 受注キャンセル日 | receive_order_cancel_date | 日時型 | |
| 受注状態区分 | receive_order_order_status_id | 文字列型 | 受注状態区分 |
| 受注状態名 | receive_order_order_status_name | 文字列型 | |
| 発送方法区分 | receive_order_delivery_id | 文字列型 | 発送方法区分 |
| 発送方法名 | receive_order_delivery_name | 文字列型 | |
| 支払区分 | receive_order_payment_method_id | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | receive_order_payment_method_name | 文字列型 | |
| 総合計 | receive_order_total_amount | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | receive_order_tax_amount | 数値型 | |
| 手数料 | receive_order_charge_amount | 数値型 | |
| 発送代 | receive_order_delivery_fee_amount | 数値型 | |
| 他費用 | receive_order_other_amount | 数値型 | |
| ポイント数 | receive_order_point_amount | 数値型 | |
| 商品計 | receive_order_goods_amount | 数値型 | |
| 入金額 | receive_order_deposit_amount | 文字列型 | |
| 入金状況区分 | receive_order_deposit_type_id | 文字列型 | 入金区分 |
| 入金状況名 | receive_order_deposit_type_name | 文字列型 | |
| 入金日 | receive_order_deposit_date | 日時型 | |
| 備考 | receive_order_note | 文字列型 | |
| 同梱候補伝票番号 | receive_order_include_possible_order_id | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | receive_order_include_to_order_id | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | receive_order_multi_delivery_parent_order_id | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | receive_order_divide_from_order_id | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | receive_order_copy_from_order_id | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | receive_order_multi_delivery_parent_flag | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | receive_order_statement_delivery_instruct_printing_date | 日時型 | |
| 納品書発行日 | receive_order_statement_delivery_printing_date | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | receive_order_statement_delivery_text | 文字列型 | |
| 出荷確定日 | receive_order_send_date | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | receive_order_send_plan_date | 日時型 | |
| 出荷順序 | receive_order_send_sequence | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | receive_order_worker_text | 文字列型 | |
| ピッキング指示内容 | receive_order_picking_instruct | 文字列型 | |
| ラベル発行日 | receive_order_label_print_date | 日時型 | |
| ラベル発行フラグ | receive_order_label_print_flag | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | receive_order_hope_delivery_date | 日時型 | |
| 配達希望時間帯区分 | receive_order_hope_delivery_time_slot_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | receive_order_hope_delivery_time_slot_name | 文字列型 | |
| 便種区分 | receive_order_delivery_method_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | receive_order_delivery_method_name | 文字列型 | |
| シール1区分 | receive_order_seal1_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | receive_order_seal1_name | 文字列型 | |
| シール2区分 | receive_order_seal2_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | receive_order_seal2_name | 文字列型 | |
| シール3区分 | receive_order_seal3_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | receive_order_seal3_name | 文字列型 | |
| シール4区分 | receive_order_seal4_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | receive_order_seal4_name | 文字列型 | |
| 営業止め区分 | receive_order_business_office_stop_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | receive_order_business_office_stop_name | 文字列型 | |
| 送り状区分 | receive_order_invoice_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | receive_order_invoice_name | 文字列型 | |
| 温度区分 | receive_order_temperature_id | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | receive_order_temperature_name | 文字列型 | |
| 営業所名 | receive_order_business_office_name | 文字列型 | |
| ギフトフラグ | receive_order_gift_flag | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | receive_order_delivery_cut_form_id | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | receive_order_delivery_cut_form_note | 文字列型 | |
| クレジット区分 | receive_order_credit_type_id | 文字列型 | クレジット種類区分 |
| クレジット名 | receive_order_credit_type_name | 文字列型 | |
| クレジット承認番号 | receive_order_credit_approval_no | 文字列型 | |
| クレジット承認額 | receive_order_credit_approval_amount | 文字列型 | |
| クレジット承認区分 | receive_order_credit_approval_type_id | 文字列型 | クレジット承認区分 |
| クレジット承認名 | receive_order_credit_approval_type_name | 文字列型 | |
| クレジット承認日 | receive_order_credit_approval_date | 日時型 | |
| クレジット承認時レート | receive_order_credit_approval_rate | 数値型 | |
| クレジット支払い回数 | receive_order_credit_number_payments | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | receive_order_credit_authorization_center_id | 文字列型 | |
| クレジット承認センター名 | receive_order_credit_authorization_center_name | 文字列型 | |
| クレジット承認FAX印刷日 | receive_order_credit_approval_fax_printing_date | 日時型 | |
| 顧客区分 | receive_order_customer_type_id | 文字列型 | 顧客区分 |
| 顧客名 | receive_order_customer_type_name | 文字列型 | |
| 顧客コード | receive_order_customer_id | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | receive_order_purchaser_name | 文字列型 | |
| 購入者カナ | receive_order_purchaser_kana | 文字列型 | |
| 購入者郵便番号 | receive_order_purchaser_zip_code | 文字列型 | |
| 購入者住所1 | receive_order_purchaser_address1 | 文字列型 | |
| 購入者住所2 | receive_order_purchaser_address2 | 文字列型 | |
| 購入者電話番号 | receive_order_purchaser_tel | 文字列型 | |
| 購入者FAX | receive_order_purchaser_fax | 文字列型 | |
| 購入者メールアドレス | receive_order_purchaser_mail_address | 文字列型 | |
| 送り先名 | receive_order_consignee_name | 文字列型 | |
| 送り先カナ | receive_order_consignee_kana | 文字列型 | |
| 送り先郵便番号 | receive_order_consignee_zip_code | 文字列型 | |
| 送り先住所1 | receive_order_consignee_address1 | 文字列型 | |
| 送り先住所2 | receive_order_consignee_address2 | 文字列型 | |
| 送り先電話番号 | receive_order_consignee_tel | 文字列型 | |
| 送り先FAX | receive_order_consignee_fax | 文字列型 | |
| 重要チェック担当者ID | receive_order_important_check_pic_id | 数値型 | |
| 重要チェック担当者名 | receive_order_important_check_pic_name | 文字列型 | |
| 受注担当者ID | receive_order_pic_id | 数値型 | |
| 受注担当者名 | receive_order_pic_name | 文字列型 | |
| 出荷担当者ID | receive_order_send_pic_id | 数値型 | |
| 出荷担当者名 | receive_order_send_pic_name | 文字列型 | |
| 作成日 | receive_order_creation_date | 日時型 | |
| 最終更新日 | receive_order_last_modified_date | 日時型 | |
| 最終更新日 | receive_order_last_modified_null_safe_date | 日時型 | NULLの場合作成日 |
| 作成担当者ID | receive_order_creator_id | 数値型 | |
| 作成担当者名 | receive_order_creator_name | 文字列型 | |
| 最終更新者ID | receive_order_last_modified_by_id | 数値型 | |
| 最終更新者ID | receive_order_last_modified_by_null_safe_id | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | receive_order_last_modified_by_name | 文字列型 | |
| 最終更新者名 | receive_order_last_modified_by_null_safe_name | 文字列型 | NULLの場合作成者名 |
サンプル
リクエスト
curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=xxx&receive_order_last_modified_date=xxx&data=xxx&credit_unauthorized_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_base/divideレスポンス
{ "receive_order_id": "xxx", "result": "success", "access_token": "xxx", "access_token_end_date": "2017-04-19 11:21:13", "refresh_token": "xxx", "refresh_token_end_date": "2017-04-21 11:21:13"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは メッセージコード一覧 を参照してください。
| エラーコード | メッセージ | 対処方法 |
|---|---|---|
016001 | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
016002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
016003 | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
016004 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください |
016005 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
016006 | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
016007 | 受注状態が受注メール取込済の伝票は更新できません。 | 受注メール取込済伝票は分割できません |
016008 | 受注状態が取込情報不足の伝票は更新できません。 | 取込情報不足の伝票は分割できません |
016009 | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は分割できません |
016010 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
016011 | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
016012 | dataにreceiveorder_rowタグが設定されておりません。 | receiveorder_rowタグを設定してください |
016013 | receiveorder_rowに更新フィールドが設定されておりません。 | receiveorder_rowタグに更新フィールドを設定してください |
016014 | receive_order_row_noタグのvalue属性の値[xxxxxx]は0より大きい整数を指定してください。 | 0より大きい整数値を指定してください |
016015 | dataにreceive_order_row_quantityタグが設定されておりません。receive_order_row_no[xxxxxx] | receive_order_row_quantityタグを設定してください |
016016 | receive_order_row_noタグ内のreceive_order_row_quantityタグの値[xxxxxx]は0以上の整数を指定してください。 | 0以上の整数値を指定してください |
016017 | 分割先の受注数に全て0が指定されているため、分割できません。 | 0以外の分割数を指定してください |
016018 | 有効な受注明細行とdataで指定した受注明細行が一致しません。有効な受注明細行のみを全て指定してください。 | 有効な全ての明細行を指定してください |
016019 | 有効でない受注明細行の指定があるか、受注明細行の並び順が昇順ではありません。 | 有効な明細行を昇順で指定してください |
016020 | 指定した分割先受注数が、受注伝票の受注数より大きいです。受注伝票の受注数以下の数値を指定してください。receive_order_row_no[xxxxxx] | 受注数以下の値を指定してください |
016021 | 分割元の受注数に全て0が指定されるため、分割できません。分割可能な伝票か確認してください。 | 分割可能な伝票か確認してください |
016022 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 分割条件を確認してください |
016023 | 引当処理対象になる伝票は、引当処理中に分割処理出来ません。しばらく時間をおいて、再度実行してください。 | 引当処理が終了するまで待機してください |
016999 | 分割処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください |
- 構造化スキーマビュー:
/openapi/operations/api_v1_receiveorder_base_divide/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味) - フィールド一覧:
/guides/fields/receiveorder_base/(このエンドポイントが扱うデータ項目)
同じカテゴリの他のエンドポイント (受注伝票)
Section titled “同じカテゴリの他のエンドポイント (受注伝票)”- 受注伝票一括更新 —
POST /api_v1_receiveorder_base/bulkupdate - 納品書印刷済み一括更新 —
POST /api_v1_receiveorder_base/bulkupdatereceipted - 受注伝票件数取得 —
POST /api_v1_receiveorder_base/count - 受注伝票配送情報出力済み —
POST /api_v1_receiveorder_base/labelprinted - 受注伝票納品書印刷済み —
POST /api_v1_receiveorder_base/receipted - 受注伝票検索 —
POST /api_v1_receiveorder_base/search - 受注伝票出荷確定処理 —
POST /api_v1_receiveorder_base/shipped - 受注伝票更新 —
POST /api_v1_receiveorder_base/update - 受注伝票アップロード —
POST /api_v1_receiveorder_base/upload