コンテンツにスキップ
NEXT ENGINE API NEXT ENGINE API NEXT ENGINE API

受注伝票納品書印刷済み

リクエストURL

Section titled “リクエストURL”

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/receipted

リファレンス内容

Section titled “リファレンス内容”

納品書印刷済み

Section titled “納品書印刷済み”

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

有効な納品書印刷待ちの受注伝票を納品書印刷済みにします。

処理結果はレスポンスのステータスコードで確認します。

入力パラメータ

Section titled “入力パラメータ”
パラメータ値省略備考
access_tokenaccess_token取得により取得した値必須(SDKの場合不要)
refresh_tokenaccess_token取得により取得した値可能(SDKの場合不要)【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
wait_flag1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却可能(省略時は1以外とする)詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
receive_order_id伝票番号必須納品書印刷済みにする受注の伝票番号
receive_order_last_modified_date最終更新日必須納品書印刷済みにする受注の最終更新日。 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。 メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。 エラーになったら再度、受注伝票を検索してAPIを実行して下さい。
receive_order_label_print_flagラベル発行フラグ可能1：配送情報出力対象にする上記以外の値は何も処理しません。

出力パラメータ

Section titled “出力パラメータ”
パラメータ名値備考
resultsuccesssuccess以外の場合の出力パラメータは成功時以外の出力パラメータ参照
access_token入力パラメータで指定したaccess_token／新たに発行されたaccess_token有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
refresh_token入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenaccess_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります

納品書印刷済みにできる条件

Section titled “納品書印刷済みにできる条件”

以下は受注伝票の項目になります。

項目名フィールド名条件
伝票番号receive_order_idメイン機能に存在する受注伝票
受注キャンセル区分receive_order_cancel_type_id0：キャンセルされていない有効な受注伝票
受注状態区分receive_order_order_status_id20：納品書印刷待ちの受注伝票
納品書印刷指示日receive_order_statement_delivery_instruct_printing_date指定されていない、またはAPI実行日以前であること
ラベル発行フラグreceive_order_label_print_flagラベル発行フラグが「0」または「1」ただしこの条件は、上記の入力パラメータreceive_order_label_print_flagで「1」を指定した場合のみ有効。

受注伝票

Section titled “受注伝票”
項目名フィールド名データ型備考
店舗コード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文字列型確認チェックを付けた担当者名
受注確認内容IDreceive_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文字列型
購入者住所1receive_order_purchaser_address1文字列型
購入者住所2receive_order_purchaser_address2文字列型
購入者電話番号receive_order_purchaser_tel文字列型
購入者FAXreceive_order_purchaser_fax文字列型
購入者メールアドレスreceive_order_purchaser_mail_address文字列型
送り先名receive_order_consignee_name文字列型
送り先カナreceive_order_consignee_kana文字列型
送り先郵便番号receive_order_consignee_zip_code文字列型
送り先住所1receive_order_consignee_address1文字列型
送り先住所2receive_order_consignee_address2文字列型
送り先電話番号receive_order_consignee_tel文字列型
送り先FAXreceive_order_consignee_fax文字列型
重要チェック担当者IDreceive_order_important_check_pic_id数値型
重要チェック担当者名receive_order_important_check_pic_name文字列型
受注担当者IDreceive_order_pic_id数値型
受注担当者名receive_order_pic_name文字列型
出荷担当者IDreceive_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の場合作成日
作成担当者IDreceive_order_creator_id数値型
作成担当者名receive_order_creator_name文字列型
最終更新者IDreceive_order_last_modified_by_id数値型
最終更新者IDreceive_order_last_modified_by_null_safe_id数値型NULLの場合作成者ID
最終更新者名receive_order_last_modified_by_name文字列型
最終更新者名receive_order_last_modified_by_null_safe_name文字列型NULLの場合作成者名

サンプル

サンプル

Section titled “サンプル”

リクエスト

Terminal window
curl -X POST \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=xxx&receive_order_last_modified_date=xxx&receive_order_label_print_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_base/receipted

レスポンス

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

エラー

Section titled “エラー”

エラーコード

Section titled “エラーコード”

エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは メッセージコード一覧 を参照してください。

エラーコードメッセージ対処方法
008001アクセス情報[xxxxxx]の許可が必要です。ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
008002POSTパラメータにreceive_order_idが指定されていない、または値が空です。receive_order_idを指定してください
008003受注取込中のため、更新出来ません。しばらく時間を空けて再度APIを実行してください
008004受注伝票[xxxxxx]は存在しません。receive_order_idを確認してください
008005受注伝票[xxxxxx]は納品書印刷待ちではありません。伝票の状態を確認してください
008006受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。キャンセルされた伝票は処理できません
008007納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。納品書印刷処理終了後に実行してください
008008POSTパラメータにreceive_order_last_modified_dateが指定されておりません。receive_order_last_modified_dateを指定してください
008009receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。受注伝票を再検索して最新の日時を取得してください
008010棚卸中のため、更新出来ません。棚卸を終了してから再度APIを実行してください
008011納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください
008013受注伝票[xxxxxx]は配送情報出力済みです。配送情報出力済みの伝票は処理できません
008999更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx例外内容を確認して対応してください

関連リンク

Section titled “関連リンク”

同じカテゴリの他のエンドポイント (受注伝票)

Section titled “同じカテゴリの他のエンドポイント (受注伝票)”