# ネクストエンジン Developer Network (全文版) > ネクストエンジン API ドキュメント全文を 1 ファイルに結合したもの。LLM のフルコンテキスト用。 --- # アプリ利用企業一覧 URL: https://developer.next-engine.com/api/api_app/company/ Method: POST API Endpoint: https://api.next-engine.org/api_app/company Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, client_id, client_secret ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_app/company` ## リファレンス内容 ### アプリの利用企業一覧について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 本APIはアプリを利用可能な企業(※)のメイン機能企業ID(company_id)の一覧を返却します ※：無料期間中・契約中・解約予定の企業を利用可能な企業として返却します。解約が終了した企業は結果に返却しません 　　一度利用不可能になった企業が再契約した場合、再度利用可能な企業になります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントID | 不可(SDKの場合不要) | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する | | `client_secret` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントシークレット | 不可 | client_idと同じ | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) 例）"data": [{ "company_id": "xxxxxxxxx", "company_ne_id": "yyyyyyyy" }] | フィールドは企業のメイン機能企業ID（company_id）とネクストエンジン企業ID（company_ne_id）です。アプリ種別が「ログインのみアプリ」の場合は、メイン機能企業ID（company_id）がnullとなりますのでご注意ください。 また、企業情報の取得は、各企業がアプリを起動した際に企業情報取得にて保持して下さい | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'client_id=xxxxxxxxx&client_secret=xxxxxxxxxxxxx' https://api.next-engine.org/api_app/company ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "company_id": "xxxxxxxxxxxxxx" } ] } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_app_company/`](/api/operations/api_app_company/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # NEログインaccess_token取得 URL: https://developer.next-engine.com/api/api_neauth/ ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_neauth` ## リファレンス内容 ### access_token取得について 本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります ### access_token・refresh_tokenの取扱注意事項 アクセストークン(及びリフレッシュトークン)は、ユーザーのメイン機能の情報にアクセス出来る重要な情報です アクセストークン(及びリフレッシュトークン)の漏洩は、ユーザーのメイン機能の情報の漏洩に繋がる可能性があります 漏洩のリスクを下げる為にも、アプリケーションサーバー(及びアプリのDBサーバー)とAPIサーバーとの通信以外には使わないで下さい （ユーザーにアプリケーションサーバーからアクセストークン・リフレッシュトークンを返却する事も漏洩のリスクを高めてしまいます） ### 入力パラメータ 　　　　　　　　　　　　　　　　　　　　　　 | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | uid | uid・state取得により取得した値 | 必須 | | | `state` | uid・state取得により取得した値 | 必須 | | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | 必須 | | | `client_secret` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントシークレット | 必須 | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | メイン機能のデータにアクセスする為のトークン | access_tokenには有効期限(1日)があります。有効期限が切れないようにする為にも、各APIを実行する際にrefresh_tokenも指定することを推奨します | | `refresh_token` | access_tokenの有効期限が切れた際に、access_tokenを再発行する為のトークン | refresh_tokenには有効期限(3日)があります。有効期限が切れた場合はuid・state取得を呼ぶ必要があります | | `company_ne_id` | アプリを購入した企業のネクストエンジンで一意になるID | | | `company_name` | アプリを購入した企業の企業名 | | | `company_kana` | アプリを購入した企業の企業名かな | | | uid | アプリを起動したユーザーの「購入アプリとユーザー単位」で一意になるID | 同じユーザーでも複数同じアプリを利用した場合は、uidが別になります。同一人物か判定する場合はpic_ne_idを利用します | | `pic_ne_id` | アプリを起動したユーザーの「ユーザー単位」で一意になるID | メイン機能のpic_idとは別。１ユーザーが複数のメイン機能を使うケースがある | | `pic_name` | アプリを起動したユーザーの氏名 | | | `pic_kana` | アプリを起動したユーザーの氏名かな | | | `pic_mail_address` | アプリを起動したユーザーのメールアドレス | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'uid=xxxxxxxxxxxxxx&state=xxxxxxxxxxxxxx&client_id=xxxxxxxxx&client_secret=xxxxxxxxxxxxx' "https://api.next-engine.org/api_neauth ``` レスポンス ```json { "access_token": "xxxxxxxxxxxxxx", "company_app_header": "xxxxxxxxxxxxxx", "company_ne_id": "xxxxxxxxxxxxxx", "company_name": "xxxxxxxxxxxxxx", "company_kana": "xxxxxxxxxxxxxx", "uid": "xxxxxxxxxxxxxx", "pic_ne_id": "xxxxxxxxxxxxxx", "pic_name": "xxxxxxxxxxxxxx", "pic_kana": "xxxxxxxxxxxxxx", "pic_mail_address": "xxxxxxxxxxxxxx", "refresh_token": "xxxxxxxxxxxxxx", "result": "success" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_neauth/`](/api/operations/api_neauth/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # 企業情報取得 URL: https://developer.next-engine.com/api/api_v1_login_company/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_login_company/info Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_login_company/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 企業 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 企業名 | `company_name` | 文字列型 | | | 企業名カナ | `company_kana` | 文字列型 | | | 郵便番号 | `company_zip_code` | 文字列型 | | | 住所1 | `company_address1` | 文字列型 | | | 住所2 | `company_address2` | 文字列型 | | | 部署名 | `company_post_name` | 文字列型 | | | 担当者名 | `company_pic_name` | 文字列型 | | | メールアドレス | `company_mail_address` | 文字列型 | | | 電話番号 | `company_phone` | 文字列型 | | | FAX | `company_fax` | 文字列型 | | | 企業URL | `company_url` | 文字列型 | | | 締日 | `company_closing_day` | 文字列型 | | | 最終締日 | `company_last_closing_date` | 日時型 | | | 端数処理桁数 | `company_fraction_number_digit` | 数値型 | | | 端数処理区分 | `company_fraction_id` | 文字列型 | | | 端数処理名 | `company_fraction_name` | 文字列型 | | | 税抜き・税込み区分 | `company_tax_id` | 文字列型 | | | 税抜き・税込み名 | `company_tax_name` | 文字列型 | | | 一時利用停止フラグ | `company_temporarily_suspend_flag` | 文字列型 | | | 有効日 | `company_available_date` | 日時型 | | | 無効日 | `company_unavailable_date` | 日時型 | | | 通知先メールアドレス | `company_notice_mail_address` | 文字列型 | | | 仕入れタイプ | `company_buying_type` | 文字列型 | | | バッチタイプ | `company_batch_type` | 文字列型 | | | クーポンコード | `company_coupon_code` | 文字列型 | | | 企業区分 | `company_type_id` | 文字列型 | | | IPアドレス | `company_ip_address` | 文字列型 | | | 明細ソート | `company_row_order` | 数値型 | | | メイン機能企業ID | `company_id` | 文字列型 | アプリを起動した企業の「メイン機能単位」で一意になるID。１つの企業が複数のメイン機能を所有することがあります。 | | ネクストエンジン企業ID | `company_ne_id` | 文字列型 | アプリを起動した企業の一意になるID。 | | メイン機能ホスト | `company_host` | 文字列型 | | | 現在の税率 | `company_now_tax_percent` | 数値型 | 10%の場合、10 | | 値引きの優先適用先 | `company_primary_tax_rate_for_discount` | 数値型 | NULL:按分10:10%8:8%0:0% | | 適格請求書発行事業者の登録番号 | `company_invoice_registration_number` | 文字列型 | | | ヒット商品お知らせ期間 | `company_hit_syohin_alert_hour` | 数値型 | 0の場合、お知らせしない | | ヒット商品お知らせ個数 | `company_hit_syohin_alert_quantity` | 数値型 | 全商品に対して有効です。商品マスタに商品ごとの設定がある場合は、そちらが優先されます。 | | 削除フラグ | `company_deleted_flag` | 文字列型 | | | 作成日 | `company_creation_date` | 日時型 | | | 最終更新日 | `company_last_modified_date` | 日時型 | | | 作成担当者ID | `company_creator_id` | 数値型 | | | 作成担当者名 | `company_creator_name` | 文字列型 | | | 最終更新者ID | `company_last_modified_by_id` | 数値型 | | | 最終更新者名 | `company_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'uid=xxxxxxxxxxxxxx&state=xxxxxxxxxxxxxx' "https://api.next-engine.org/api_v1_login_company/info" ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "company_name": "xxxxxxxx", "company_kana": "xxxxxxxx", "company_zip_code": "1500013", "company_address1": "xxxxxxxx", "company_address2": "", "company_post_name": null, "company_pic_name": "xxxxxxxx", "company_mail_address": "xxxx@xxxx.xxx", "company_phone": "0361231231", "company_fax": "", "company_url": "", "company_closing_day": null, "company_last_closing_date": null, "company_fraction_number_digit": "0", "company_fraction_id": "1", "company_fraction_name": "xxxxxxxx", "company_tax_id": "0", "company_tax_name": "xxxxxxxx", "company_temporarily_suspend_flag": "", "company_available_date": "2016-12-19 14:02:20", "company_unavailable_date": "0000-00-00 00:00:00", "company_notice_mail_address": null, "company_buying_type": "0", "company_batch_type": "U", "company_coupon_code": "", "company_type_id": "", "company_ip_address": null, "company_row_order": "0", "company_now_tax_percent": "8", "company_hit_syohin_alert_hour": "0", "company_hit_syohin_alert_quantity": "0", "company_primary_tax_rate_for_discount": "10", "company_invoice_registration_number": "T1234567890123", "company_creation_date": "2017-03-16 19:16:56", "company_last_modified_date": "2017-03-16 19:16:56", "company_creator_id": "0", "company_creator_name": "System", "company_last_modified_by_id": "0", "company_last_modified_by_name": "System", "company_last_modified_null_safe_date": "2017-03-16 19:16:56", "company_last_modified_by_null_safe_id": "0", "company_last_modified_by_null_safe_name": "System", "company_id": "xxxxxxxx", "company_ne_id": "xxxxxxxx", "company_host": "xxxxxxxx", "company_app_header": "xxxxxxxx" } ], "access_token": "xxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_login_company_info/`](/api/operations/api_v1_login_company_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/login_company/`](/guides/fields/login_company/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # ログインユーザー情報取得 URL: https://developer.next-engine.com/api/api_v1_login_user/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_login_user/info Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_login_user/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### ログインユーザー | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | メイン機能担当者ID | `pic_id` | 数値型 | アプリを起動したユーザーの「メイン機能・ユーザー単位」で一意になるID | | 担当者名 | `pic_name` | 文字列型 | | | 担当者カナ | `pic_kana` | 文字列型 | | | 部署名 | `pic_post_name` | 文字列型 | | | 社会保険区分 | `pic_social_insurance_id` | 文字列型 | | | 社会保険名 | `pic_social_insurance_name` | 文字列型 | | | 誕生日 | `pic_birth_date` | 日時型 | | | 郵便番号 | `pic_zip_code` | 文字列型 | | | 住所1 | `pic_address1` | 文字列型 | | | 住所2 | `pic_address2` | 文字列型 | | | 携帯番号 | `pic_mobile` | 文字列型 | | | 電話番号 | `pic_phone` | 文字列型 | | | メールアドレス | `pic_mail_address` | 文字列型 | | | 入社日 | `pic_entering_company_date` | 日時型 | | | 退職日 | `pic_retirement_date` | 日時型 | | | 担当店舗コードリスト | `pic_charge_shop_id_list` | 文字列型 | | | テンプレートフラグ | `pic_template_flag` | 文字列型 | | | スキンカラー | `pic_skin_color` | 文字列型 | | | 言語コード | `pic_language_code` | 文字列型 | | | uid | uid | 文字列型 | アプリを起動したユーザーの「購入アプリ・ユーザー単位」で一意になるID | | ネクストエンジン担当者ID | `pic_ne_id` | 文字列型 | アプリを起動したユーザーの「ユーザー単位」で一意になるID | | 削除フラグ | `pic_deleted_flag` | 文字列型 | | | 作成日 | `pic_creation_date` | 日時型 | | | 最終更新日 | `pic_last_modified_date` | 日時型 | | | 作成担当者ID | `pic_creator_id` | 数値型 | | | 作成担当者名 | `pic_creator_name` | 文字列型 | | | 最終更新者ID | `pic_last_modified_by_id` | 数値型 | | | 最終更新者名 | `pic_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_login_user/info" ``` レスポンス ```json { "result":"success", "count":"1", "data":[ { "pic_id":"10002", "pic_name":"xxxxxxxxxxxxxx", "pic_kana":"xxxxxxxxxxxxxx", "pic_post_name":"xxxxxxxxxxxxxx", "pic_social_insurance_id":null, "pic_social_insurance_name":null, "pic_birth_date":"0000-00-00", "pic_zip_code":"", "pic_address1":"", "pic_address2":"", "pic_mobile":"", "pic_phone":"", "pic_mail_address":"xxxxx@xxxx.xxx", "pic_entering_company_date":"0000-00-00", "pic_retirement_date":"0000-00-00", "pic_charge_shop_id_list":null, "pic_template_flag":"1", "pic_skin_color":null, "pic_language_code":null, "pic_creation_date":"2017-01-11 18:24:04", "pic_last_modified_date":"2017-03-07 15:10:24", "pic_creator_id":"9999", "pic_creator_name":"xxxxxxxxxx", "pic_last_modified_by_id":"10002", "pic_last_modified_by_name":"xxxxxxxxxx", "uid":"xxxxxxxxxxxxxx", "pic_ne_id":xxxxxxxxx" } ], "access_token":"xxxxxxxxxx", "access_token_end_date":"2017-04-13 18:24:53", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_login_user_info/`](/api/operations/api_v1_login_user_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # 商品マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goods/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods/count Tag: 商品マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&goods_id-eq=TestP001' https://api.next-engine.org/api_v1_master_goods/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_count/`](/api/operations/api_v1_master_goods_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_goods/`](/guides/fields/master_goods/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (商品マスタ) - [商品マスタ検索](/api/api_v1_master_goods/search/) — `POST /api_v1_master_goods/search` - [商品マスタアップロード](/api/api_v1_master_goods/upload/) — `POST /api_v1_master_goods/upload` --- # 商品マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_goods/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods/search Tag: 商品マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品画像 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像ID | `goods_image_id` | 数値型 | | | 商品コード | `goods_image_goods_id` | 文字列型 | | | ファイル名 | `goods_image_file_name` | 文字列型 | | | 画像URL(HTTP) | `goods_image_url_http` | 文字列型 | | | 画像URL(HTTPS) | `goods_image_url_https` | 文字列型 | | | サイズ | `goods_image_size` | 数値型 | 単位はバイト。500KB(1024計算)以下 | | 幅 | `goods_image_width` | 数値型 | 単位：ピクセル。2100px以下 | | 高さ | `goods_image_height` | 数値型 | 単位：ピクセル。2100px以下 | | 画像説明 | `goods_image_alt` | 文字列型 | HTMLのimg要素のalt属性 | | 自動変換フラグ | `goods_image_convert_flg` | 数値型 | 自動作成したJPEG画像がある場合、1。このフラグが1の場合、URLはjpg以外が設定されており、拡張子をjpgにしてアクセスすることでjpgファイルにもアクセス出来ます | | 並び順 | `goods_image_display_order` | 文字列型 | | | ファイル状態 | `goods_image_status` | 数値型 | 0:未ダウンロード 1:ダウンロード中 2:ダウンロード済み 3:アップロード済み 4:アップロード中 9:削除済み ※ファイル選択でアップロードされた場合は、1になります | | 削除フラグ | `goods_image_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_creation_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `stock_goods_id` | 文字列型 | | | 在庫数 | `stock_quantity` | 数値型 | | | 引当数 | `stock_allocation_quantity` | 数値型 | | | 不良在庫数 | `stock_defective_quantity` | 数値型 | | | 発注残数 | `stock_remaining_order_quantity` | 数値型 | | | 欠品数 | `stock_out_quantity` | 数値型 | | | フリー在庫数 | `stock_free_quantity` | 数値型 | | | 予約在庫数 | `stock_advance_order_quantity` | 数値型 | | | 予約引当数 | `stock_advance_order_allocation_quantity` | 数値型 | | | 予約フリー在庫数 | `stock_advance_order_free_quantity` | 数値型 | | | 削除フラグ | `stock_deleted_flag` | 文字列型 | | | 作成日 | `stock_creation_date` | 日時型 | | | 最終更新日 | `stock_last_modified_date` | 日時型 | | | 最終更新日 | `stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_creator_id` | 数値型 | | | 作成担当者名 | `stock_creator_name` | 文字列型 | | | 最終更新者ID | `stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 仕入先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入先コード | `supplier_id` | 文字列型 | | | 仕入先名 | `supplier_name` | 文字列型 | | | 仕入先カナ | `supplier_kana` | 文字列型 | | | 郵便番号 | `supplier_zip_code` | 文字列型 | | | 住所１ | `supplier_address1` | 文字列型 | | | 住所２ | `supplier_address2` | 文字列型 | | | 電話番号 | `supplier_tel` | 文字列型 | | | FAX番号 | `supplier_fax` | 文字列型 | | | メールアドレス | `supplier_mail_address` | 文字列型 | | | 部署名 | `supplier_post` | 文字列型 | | | 担当者名 | `supplier_pic_name` | 文字列型 | | | 担当者カナ | `supplier_pic_kana` | 文字列型 | | | 部署郵便番号 | `supplier_post_zip_code` | 文字列型 | | | 部署住所１ | `supplier_post_address1` | 文字列型 | | | 部署住所２ | `supplier_post_address2` | 文字列型 | | | 部署電話番号 | `supplier_post_tel` | 文字列型 | | | 部署FAX | `supplier_post_fax` | 文字列型 | | | 部署メールアドレス | `supplier_post_mail_address` | 文字列型 | | | 発注区分 | `supplier_order_id` | 文字列型 | | | 発注名 | `supplier_order_name` | 文字列型 | | | 数量条件 | `supplier_condition_quantity` | 数値型 | | | 金額条件 | `supplier_condition_money` | 数値型 | | | 発注条件区分 | `supplier_order_condition_id` | 文字列型 | | | 発注条件名 | `supplier_order_condition_name` | 文字列型 | | | 発注保留日 | `supplier_order_pending_date` | 文字列型 | | | 支払方法区分 | `supplier_pay_out_id` | 文字列型 | | | 支払方法名 | `supplier_pay_out_name` | 文字列型 | | | 締日 | `supplier_closing_day` | 文字列型 | | | 支払サイト日 | `supplier_usance_date` | 文字列型 | | | 発注無効フラグ | `supplier_order_invalid_flag` | 文字列型 | | | 発注禁止日 | `supplier_order_forbid_date` | 日時型 | | | 備考 | `supplier_note` | 文字列型 | | | 掛率 | `supplier_wholesale_retail_ratio` | 数値型 | | | 削除フラグ | `supplier_deleted_flag` | 文字列型 | | | 作成日 | `supplier_creation_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supplier_creator_id` | 数値型 | | | 作成担当者名 | `supplier_creator_name` | 文字列型 | | | 最終更新者ID | `supplier_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supplier_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supplier_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supplier_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 納期 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 納期ID | `delivery_date_id` | 文字列型 | | | 納期名 | `delivery_date_name` | 文字列型 | | | 納期日数 | `delivery_date_days` | 文字列型 | | | 備考 | `delivery_date_note` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=goods_id,goods_name,stock_quantity,supplier_name&goods_id-eq=TestP001&offset=0&limit=100' https://api.next-engine.org/api_v1_master_goods/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "goods_id": "TestP001", "goods_name": "登録時必須", "stock_quantity": "27", "supplier_name": "設定なし" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_search/`](/api/operations/api_v1_master_goods_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_goods/`](/guides/fields/master_goods/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (商品マスタ) - [商品マスタ件数取得](/api/api_v1_master_goods/count/) — `POST /api_v1_master_goods/count` - [商品マスタアップロード](/api/api_v1_master_goods/upload/) — `POST /api_v1_master_goods/upload` --- # 商品マスタアップロード URL: https://developer.next-engine.com/api/api_v1_master_goods/upload/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods/upload Tag: 商品マスタ Required parameters: access_token, data_type, data Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods/upload` ## リファレンス内容 ### 商品マスタ予約一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は商品管理の一括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | csv:商品マスタCSV,gz:商品マスタCSVをGZIPで圧縮 | | `data` | 商品マスタCSVのファイル内容 | 必須 | メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8） | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&data_type=csv&data=syohin_code,sire_code,jan_code,maker_name,maker_kana,maker_jyusyo,maker_yubin_bangou,kataban,iro,syohin_name,gaikoku_syohin_name,syohin_kbn,toriatukai_kbn,genka_tnk,hyoji_tnk,baika_tnk,gaikoku_baika_tnk,kake_ritu,omosa,haba,okuyuki,takasa,yusou_kbn,syohin_status_kbn,hatubai_bi,zaiko_teisu,hachu_ten,lot,keisai_tantou,keisai_bi,bikou,daihyo_syohin_code,visible_flg,mail_tag,tag,location,mail_send_flg,mail_send_num,gift_ok_flg,size,org_select1,org_select2,org_select3,org_select4,org_select5,org_select6,org_select7,org_select8,org_select9,org_select10,org1,org2,org3,org4,org5,org6,org7,org8,org9,org10,org11,org12,org13,org14,org15,org16,org17,org18,org19,org20,maker_kataban,zaiko_threshold,orosi_threshold,hasou_houhou_kbn,hasoumoto_code,zaiko_su,yoyaku_zaiko_su,nyusyukko_riyu,hit_syohin_alert_quantity,nouki_kbn,nouki_sitei_bi,syohin_setumei_html,syohin_setumei_text,spec_html,spec_text,chui_jiko_html,chui_jiko_text,syohin_jyotai_kbn,syohin_jyotai_setumei,category_code_yauc,category_text,image_url_http,image_alt TestP001,9999,,,,,,,,登録時必須,,0,0,120000,,150000,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ' https://api.next-engine.org/api_v1_master_goods/upload ``` レスポンス ```json { "result": "success", "que_id": "189", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_upload/`](/api/operations/api_v1_master_goods_upload/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_goods/`](/guides/fields/master_goods/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (商品マスタ) - [商品マスタ件数取得](/api/api_v1_master_goods/count/) — `POST /api_v1_master_goods/count` - [商品マスタ検索](/api/api_v1_master_goods/search/) — `POST /api_v1_master_goods/search` --- # 商品ページ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goods_page/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page/count Tag: 商品ページ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品ページ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | 代表商品コードがある商品は、代表商品コードが設定されています。代表商品コードがない商品は、商品コードが設定されています。 | | 掲載商品名 | `goods_page_goods_name` | 文字列型 | | | 公開・非公開 | `goods_page_display_flag` | 数値型 | 0:非公開, 1:公開 | | キャッチコピー1 | `goods_page_catch_phrase1` | 文字列型 | | | キャッチコピー2 | `goods_page_catch_phrase2` | 文字列型 | | | キーワード | `goods_page_keyword` | 文字列型 | | | 項目選択肢 横軸名 | `goods_page_v_horizontal_category` | 文字列型 | | | 項目選択肢 縦軸名 | `goods_page_v_vertical_category` | 文字列型 | | | セール価格 | `goods_page_sale_amount` | 数値型 | | | セール開始日 | `goods_page_sale_start_date` | 日付型 | | | セール開始時間 | `goods_page_sale_start_time` | 時間型 | | | セール終了日 | `goods_page_sale_end_date` | 日付型 | | | セール終了時間 | `goods_page_sale_end_time` | 時間型 | | | 関連商品 | `goods_page_related_goods` | 文字列型 | | | 送料区分 | `goods_page_postage_type` | 数値型 | 0:送料別（個別）, 1:送料別（通常）, 2:送料込（無料）, 3:その他 | | 個別送料 | `goods_page_postage_amount` | 数値型 | | | 代引料（代引区分） | `goods_page_cash_on_delivery_type` | 数値型 | 0:代引料別（個別）, 1:代引料込（無料） | | 代引料（個別代引料） | `goods_page_cash_on_delivery_amount` | 数値型 | | | 注文受付区分 | `goods_page_order_type` | 数値型 | 0:指定しない（自由入力）, 1:指定欄なし（1個限定）, 2:個数選択（プルダウン） | | 注文受付数 | `goods_page_order_amount` | 数値型 | 注文受付区分:2 の場合のみ有効 | | 在庫表示 | `goods_page_stock_display_type` | 数値型 | 0:残り在庫数表示しない, 1:残り在庫数表示する, 2:在庫僅少表示 | | 在庫僅少表示閾値 | `goods_page_stock_display_threshold` | 数値型 | 在庫僅少表示閾値:2 の場合のみ有効 | | ポイント | `goods_page_point` | 数値型 | | | 表示順位 | `goods_page_display_order` | 数値型 | | | シークレットパスワード | `goods_page_secret_password` | 文字列型 | | | モール基本カテゴリID | `goods_page_mall_category_id` | 文字列型 | | | 説明文1（PC） | `goods_page_description1` | META型 | | | 説明文2（スマホ） | `goods_page_description2` | META型 | | | 説明文3（モバイル） | `goods_page_description3` | META型 | | | 説明文4 | `goods_page_description4` | META型 | | | 説明文5 | `goods_page_description5` | META型 | | | 説明文6 | `goods_page_description6` | META型 | | | 説明文7 | `goods_page_description7` | META型 | | | 説明文8 | `goods_page_description8` | META型 | | | 説明文9 | `goods_page_description9` | META型 | | | 説明文10 | `goods_page_description10` | META型 | | | 画像URL1 | `goods_page_img1_src` | META型 | | | 画像URL2 | `goods_page_img2_src` | META型 | | | 画像URL3 | `goods_page_img3_src` | META型 | | | 画像URL4 | `goods_page_img4_src` | META型 | | | 画像URL5 | `goods_page_img5_src` | META型 | | | 画像URL6 | `goods_page_img6_src` | META型 | | | 画像URL7 | `goods_page_img7_src` | META型 | | | 画像URL8 | `goods_page_img8_src` | META型 | | | 画像URL9 | `goods_page_img9_src` | META型 | | | 画像URL10 | `goods_page_img10_src` | META型 | | | 画像URL11 | `goods_page_img11_src` | META型 | | | 画像URL12 | `goods_page_img12_src` | META型 | | | 画像URL13 | `goods_page_img13_src` | META型 | | | 画像URL14 | `goods_page_img14_src` | META型 | | | 画像URL15 | `goods_page_img15_src` | META型 | | | 画像URL16 | `goods_page_img16_src` | META型 | | | 画像URL17 | `goods_page_img17_src` | META型 | | | 画像URL18 | `goods_page_img18_src` | META型 | | | 画像URL19 | `goods_page_img19_src` | META型 | | | 画像URL20 | `goods_page_img20_src` | META型 | | | 画像URL1 ALT | `goods_page_img1_alt` | META型 | | | 画像URL2 ALT | `goods_page_img2_alt` | META型 | | | 画像URL3 ALT | `goods_page_img3_alt` | META型 | | | 画像URL4 ALT | `goods_page_img4_alt` | META型 | | | 画像URL5 ALT | `goods_page_img5_alt` | META型 | | | 画像URL6 ALT | `goods_page_img6_alt` | META型 | | | 画像URL7 ALT | `goods_page_img7_alt` | META型 | | | 画像URL8 ALT | `goods_page_img8_alt` | META型 | | | 画像URL9 ALT | `goods_page_img9_alt` | META型 | | | 画像URL10 ALT | `goods_page_img10_alt` | META型 | | | 画像URL11 ALT | `goods_page_img11_alt` | META型 | | | 画像URL12 ALT | `goods_page_img12_alt` | META型 | | | 画像URL13 ALT | `goods_page_img13_alt` | META型 | | | 画像URL14 ALT | `goods_page_img14_alt` | META型 | | | 画像URL15 ALT | `goods_page_img15_alt` | META型 | | | 画像URL16 ALT | `goods_page_img16_alt` | META型 | | | 画像URL17 ALT | `goods_page_img17_alt` | META型 | | | 画像URL18 ALT | `goods_page_img18_alt` | META型 | | | 画像URL19 ALT | `goods_page_img19_alt` | META型 | | | 画像URL20 ALT | `goods_page_img20_alt` | META型 | | | スペック1 | `goods_page_spec1` | META型 | | | スペック2 | `goods_page_spec2` | META型 | | | スペック3 | `goods_page_spec3` | META型 | | | スペック4 | `goods_page_spec4` | META型 | | | スペック5 | `goods_page_spec5` | META型 | | | フリーエリア1 | `goods_page_free1` | META型 | | | フリーエリア2 | `goods_page_free2` | META型 | | | フリーエリア3 | `goods_page_free3` | META型 | | | フリーエリア4 | `goods_page_free4` | META型 | | | フリーエリア5 | `goods_page_free5` | META型 | | | フリーエリア6 | `goods_page_free6` | META型 | | | フリーエリア7 | `goods_page_free7` | META型 | | | フリーエリア8 | `goods_page_free8` | META型 | | | フリーエリア9 | `goods_page_free9` | META型 | | | フリーエリア10 | `goods_page_free10` | META型 | | | 掲載ステータス | `goods_page_publication_status_id` | 数値型 | 1：新規登録, 2：編集中, 3：アップロード予定, 4：掲載済み | | 掲載日 | `goods_page_publication_date` | 日時型 | | | 作成日 | `goods_page_creation_date` | 日時型 | | | 最終更新日 | `goods_page_last_modified_date` | 日時型 | | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_goods_page/count -H 'cache-control: no-cache' -F access_token=xxxxxxxxxx -F refresh_token=xxxxxxxxxx -F wait_flag=1 -F goods_page_goods_code-like=%syohin ``` ```json { "result": "success", "count": "xxx", "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_count/`](/api/operations/api_v1_master_goods_page_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ) - [商品ページ検索](/api/api_v1_master_goods_page/search/) — `POST /api_v1_master_goods_page/search` --- # 商品ページ検索 URL: https://developer.next-engine.com/api/api_v1_master_goods_page/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page/search Tag: 商品ページ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, extension_execution_id ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `extension_execution_id` | 拡張機能実行ID | 可能 | 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。 | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時600) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは 成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品ページ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | 代表商品コードがある商品は、代表商品コードが設定されています。代表商品コードがない商品は、商品コードが設定されています。 | | 掲載商品名 | `goods_page_goods_name` | 文字列型 | | | 公開・非公開 | `goods_page_display_flag` | 数値型 | 0:非公開, 1:公開 | | キャッチコピー1 | `goods_page_catch_phrase1` | 文字列型 | | | キャッチコピー2 | `goods_page_catch_phrase2` | 文字列型 | | | キーワード | `goods_page_keyword` | 文字列型 | | | 項目選択肢 横軸名 | `goods_page_v_horizontal_category` | 文字列型 | | | 項目選択肢 縦軸名 | `goods_page_v_vertical_category` | 文字列型 | | | セール価格 | `goods_page_sale_amount` | 数値型 | | | セール開始日 | `goods_page_sale_start_date` | 日付型 | | | セール開始時間 | `goods_page_sale_start_time` | 時間型 | | | セール終了日 | `goods_page_sale_end_date` | 日付型 | | | セール終了時間 | `goods_page_sale_end_time` | 時間型 | | | 関連商品 | `goods_page_related_goods` | 文字列型 | | | 送料区分 | `goods_page_postage_type` | 数値型 | 0:送料別（個別）, 1:送料別（通常）, 2:送料込（無料）, 3:その他 | | 個別送料 | `goods_page_postage_amount` | 数値型 | | | 代引料（代引区分） | `goods_page_cash_on_delivery_type` | 数値型 | 0:代引料別（個別）, 1:代引料込（無料） | | 代引料（個別代引料） | `goods_page_cash_on_delivery_amount` | 数値型 | | | 注文受付区分 | `goods_page_order_type` | 数値型 | 0:指定しない（自由入力）, 1:指定欄なし（1個限定）, 2:個数選択（プルダウン） | | 注文受付数 | `goods_page_order_amount` | 数値型 | 注文受付区分:2 の場合のみ有効 | | 在庫表示 | `goods_page_stock_display_type` | 数値型 | 0:残り在庫数表示しない, 1:残り在庫数表示する, 2:在庫僅少表示 | | 在庫僅少表示閾値 | `goods_page_stock_display_threshold` | 数値型 | 在庫僅少表示閾値:2 の場合のみ有効 | | ポイント | `goods_page_point` | 数値型 | | | 表示順位 | `goods_page_display_order` | 数値型 | | | シークレットパスワード | `goods_page_secret_password` | 文字列型 | | | モール基本カテゴリID | `goods_page_mall_category_id` | 文字列型 | | | 説明文1（PC） | `goods_page_description1` | META型 | | | 説明文2（スマホ） | `goods_page_description2` | META型 | | | 説明文3（モバイル） | `goods_page_description3` | META型 | | | 説明文4 | `goods_page_description4` | META型 | | | 説明文5 | `goods_page_description5` | META型 | | | 説明文6 | `goods_page_description6` | META型 | | | 説明文7 | `goods_page_description7` | META型 | | | 説明文8 | `goods_page_description8` | META型 | | | 説明文9 | `goods_page_description9` | META型 | | | 説明文10 | `goods_page_description10` | META型 | | | 画像URL1 | `goods_page_img1_src` | META型 | | | 画像URL2 | `goods_page_img2_src` | META型 | | | 画像URL3 | `goods_page_img3_src` | META型 | | | 画像URL4 | `goods_page_img4_src` | META型 | | | 画像URL5 | `goods_page_img5_src` | META型 | | | 画像URL6 | `goods_page_img6_src` | META型 | | | 画像URL7 | `goods_page_img7_src` | META型 | | | 画像URL8 | `goods_page_img8_src` | META型 | | | 画像URL9 | `goods_page_img9_src` | META型 | | | 画像URL10 | `goods_page_img10_src` | META型 | | | 画像URL11 | `goods_page_img11_src` | META型 | | | 画像URL12 | `goods_page_img12_src` | META型 | | | 画像URL13 | `goods_page_img13_src` | META型 | | | 画像URL14 | `goods_page_img14_src` | META型 | | | 画像URL15 | `goods_page_img15_src` | META型 | | | 画像URL16 | `goods_page_img16_src` | META型 | | | 画像URL17 | `goods_page_img17_src` | META型 | | | 画像URL18 | `goods_page_img18_src` | META型 | | | 画像URL19 | `goods_page_img19_src` | META型 | | | 画像URL20 | `goods_page_img20_src` | META型 | | | 画像URL1 ALT | `goods_page_img1_alt` | META型 | | | 画像URL2 ALT | `goods_page_img2_alt` | META型 | | | 画像URL3 ALT | `goods_page_img3_alt` | META型 | | | 画像URL4 ALT | `goods_page_img4_alt` | META型 | | | 画像URL5 ALT | `goods_page_img5_alt` | META型 | | | 画像URL6 ALT | `goods_page_img6_alt` | META型 | | | 画像URL7 ALT | `goods_page_img7_alt` | META型 | | | 画像URL8 ALT | `goods_page_img8_alt` | META型 | | | 画像URL9 ALT | `goods_page_img9_alt` | META型 | | | 画像URL10 ALT | `goods_page_img10_alt` | META型 | | | 画像URL11 ALT | `goods_page_img11_alt` | META型 | | | 画像URL12 ALT | `goods_page_img12_alt` | META型 | | | 画像URL13 ALT | `goods_page_img13_alt` | META型 | | | 画像URL14 ALT | `goods_page_img14_alt` | META型 | | | 画像URL15 ALT | `goods_page_img15_alt` | META型 | | | 画像URL16 ALT | `goods_page_img16_alt` | META型 | | | 画像URL17 ALT | `goods_page_img17_alt` | META型 | | | 画像URL18 ALT | `goods_page_img18_alt` | META型 | | | 画像URL19 ALT | `goods_page_img19_alt` | META型 | | | 画像URL20 ALT | `goods_page_img20_alt` | META型 | | | スペック1 | `goods_page_spec1` | META型 | | | スペック2 | `goods_page_spec2` | META型 | | | スペック3 | `goods_page_spec3` | META型 | | | スペック4 | `goods_page_spec4` | META型 | | | スペック5 | `goods_page_spec5` | META型 | | | フリーエリア1 | `goods_page_free1` | META型 | | | フリーエリア2 | `goods_page_free2` | META型 | | | フリーエリア3 | `goods_page_free3` | META型 | | | フリーエリア4 | `goods_page_free4` | META型 | | | フリーエリア5 | `goods_page_free5` | META型 | | | フリーエリア6 | `goods_page_free6` | META型 | | | フリーエリア7 | `goods_page_free7` | META型 | | | フリーエリア8 | `goods_page_free8` | META型 | | | フリーエリア9 | `goods_page_free9` | META型 | | | フリーエリア10 | `goods_page_free10` | META型 | | | 掲載ステータス | `goods_page_publication_status_id` | 数値型 | 1：新規登録, 2：編集中, 3：アップロード予定, 4：掲載済み | | 掲載日 | `goods_page_publication_date` | 日時型 | | | 作成日 | `goods_page_creation_date` | 日時型 | | | 最終更新日 | `goods_page_last_modified_date` | 日時型 | | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_goods_page/search -H 'cache-control: no-cache' -F access_token=xxxxxxxx -F refresh_token=xxxxxxx -F wait_flag=1 -F 'fields=goods_page_goods_code,goods_page_goods_name,goods_page_display_flag,goods_page_catch_phrase1,goods_page_catch_phrase2,goods_page_keyword,goods_page_v_horizontal_category,goods_page_v_vertical_category,goods_page_sale_amount,goods_page_sale_start_date,goods_page_sale_start_time,goods_page_sale_end_date,goods_page_sale_end_time,goods_page_related_goods,goods_page_postage_type,goods_page_postage_amount,goods_page_cash_on_delivery_type,goods_page_cash_on_delivery_amount,goods_page_order_type,goods_page_order_amount,goods_page_stock_display_type,goods_page_stock_display_threshold,goods_page_point,goods_page_display_order,goods_page_secret_password,goods_page_mall_category_id,goods_page_description1,goods_page_description2,goods_page_description3,goods_page_description4,goods_page_description5,goods_page_description6,goods_page_description7,goods_page_description8,goods_page_description9,goods_page_description10,goods_page_img1_src,goods_page_img2_src,goods_page_img3_src,goods_page_img4_src,goods_page_img5_src,goods_page_img6_src,goods_page_img7_src,goods_page_img8_src,goods_page_img9_src,goods_page_img10_src,goods_page_img11_src,goods_page_img12_src,goods_page_img13_src,goods_page_img14_src,goods_page_img15_src,goods_page_img16_src,goods_page_img17_src,goods_page_img18_src,goods_page_img19_src,goods_page_img20_src,goods_page_img1_alt,goods_page_img2_alt,goods_page_img3_alt,goods_page_img4_alt,goods_page_img5_alt,goods_page_img6_alt,goods_page_img7_alt,goods_page_img8_alt,goods_page_img9_alt,goods_page_img10_alt,goods_page_img11_alt,goods_page_img12_alt,goods_page_img13_alt,goods_page_img14_alt,goods_page_img15_alt,goods_page_img16_alt,goods_page_img17_alt,goods_page_img18_alt,goods_page_img19_alt,goods_page_img20_alt,goods_page_spec1,goods_page_spec2,goods_page_spec3,goods_page_spec4,goods_page_spec5,goods_page_free1,goods_page_free2,goods_page_free3,goods_page_free4,goods_page_free5,goods_page_free6,goods_page_free7,goods_page_free8,goods_page_free9,goods_page_free10,goods_page_publication_status_id,goods_page_publication_date,goods_page_creation_date,goods_page_last_modified_date' -F offset=0 -F limit=1 -F goods_page_goods_code-like=%test-0% ``` ```json { "result": "success", "data": [ { "goods_page_goods_code": "test-01", "goods_page_goods_name": "test-01-name", "goods_page_display_flag": "1", "goods_page_catch_phrase1": "", "goods_page_catch_phrase2": "", "goods_page_keyword": "", "goods_page_v_horizontal_category": "", "goods_page_v_vertical_category": "", "goods_page_sale_amount": "", "goods_page_sale_start_date": "0000-00-00", "goods_page_sale_start_time": "00:00:00", "goods_page_sale_end_date": "0000-00-00", "goods_page_sale_end_time": "00:00:00", "goods_page_related_goods": "", "goods_page_postage_type": "", "goods_page_postage_amount": "", "goods_page_cash_on_delivery_type": "", "goods_page_cash_on_delivery_amount": "", "goods_page_order_type": "", "goods_page_order_amount": "", "goods_page_stock_display_type": "", "goods_page_stock_display_threshold": "", "goods_page_point": "", "goods_page_display_order": "", "goods_page_secret_password": "", "goods_page_mall_category_id": "", "goods_page_description1": "", "goods_page_description2": "", "goods_page_description3": "", "goods_page_description4": "", "goods_page_description5": "", "goods_page_description6": "", "goods_page_description7": "", "goods_page_description8": "", "goods_page_description9": "", "goods_page_description10": "", "goods_page_img1_src": "", "goods_page_img2_src": "", "goods_page_img3_src": "", "goods_page_img4_src": "", "goods_page_img5_src": "", "goods_page_img6_src": "", "goods_page_img7_src": "", "goods_page_img8_src": "", "goods_page_img9_src": "", "goods_page_img10_src": "", "goods_page_img11_src": "", "goods_page_img12_src": "", "goods_page_img13_src": "", "goods_page_img14_src": "", "goods_page_img15_src": "", "goods_page_img16_src": "", "goods_page_img17_src": "", "goods_page_img18_src": "", "goods_page_img19_src": "", "goods_page_img20_src": "", "goods_page_img1_alt": "", "goods_page_img2_alt": "", "goods_page_img3_alt": "", "goods_page_img4_alt": "", "goods_page_img5_alt": "", "goods_page_img6_alt": "", "goods_page_img7_alt": "", "goods_page_img8_alt": "", "goods_page_img9_alt": "", "goods_page_img10_alt": "", "goods_page_img11_alt": "", "goods_page_img12_alt": "", "goods_page_img13_alt": "", "goods_page_img14_alt": "", "goods_page_img15_alt": "", "goods_page_img16_alt": "", "goods_page_img17_alt": "", "goods_page_img18_alt": "", "goods_page_img19_alt": "", "goods_page_img20_alt": "", "goods_page_spec1": "", "goods_page_spec2": "", "goods_page_spec3": "", "goods_page_spec4": "", "goods_page_spec5": "", "goods_page_free1": "", "goods_page_free2": "", "goods_page_free3": "", "goods_page_free4": "", "goods_page_free5": "", "goods_page_free6": "", "goods_page_free7": "", "goods_page_free8": "", "goods_page_free9": "", "goods_page_free10": "", "goods_page_publication_status_id": 1, "goods_page_publication_date": "", "goods_page_creation_date": "2019-02-28 14:57:12", "goods_page_last_modified_date": "2019-02-28 14:57:12" } ], "count": 1, "access_token": "xxxxxxxxxx", "access_token_end_date": "2021-06-26 08:13:52", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2021-06-28 08:13:52" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_search/`](/api/operations/api_v1_master_goods_page_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ) - [商品ページ件数取得](/api/api_v1_master_goods_page/count/) — `POST /api_v1_master_goods_page/count` --- # 商品ページ(オプション)件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_option/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_option/count Tag: 商品ページ(オプション) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_option/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品ページ(オプション) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | オプション 項目名 | `goods_page_o_option_name` | 文字列型 | | | オプション 選択肢 | `goods_page_o_option_value` | 文字列型 | | | タイプ | `goods_page_o_type` | 文字列型 | s：セレクトボックス, c：チェックボックス, f：フリーテキスト | | 表示順 | `goods_page_o_display_order` | 数値型 | | | 作成日 | `goods_page_o_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_o_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_o_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_o_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_o_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_o_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_option/count ``` レスポンス ```json { "result": "success", "count": "xxx", "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_option_count/`](/api/operations/api_v1_master_goods_page_option_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(オプション)) - [商品ページ(オプション)検索](/api/api_v1_master_goods_page_option/search/) — `POST /api_v1_master_goods_page_option/search` --- # 商品ページ(オプション)検索 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_option/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_option/search Tag: 商品ページ(オプション) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_option/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品ページ(オプション) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | オプション 項目名 | `goods_page_o_option_name` | 文字列型 | | | オプション 選択肢 | `goods_page_o_option_value` | 文字列型 | | | タイプ | `goods_page_o_type` | 文字列型 | s：セレクトボックス, c：チェックボックス, f：フリーテキスト | | 表示順 | `goods_page_o_display_order` | 数値型 | | | 作成日 | `goods_page_o_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_o_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_o_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_o_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_o_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_o_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=yyy&wait_flag=1&fields=goods_page_goods_code,goods_page_o_option_name,goods_page_o_option_value,goods_page_o_type,goods_page_o_display_order,goods_page_o_creation_date,goods_page_o_creator_id,goods_page_o_creator_name,goods_page_o_last_modified_date,goods_page_o_last_modified_by_id,goods_page_o_last_modified_by_name&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_option/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "goods_page_goods_code": "syohin", "goods_page_o_option_name": "ラッピング", "goods_page_o_option_value": "希望する", "goods_page_o_type": "s", "goods_page_o_display_order": "1", "goods_page_o_creation_date": "2021-08-12 15:18:17", "goods_page_o_creator_id": "2", "goods_page_o_creator_name": "xxx", "goods_page_o_last_modified_date": "2021-08-12 15:18:17", "goods_page_o_last_modified_by_id": "2", "goods_page_o_last_modified_by_name": "xxx" }, { "goods_page_goods_code": "syohin", "goods_page_o_option_category": "ラッピング", "goods_page_o_option_name": "希望しない", "goods_page_o_type": "s", "goods_page_o_display_order": "2", "goods_page_o_creation_date": "2021-08-12 15:18:17", "goods_page_o_creator_id": "2", "goods_page_o_creator_name": "xxx", "goods_page_o_last_modified_date": "2021-08-12 15:18:17", "goods_page_o_last_modified_by_id": "2", "goods_page_o_last_modified_by_name": "xxx" } ] "access_token": "xxx", "access_token_end_date": "2021-08-13 05:32:55", "refresh_token": "xxx" "refresh_token_end_date": "2021-08-13 05:32:55" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_option_search/`](/api/operations/api_v1_master_goods_page_option_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(オプション)) - [商品ページ(オプション)件数取得](/api/api_v1_master_goods_page_option/count/) — `POST /api_v1_master_goods_page_option/count` --- # 商品ページ(カテゴリ)件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_shopcategory/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_shopcategory/count Tag: 商品ページ(カテゴリ) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_shopcategory/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品ページ(カテゴリ) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | 店舗内カテゴリ名 | `goods_page_shop_c_shop_category_name` | 文字列型 | | | 表示順 | `goods_page_shop_c_display_order` | 数値型 | | | 作成日 | `goods_page_shop_c_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_shop_c_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_shop_c_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_shop_c_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_shop_c_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_shop_c_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_shopcategory/count ``` レスポンス ```json { "result": "success", "count": "xxx", "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_shopcategory_count/`](/api/operations/api_v1_master_goods_page_shopcategory_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(カテゴリ)) - [商品ページ(カテゴリ)検索](/api/api_v1_master_goods_page_shopcategory/search/) — `POST /api_v1_master_goods_page_shopcategory/search` --- # 商品ページ(カテゴリ)検索 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_shopcategory/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_shopcategory/search Tag: 商品ページ(カテゴリ) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_shopcategory/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品ページ(カテゴリ) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | 店舗内カテゴリ名 | `goods_page_shop_c_shop_category_name` | 文字列型 | | | 表示順 | `goods_page_shop_c_display_order` | 数値型 | | | 作成日 | `goods_page_shop_c_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_shop_c_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_shop_c_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_shop_c_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_shop_c_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_shop_c_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=yyy&wait_flag=1&fields=goods_page_goods_code,goods_page_shop_c_shop_category_name,goods_page_shop_c_display_order,goods_page_shop_c_creation_date,goods_page_shop_c_creator_id,goods_page_shop_c_creator_name,goods_page_shop_c_last_modified_date,goods_page_shop_c_last_modified_by_id,goods_page_shop_c_last_modified_by_name&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_shopcategory/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "goods_page_goods_code": "hoge", "goods_page_shop_c_shop_category_name": "カテゴリトップ¥レディスファッション¥Tシャツ¥半袖", "goods_page_shop_c_display_order": "1", "goods_page_shop_c_creation_date": "2021-08-12 15:36:02", "goods_page_shop_c_creator_id": "2", "goods_page_shop_c_creator_name": "xxx", "goods_page_shop_c_last_modified_date": "2021-08-12 15:36:02", "goods_page_shop_c_last_modified_by_id": "2", "goods_page_shop_c_last_modified_by_name": "xxx" } ], "access_token": "xxx", "access_token_end_date": "2021-08-13 05:32:55", "refresh_token": "xxx" "refresh_token_end_date": "2021-08-13 05:32:55" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_shopcategory_search/`](/api/operations/api_v1_master_goods_page_shopcategory_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(カテゴリ)) - [商品ページ(カテゴリ)件数取得](/api/api_v1_master_goods_page_shopcategory/count/) — `POST /api_v1_master_goods_page_shopcategory/count` --- # 商品ページ(バリエーション)件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_variation/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_variation/count Tag: 商品ページ(バリエーション) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_variation/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品ページ(バリエーション) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | 項目選択肢 横軸選択肢 | `goods_page_v_horizontal_name` | 文字列型 | | | 項目選択肢 横軸選択肢番号 | `goods_page_v_horizontal_value` | 文字列型 | | | 項目選択肢 縦軸選択肢 | `goods_page_v_vertical_name` | 文字列型 | | | 項目選択肢 縦軸選択肢番号 | `goods_page_v_vertical_value` | 文字列型 | | | 表示順 | `goods_page_v_display_order` | 数値型 | | | 作成日 | `goods_page_v_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_v_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_v_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_v_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_v_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_v_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_variation/count ``` レスポンス ```json { "result": "success", "count": "xxx", "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_variation_count/`](/api/operations/api_v1_master_goods_page_variation_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(バリエーション)) - [商品ページ(バリエーション)検索](/api/api_v1_master_goods_page_variation/search/) — `POST /api_v1_master_goods_page_variation/search` --- # 商品ページ(バリエーション)検索 URL: https://developer.next-engine.com/api/api_v1_master_goods_page_variation/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goods_page_variation/search Tag: 商品ページ(バリエーション) Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goods_page_variation/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品ページ(バリエーション) | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページコード（商品コードまたは代表商品コード） | `goods_page_goods_code` | 文字列型 | | | 項目選択肢 横軸選択肢 | `goods_page_v_horizontal_name` | 文字列型 | | | 項目選択肢 横軸選択肢番号 | `goods_page_v_horizontal_value` | 文字列型 | | | 項目選択肢 縦軸選択肢 | `goods_page_v_vertical_name` | 文字列型 | | | 項目選択肢 縦軸選択肢番号 | `goods_page_v_vertical_value` | 文字列型 | | | 表示順 | `goods_page_v_display_order` | 数値型 | | | 作成日 | `goods_page_v_creation_date` | 日時型 | | | 作成担当者ID | `goods_page_v_creator_id` | 数値型 | | | 作成担当者名 | `goods_page_v_creator_name` | 文字列型 | | | 最終更新日 | `goods_page_v_last_modified_date` | 日時型 | | | 最終更新者ID | `goods_page_v_last_modified_by_id` | 数値型 | | | 最終更新者名 | `goods_page_v_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=yyy&wait_flag=1&ffields=goods_page_goods_code,goods_page_v_horizontal_name, goods_page_v_horizontal_value, goods_page_v_vertical_name, goods_page_v_vertical_value, goods_page_v_display_order, goods_page_v_creation_date, goods_page_v_creator_id, goods_page_v_creator_name, goods_page_v_last_modified_date, goods_page_v_last_modified_by_id , goods_page_v_last_modified_by_name&goods_page_goods_code-eq=syohin' https://api.next-engine.org/api_v1_master_goods_page_variation/search ``` レスポンス ```json { "result": "success", "count": "4", "data": [ { "goods_page_goods_code": "syohin", "goods_page_v_horizontal_name": "あか", "goods_page_v_horizontal_value": "-red", "goods_page_v_vertical_name": "s", "goods_page_v_vertical_value": "-s", "goods_page_v_display_order": "1", "goods_page_v_creation_date": "2021-08-06 05:56:45", "goods_page_v_creator_id": "2", "goods_page_v_creator_name": "xxx", "goods_page_v_last_modified_date": "2021-08-06 05:56:45", "goods_page_v_last_modified_by_id": "2", "goods_page_v_last_modified_by_name": "xxx" }, { "goods_page_goods_code": "syohin", "goods_page_v_horizontal_name": "あか", "goods_page_v_horizontal_value": "-red", "goods_page_v_vertical_name": "m", "goods_page_v_vertical_value": "-m", "goods_page_v_display_order": "2", "goods_page_v_creation_date": "2021-08-06 05:56:45", "goods_page_v_creator_id": "2", "goods_page_v_creator_name": "xxx", "goods_page_v_last_modified_date": "2021-08-06 05:56:45", "goods_page_v_last_modified_by_id": "2", "goods_page_v_last_modified_by_name": "xxx" }, { "goods_page_goods_code": "syohin", "goods_page_v_horizontal_name": "青", "goods_page_v_horizontal_value": "-blue", "goods_page_v_vertical_name": "s", "goods_page_v_vertical_value": "-s", "goods_page_v_display_order": "3", "goods_page_v_creation_date": "2021-08-06 05:56:45", "goods_page_v_creator_id": "2", "goods_page_v_creator_name": "xxx", "goods_page_v_last_modified_date": "2021-08-06 05:56:45", "goods_page_v_last_modified_by_id": "2", "goods_page_v_last_modified_by_name": "xxx" }, { "goods_page_goods_code": "syohin", "goods_page_v_horizontal_name": "青", "goods_page_v_horizontal_value": "-blue", "goods_page_v_vertical_name": "m", "goods_page_v_vertical_value": "-m", "goods_page_v_display_order": "4", "goods_page_v_creation_date": "2021-08-06 05:56:45", "goods_page_v_creator_id": "2", "goods_page_v_creator_name": "xxx", "goods_page_v_last_modified_date": "2021-08-06 05:56:45", "goods_page_v_last_modified_by_id": "2", "goods_page_v_last_modified_by_name": "xxx" } ], "access_token": "xxx", "access_token_end_date": "2021-08-07 05:32:55", "refresh_token": "xxx" "refresh_token_end_date": "2021-08-09 05:32:55" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goods_page_variation_search/`](/api/operations/api_v1_master_goods_page_variation_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品ページ(バリエーション)) - [商品ページ(バリエーション)件数取得](/api/api_v1_master_goods_page_variation/count/) — `POST /api_v1_master_goods_page_variation/count` --- # 商品カテゴリ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodscategory/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodscategory/count Tag: 商品カテゴリ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodscategory/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品カテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品カテゴリID | `goods_category_id` | 数値型 | | | 商品コード | `goods_category_goods_id` | 文字列型 | | | モールコード | `goods_category_mall_id` | 数値型 | | | カテゴリ(ID) | `goods_category_mall_category_id` | 数値型 | モールの場合、本カラムにモールカテゴリIDが設定される | | カテゴリ(テキスト) | `goods_category_text` | 文字列型 | カートの場合、本カラムに店舗カテゴリのテキストが設定される | | 削除フラグ | `goods_category_deleted_flag` | 文字列型 | | | 作成日 | `goods_category_creation_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_category_creator_id` | 数値型 | | | 作成担当者名 | `goods_category_creator_name` | 文字列型 | | | 最終更新者ID | `goods_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org//api_v1_master_goodscategory/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodscategory_count/`](/api/operations/api_v1_master_goodscategory_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品カテゴリ) - [商品カテゴリ検索](/api/api_v1_master_goodscategory/search/) — `POST /api_v1_master_goodscategory/search` --- # 商品カテゴリ検索 URL: https://developer.next-engine.com/api/api_v1_master_goodscategory/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodscategory/search Tag: 商品カテゴリ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodscategory/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品カテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品カテゴリID | `goods_category_id` | 数値型 | | | 商品コード | `goods_category_goods_id` | 文字列型 | | | モールコード | `goods_category_mall_id` | 数値型 | | | カテゴリ(ID) | `goods_category_mall_category_id` | 数値型 | モールの場合、本カラムにモールカテゴリIDが設定される | | カテゴリ(テキスト) | `goods_category_text` | 文字列型 | カートの場合、本カラムに店舗カテゴリのテキストが設定される | | 削除フラグ | `goods_category_deleted_flag` | 文字列型 | | | 作成日 | `goods_category_creation_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_category_creator_id` | 数値型 | | | 作成担当者名 | `goods_category_creator_name` | 文字列型 | | | 最終更新者ID | `goods_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### モールカテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モールカテゴリID | `mall_category_id` | 数値型 | | | モール/カートID | `mall_category_mall_id` | 数値型 | | | モールカテゴリコード | `mall_category_code` | 文字列型 | | | 親モールカテゴリID | `mall_category_parent_mall_category_id` | 数値型 | | | カテゴリ名 | `mall_category_name` | 文字列型 | Ex:パソコン | | カテゴリ名(フル) | `mall_category_full_name` | 文字列型 | Ex: オークション > コンピュータ > パソコン | | 削除フラグ | `mall_category_deleted_flag` | 文字列型 | | | 作成日 | `mall_category_creation_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `mall_category_creator_id` | 数値型 | | | 作成担当者名 | `mall_category_creator_name` | 文字列型 | | | 最終更新者ID | `mall_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `mall_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `mall_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `mall_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_category_id-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodscategory/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "goods_category_id": "1", "goods_category_goods_id": "TestP001", "goods_category_mall_id": "90", "goods_category_text": "test product category", "goods_category_deleted_flag": "1", "goods_category_creation_date": "2017-02-09 13:45:13", "goods_category_last_modified_date": "2017-02-10 16:37:16", "goods_category_last_modified_null_safe_date": "2017-02-10 16:37:16", "goods_category_creator_id": "10003", "goods_category_creator_name": "xxxxx", "goods_category_last_modified_by_id": "10003", "goods_category_last_modified_by_null_safe_id": "10003", "goods_category_last_modified_by_name": "xxxxx", "goods_category_last_modified_by_null_safe_name": "xxxxx", "mall_category_id": null, "mall_category_mall_id": null, "mall_category_code": null, "mall_category_parent_mall_category_id": null, "mall_category_name": null, "mall_category_full_name": null, "mall_category_deleted_flag": null, "mall_category_creation_date": null, "mall_category_last_modified_date": null, "mall_category_last_modified_null_safe_date": null, "mall_category_creator_id": null, "mall_category_creator_name": null, "mall_category_last_modified_by_id": null, "mall_category_last_modified_by_null_safe_id": null, "mall_category_last_modified_by_name": null, "mall_category_last_modified_by_null_safe_name": null }, { "goods_category_id": "2", "goods_category_goods_id": "TestP001", "goods_category_mall_id": "15", "goods_category_text": "", "goods_category_deleted_flag": "0", "goods_category_creation_date": "2017-02-09 13:51:39", "goods_category_last_modified_date": "2017-02-09 13:51:39", "goods_category_last_modified_null_safe_date": "2017-02-09 13:51:39", "goods_category_creator_id": "10003", "goods_category_creator_name": "xxxxx", "goods_category_last_modified_by_id": "10003", "goods_category_last_modified_by_null_safe_id": "10003", "goods_category_last_modified_by_name": "xxxxx", "goods_category_last_modified_by_null_safe_name": "xxxxx", "mall_category_id": "31402", "mall_category_mall_id": "15", "mall_category_code": "2084240603", "mall_category_parent_mall_category_id": "31400", "mall_category_name": "子ども用", "mall_category_full_name": "オークション > ファッション > ハンドメイド > 子ども用", "mall_category_deleted_flag": "0", "mall_category_creation_date": "2014-11-05 15:16:43", "mall_category_last_modified_date": "2015-01-19 11:45:24", "mall_category_last_modified_null_safe_date": "2015-01-19 11:45:24", "mall_category_creator_id": "9999", "mall_category_creator_name": "管理者", "mall_category_last_modified_by_id": "9999", "mall_category_last_modified_by_null_safe_id": "9999", "mall_category_last_modified_by_name": "管理者", "mall_category_last_modified_by_null_safe_name": "管理者" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodscategory_search/`](/api/operations/api_v1_master_goodscategory_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品カテゴリ) - [商品カテゴリ件数取得](/api/api_v1_master_goodscategory/count/) — `POST /api_v1_master_goodscategory/count` --- # 商品画像件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodsimage/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsimage/count Tag: 商品画像 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodsimage/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品画像 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像ID | `goods_image_id` | 数値型 | | | 商品コード | `goods_image_goods_id` | 文字列型 | | | ファイル名 | `goods_image_file_name` | 文字列型 | | | 画像URL(HTTP) | `goods_image_url_http` | 文字列型 | | | 画像URL(HTTPS) | `goods_image_url_https` | 文字列型 | | | サイズ | `goods_image_size` | 数値型 | 単位はバイト。500KB(1024計算)以下 | | 幅 | `goods_image_width` | 数値型 | 単位：ピクセル。2100px以下 | | 高さ | `goods_image_height` | 数値型 | 単位：ピクセル。2100px以下 | | 画像説明 | `goods_image_alt` | 文字列型 | HTMLのimg要素のalt属性 | | 自動変換フラグ | `goods_image_convert_flg` | 数値型 | 自動作成したJPEG画像がある場合、1。このフラグが1の場合、URLはjpg以外が設定されており、拡張子をjpgにしてアクセスすることでjpgファイルにもアクセス出来ます | | 並び順 | `goods_image_display_order` | 文字列型 | | | ファイル状態 | `goods_image_status` | 数値型 | 0:未ダウンロード 1:ダウンロード中 2:ダウンロード済み 3:アップロード済み 4:アップロード中 9:削除済み ※ファイル選択でアップロードされた場合は、1になります | | 削除フラグ | `goods_image_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_creation_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org/api_v1_master_goodsimage/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsimage_count/`](/api/operations/api_v1_master_goodsimage_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品画像) - [商品画像検索](/api/api_v1_master_goodsimage/search/) — `POST /api_v1_master_goodsimage/search` --- # 商品画像検索 URL: https://developer.next-engine.com/api/api_v1_master_goodsimage/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsimage/search Tag: 商品画像 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodsimage/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品画像 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像ID | `goods_image_id` | 数値型 | | | 商品コード | `goods_image_goods_id` | 文字列型 | | | ファイル名 | `goods_image_file_name` | 文字列型 | | | 画像URL(HTTP) | `goods_image_url_http` | 文字列型 | | | 画像URL(HTTPS) | `goods_image_url_https` | 文字列型 | | | サイズ | `goods_image_size` | 数値型 | 単位はバイト。500KB(1024計算)以下 | | 幅 | `goods_image_width` | 数値型 | 単位：ピクセル。2100px以下 | | 高さ | `goods_image_height` | 数値型 | 単位：ピクセル。2100px以下 | | 画像説明 | `goods_image_alt` | 文字列型 | HTMLのimg要素のalt属性 | | 自動変換フラグ | `goods_image_convert_flg` | 数値型 | 自動作成したJPEG画像がある場合、1。このフラグが1の場合、URLはjpg以外が設定されており、拡張子をjpgにしてアクセスすることでjpgファイルにもアクセス出来ます | | 並び順 | `goods_image_display_order` | 文字列型 | | | ファイル状態 | `goods_image_status` | 数値型 | 0:未ダウンロード 1:ダウンロード中 2:ダウンロード済み 3:アップロード済み 4:アップロード中 9:削除済み ※ファイル選択でアップロードされた場合は、1になります | | 削除フラグ | `goods_image_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_creation_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像分類タグID | `goods_image_tag_id` | 数値型 | | | 商品画像ID | `goods_image_tag_goods_image_id` | 数値型 | | | 画像分類タグID | `goods_image_tag_image_tag_id` | 文字列型 | | | 削除フラグ | `goods_image_tag_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_tag_creation_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_tag_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 画像分類タグID | `image_tag_id` | 数値型 | | | モール/カートID | `image_tag_mall_id` | 数値型 | | | モール/カートID(サブ) | `image_tag_mall_sub_id` | 数値型 | | | 画像分類タグ | `image_tag_text` | 文字列型 | Ex:汎用-画像1,汎用-画像2,・・・ | | 自動登録用タグ番号 | `image_tag_auto_register_no` | 数値型 | 通常は並び順と同じ。モール/カートID(サブ)がある場合のみ異なる値が設定される。汎用-画像1,2,BASE-画像1,2の場合BASE-画像1の並び順は1で自動登録用タグ番号は3。 | | 並び順 | `image_tag_display_order` | 数値型 | | | 削除フラグ | `image_tag_deleted_flag` | 文字列型 | | | 作成日 | `image_tag_creation_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `image_tag_creator_id` | 数値型 | | | 作成担当者名 | `image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_image_creator_name-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodsimage/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "goods_image_id": "1", "goods_image_goods_id": "T101", "goods_image_file_name": "2af4aec82a6f7f67fa09b2ae5e84c87e_201701181.jpg", "goods_image_url_http": "xxxxx", "goods_image_url_https": "xxxxx", "goods_image_size": "219519", "goods_image_width": "2048", "goods_image_height": "1152", "goods_image_alt": "", "goods_image_convert_flg": "0", "goods_image_display_order": "1", "goods_image_status": "3", "goods_image_deleted_flag": "0", "goods_image_creation_date": "2017-01-18 15:44:50", "goods_image_last_modified_date": "2017-01-18 16:01:50", "goods_image_last_modified_null_safe_date": "2017-01-18 16:01:50", "goods_image_creator_id": "10004", "goods_image_creator_name": "xxxxx", "goods_image_last_modified_by_id": "10004", "goods_image_last_modified_by_null_safe_id": "10004", "goods_image_last_modified_by_name": "xxxxx", "goods_image_last_modified_by_null_safe_name": "xxxxx", "goods_image_tag_id": "1", "goods_image_tag_goods_image_id": "1", "goods_image_tag_image_tag_id": "1", "goods_image_tag_deleted_flag": "0", "goods_image_tag_creation_date": "2017-01-18 15:44:50", "goods_image_tag_last_modified_date": "2017-01-18 15:44:50", "goods_image_tag_last_modified_null_safe_date": "2017-01-18 15:44:50", "goods_image_tag_creator_id": "0", "goods_image_tag_creator_name": "System", "goods_image_tag_last_modified_by_id": "0", "goods_image_tag_last_modified_by_null_safe_id": "0", "goods_image_tag_last_modified_by_name": "System", "goods_image_tag_last_modified_by_null_safe_name": "System", "image_tag_id": "1", "image_tag_mall_id": "0", "image_tag_mall_sub_id": "0", "image_tag_text": "基本-画像1", "image_tag_auto_register_no": "1", "image_tag_display_order": "1", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" }, { "goods_image_id": "2", "goods_image_goods_id": "T101", "goods_image_file_name": "e4213e243da9497baffb3e0db8a3f167_201702102.jpg", "goods_image_url_http": "xxxxx", "goods_image_url_https": "xxxxx", "goods_image_size": "130186", "goods_image_width": "800", "goods_image_height": "489", "goods_image_alt": "", "goods_image_convert_flg": "0", "goods_image_display_order": "2", "goods_image_status": "3", "goods_image_deleted_flag": "0", "goods_image_creation_date": "2017-02-10 16:08:41", "goods_image_last_modified_date": "2017-02-10 16:28:11", "goods_image_last_modified_null_safe_date": "2017-02-10 16:28:11", "goods_image_creator_id": "10002", "goods_image_creator_name": "xxxxx", "goods_image_last_modified_by_id": "10002", "goods_image_last_modified_by_null_safe_id": "10002", "goods_image_last_modified_by_name": "xxxxx", "goods_image_last_modified_by_null_safe_name": "xxxxx", "goods_image_tag_id": "2", "goods_image_tag_goods_image_id": "2", "goods_image_tag_image_tag_id": "2", "goods_image_tag_deleted_flag": "0", "goods_image_tag_creation_date": "2017-02-10 16:08:41", "goods_image_tag_last_modified_date": "2017-02-10 16:08:41", "goods_image_tag_last_modified_null_safe_date": "2017-02-10 16:08:41", "goods_image_tag_creator_id": "10002", "goods_image_tag_creator_name": "xxxxx", "goods_image_tag_last_modified_by_id": "10002", "goods_image_tag_last_modified_by_null_safe_id": "10002", "goods_image_tag_last_modified_by_name": "xxxxx", "goods_image_tag_last_modified_by_null_safe_name": "xxxxx", "image_tag_id": "2", "image_tag_mall_id": "0", "image_tag_mall_sub_id": "0", "image_tag_text": "基本-画像2", "image_tag_auto_register_no": "2", "image_tag_display_order": "2", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsimage_search/`](/api/operations/api_v1_master_goodsimage_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品画像) - [商品画像件数取得](/api/api_v1_master_goodsimage/count/) — `POST /api_v1_master_goodsimage/count` --- # 商品画像分類タグ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodsimagetag/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsimagetag/count Tag: 商品画像分類タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodsimagetag/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像分類タグID | `goods_image_tag_id` | 数値型 | | | 商品画像ID | `goods_image_tag_goods_image_id` | 数値型 | | | 画像分類タグID | `goods_image_tag_image_tag_id` | 文字列型 | | | 削除フラグ | `goods_image_tag_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_tag_creation_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_tag_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org/api_v1_master_goodsimagetag/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsimagetag_count/`](/api/operations/api_v1_master_goodsimagetag_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品画像分類タグ) - [商品画像分類タグ検索](/api/api_v1_master_goodsimagetag/search/) — `POST /api_v1_master_goodsimagetag/search` --- # 商品画像分類タグ検索 URL: https://developer.next-engine.com/api/api_v1_master_goodsimagetag/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsimagetag/search Tag: 商品画像分類タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodsimagetag/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品画像分類タグID | `goods_image_tag_id` | 数値型 | | | 商品画像ID | `goods_image_tag_goods_image_id` | 数値型 | | | 画像分類タグID | `goods_image_tag_image_tag_id` | 文字列型 | | | 削除フラグ | `goods_image_tag_deleted_flag` | 文字列型 | | | 作成日 | `goods_image_tag_creation_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `goods_image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_image_tag_creator_id` | 数値型 | | | 作成担当者名 | `goods_image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 画像分類タグID | `image_tag_id` | 数値型 | | | モール/カートID | `image_tag_mall_id` | 数値型 | | | モール/カートID(サブ) | `image_tag_mall_sub_id` | 数値型 | | | 画像分類タグ | `image_tag_text` | 文字列型 | Ex:汎用-画像1,汎用-画像2,・・・ | | 自動登録用タグ番号 | `image_tag_auto_register_no` | 数値型 | 通常は並び順と同じ。モール/カートID(サブ)がある場合のみ異なる値が設定される。汎用-画像1,2,BASE-画像1,2の場合BASE-画像1の並び順は1で自動登録用タグ番号は3。 | | 並び順 | `image_tag_display_order` | 数値型 | | | 削除フラグ | `image_tag_deleted_flag` | 文字列型 | | | 作成日 | `image_tag_creation_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `image_tag_creator_id` | 数値型 | | | 作成担当者名 | `image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_image_tag_creator_name-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodsimagetag/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "goods_image_tag_id": "1", "goods_image_tag_goods_image_id": "1", "goods_image_tag_image_tag_id": "1", "goods_image_tag_deleted_flag": "0", "goods_image_tag_creation_date": "2017-01-18 15:44:50", "goods_image_tag_last_modified_date": "2017-01-18 15:44:50", "goods_image_tag_last_modified_null_safe_date": "2017-01-18 15:44:50", "goods_image_tag_creator_id": "0", "goods_image_tag_creator_name": "System", "goods_image_tag_last_modified_by_id": "0", "goods_image_tag_last_modified_by_null_safe_id": "0", "goods_image_tag_last_modified_by_name": "System", "goods_image_tag_last_modified_by_null_safe_name": "System", "image_tag_id": "1", "image_tag_mall_id": "0", "image_tag_mall_sub_id": "0", "image_tag_text": "基本-画像1", "image_tag_auto_register_no": "1", "image_tag_display_order": "1", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" }, { "goods_image_tag_id": "2", "goods_image_tag_goods_image_id": "2", "goods_image_tag_image_tag_id": "2", "goods_image_tag_deleted_flag": "0", "goods_image_tag_creation_date": "2017-02-10 16:08:41", "goods_image_tag_last_modified_date": "2017-02-10 16:08:41", "goods_image_tag_last_modified_null_safe_date": "2017-02-10 16:08:41", "goods_image_tag_creator_id": "10002", "goods_image_tag_creator_name": "xxxxx", "goods_image_tag_last_modified_by_id": "10002", "goods_image_tag_last_modified_by_null_safe_id": "10002", "goods_image_tag_last_modified_by_name": "xxxxx", "goods_image_tag_last_modified_by_null_safe_name": "xxxxx", "image_tag_id": "2", "image_tag_mall_id": "0", "image_tag_mall_sub_id": "0", "image_tag_text": "基本-画像2", "image_tag_auto_register_no": "2", "image_tag_display_order": "2", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" } ], "access_token": xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsimagetag_search/`](/api/operations/api_v1_master_goodsimagetag_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品画像分類タグ) - [商品画像分類タグ件数取得](/api/api_v1_master_goodsimagetag/count/) — `POST /api_v1_master_goodsimagetag/count` --- # 商品コード紐づけ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodsmapping/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsmapping/count Tag: 商品コード紐づけ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodsmapping/count` ## リファレンス内容 ### 商品コード紐づけ件数取得 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子 | 検索条件の値(WHERE句の値相当) | 可能 | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `code` | エラーコード | 成功(success)時はなし | | `count` | 検索結果の件数 | | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | （例）2016-01-01 01:01:01 | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | （例）2016-01-01 01:01:01 | ### 商品コード紐づけ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `goods_mapping_shop_id` | 数値型 | | | 商品コード | `goods_mapping_goods_id` | 文字列型 | | | 店舗商品コード | `goods_mapping_shop_goods_id` | 文字列型 | | | 削除フラグ | `goods_mapping_deleted_flag` | 文字列型 | | | 作成日 | `goods_mapping_creation_date` | 日時型 | | | 最終更新日 | `goods_mapping_last_modified_date` | 日時型 | | | 最終更新日 | `goods_mapping_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_mapping_creator_id` | 数値型 | | | 作成担当者名 | `goods_mapping_creator_name` | 文字列型 | | | 最終更新者ID | `goods_mapping_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_mapping_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_mapping_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_mapping_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST 'https://api.next-engine.org/api_v1_master_goodsmapping/count' \ -d 'access_token=XXX&goods_mapping_deleted_flag-eq=0' ``` レスポンス ```json { "result": "success", "count": "3", "access_token": "XXX", "access_token_end_date": "2025-08-14 16:12:31", "refresh_token": "XXX", "refresh_token_end_date": "2025-08-16 16:12:31" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsmapping_count/`](/api/operations/api_v1_master_goodsmapping_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品コード紐づけ) - [商品コード紐づけ検索](/api/api_v1_master_goodsmapping/search/) — `POST /api_v1_master_goodsmapping/search` --- # 商品コード紐づけ検索 URL: https://developer.next-engine.com/api/api_v1_master_goodsmapping/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodsmapping/search Tag: 商品コード紐づけ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit リクエストURL ホスト`https://api.next-engine.org` エンドポイント `/api_v1_master_goodsmapping/search` ## リファレンス内容 ### 商品コード紐づけ検索 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 検索条件を複数指定した場合、全ての条件がかつ(AND)となります。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `code` | エラーコード | 成功(success)時はなし | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | （例）2016-01-01 01:01:01 | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | （例）2016-01-01 01:01:01 | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品コード紐づけ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `goods_mapping_shop_id` | 数値型 | | | 商品コード | `goods_mapping_goods_id` | 文字列型 | | | 店舗商品コード | `goods_mapping_shop_goods_id` | 文字列型 | | | 削除フラグ | `goods_mapping_deleted_flag` | 文字列型 | | | 作成日 | `goods_mapping_creation_date` | 日時型 | | | 最終更新日 | `goods_mapping_last_modified_date` | 日時型 | | | 最終更新日 | `goods_mapping_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_mapping_creator_id` | 数値型 | | | 作成担当者名 | `goods_mapping_creator_name` | 文字列型 | | | 最終更新者ID | `goods_mapping_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_mapping_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_mapping_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_mapping_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST 'https://api.next-engine.org/api_v1_master_goodsmapping/search' \ -d 'access_token=XXX&goods_mapping_shop_id-eq=1&fields=goods_mapping_shop_id,goods_mapping_goods_id,goods_mapping_shop_goods_id,goods_mapping_deleted_flag,goods_mapping_creation_date,goods_mapping_last_modified_date,goods_mapping_last_modified_null_safe_date,goods_mapping_creator_id,goods_mapping_creator_name,goods_mapping_last_modified_by_id,goods_mapping_last_modified_by_null_safe_id,goods_mapping_last_modified_by_name,goods_mapping_last_modified_by_null_safe_name' ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "goods_mapping_shop_id": "1", "goods_mapping_goods_id": "s01", "goods_mapping_shop_goods_id": "s0101", "goods_mapping_deleted_flag": "0", "goods_mapping_creation_date": "2025-08-08 08:48:14", "goods_mapping_last_modified_date": "2025-08-08 08:48:14", "goods_mapping_last_modified_null_safe_date": "2025-08-08 08:48:14", "goods_mapping_creator_id": "2", "goods_mapping_creator_name": "当社担当者", "goods_mapping_last_modified_by_id": "2", "goods_mapping_last_modified_by_null_safe_id": "2", "goods_mapping_last_modified_by_name": "当社担当者", "goods_mapping_last_modified_by_null_safe_name": "当社担当者" }, ], "access_token": "XXX", "access_token_end_date": "2025-08-14 16:12:31", "refresh_token": "XXX", "refresh_token_end_date": "2025-08-16 16:12:31" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodsmapping_search/`](/api/operations/api_v1_master_goodsmapping_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品コード紐づけ) - [商品コード紐づけ件数取得](/api/api_v1_master_goodsmapping/count/) — `POST /api_v1_master_goodsmapping/count` --- # 商品タグ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodstag/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodstag/count Tag: 商品タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodstag/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_tag_goods_id` | 文字列型 | | | 商品タグ名 | `goods_tag_name` | 文字列型 | | | 削除フラグ | `goods_tag_deleted_flag` | 文字列型 | | | 作成日 | `goods_tag_creation_date` | 日時型 | | | 最終更新日 | `goods_tag_last_modified_date` | 日時型 | | | 最終更新日 | `goods_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_tag_creator_id` | 数値型 | | | 作成担当者名 | `goods_tag_creator_name` | 文字列型 | | | 最終更新者ID | `goods_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&goods_tag_deleted_flag-eq=0' https://api.next-engine.org/api_v1_master_goodstag/count ``` レスポンス ```json { "result": "success", "count": "15", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodstag_count/`](/api/operations/api_v1_master_goodstag_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品タグ) - [商品タグ検索](/api/api_v1_master_goodstag/search/) — `POST /api_v1_master_goodstag/search` --- # 商品タグ検索 URL: https://developer.next-engine.com/api/api_v1_master_goodstag/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodstag/search Tag: 商品タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodstag/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_tag_goods_id` | 文字列型 | | | 商品タグ名 | `goods_tag_name` | 文字列型 | | | 削除フラグ | `goods_tag_deleted_flag` | 文字列型 | | | 作成日 | `goods_tag_creation_date` | 日時型 | | | 最終更新日 | `goods_tag_last_modified_date` | 日時型 | | | 最終更新日 | `goods_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_tag_creator_id` | 数値型 | | | 作成担当者名 | `goods_tag_creator_name` | 文字列型 | | | 最終更新者ID | `goods_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=goods_tag_goods_id, goods_tag_name&goods_tag_deleted_flag-eq=0&offset=0&limit=100' https://api.next-engine.org/api_v1_master_goodstag/search ``` レスポンス ```json { "result": "success", "count": "15", "data": [ { "goods_tag_goods_id": "T102", "goods_tag_name": "t-shirt" }, { "goods_tag_goods_id": "T102", "goods_tag_name": "2017" }, { "goods_tag_goods_id": "T102", "goods_tag_name": "cheap" }, { "goods_tag_goods_id": "TestP001", "goods_tag_name": "t-shirt" }, { "goods_tag_goods_id": "TestP001", "goods_tag_name": "2017" }, { "goods_tag_goods_id": "TestP001", "goods_tag_name": "cheap" }, { "goods_tag_goods_id": "T101-Red", "goods_tag_name": "t-shirt" }, { "goods_tag_goods_id": "T101-Red", "goods_tag_name": "2017" }, { "goods_tag_goods_id": "T101-Red", "goods_tag_name": "cheap" }, { "goods_tag_goods_id": "T101-Red", "goods_tag_name": "nice" }, { "goods_tag_goods_id": "T101", "goods_tag_name": "t-shirt" }, { "goods_tag_goods_id": "T101", "goods_tag_name": "2017" }, { "goods_tag_goods_id": "T101", "goods_tag_name": "cheap" }, { "goods_tag_goods_id": "T101", "goods_tag_name": "nice" }, { "goods_tag_goods_id": "T101", "goods_tag_name": "nice" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodstag_search/`](/api/operations/api_v1_master_goodstag_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品タグ) - [商品タグ件数取得](/api/api_v1_master_goodstag/count/) — `POST /api_v1_master_goodstag/count` --- # 商品別卸先マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_goodswholesale/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodswholesale/count Tag: 商品別卸先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodswholesale/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 商品別卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_wholesale_goods_id` | 文字列型 | | | 卸先コード | `goods_wholesale_wholesale_id` | 文字列型 | | | 商品別卸先掛率 | `goods_wholesale_wholesale_retail_ratio` | 数値型 | | | 作成日 | `goods_wholesale_creation_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_wholesale_creator_id` | 数値型 | | | 作成担当者名 | `goods_wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org/api_v1_master_goodswholesale/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodswholesale_count/`](/api/operations/api_v1_master_goodswholesale_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品別卸先マスタ) - [商品別卸先マスタ検索](/api/api_v1_master_goodswholesale/search/) — `POST /api_v1_master_goodswholesale/search` --- # 商品別卸先マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_goodswholesale/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_goodswholesale/search Tag: 商品別卸先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_goodswholesale/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 商品別卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_wholesale_goods_id` | 文字列型 | | | 卸先コード | `goods_wholesale_wholesale_id` | 文字列型 | | | 商品別卸先掛率 | `goods_wholesale_wholesale_retail_ratio` | 数値型 | | | 作成日 | `goods_wholesale_creation_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_wholesale_creator_id` | 数値型 | | | 作成担当者名 | `goods_wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 卸先コード | `wholesale_id` | 文字列型 | | | 卸先名 | `wholesale_name` | 文字列型 | | | 卸先カナ | `wholesale_kana` | 文字列型 | | | 部署名 | `wholesale_post_name` | 文字列型 | | | 郵便番号 | `wholesale_zip_code` | 文字列型 | | | 住所1 | `wholesale_address1` | 文字列型 | | | 住所2 | `wholesale_address2` | 文字列型 | | | 電話番号 | `wholesale_phone` | 文字列型 | | | FAX番号 | `wholesale_fax` | 文字列型 | | | メールアドレス | `wholesale_mail_address` | 文字列型 | | | 送付先名 | `wholesale_destination_pic_name` | 文字列型 | | | 送付先カナ | `wholesale_destination_pic_kana` | 文字列型 | | | 送付先郵便番号 | `wholesale_destination_zip_code` | 文字列型 | | | 送付先住所1 | `wholesale_destination_address1` | 文字列型 | | | 送付先住所2 | `wholesale_destination_address2` | 文字列型 | | | 送付先電話番号 | `wholesale_destination_phone` | 文字列型 | | | 発送方法区分 | `wholesale_delivery_id` | 文字列型 | | | 発送方法名 | `wholesale_delivery_name` | 文字列型 | | | 支払区分 | `wholesale_payment_method_id` | 文字列型 | | | 支払名 | `wholesale_payment_method_name` | 文字列型 | | | 掛率 | `wholesale_retail_ratio` | 数値型 | | | 卸先番号 | `wholesale_destination_no` | 数値型 | | | 与信枠（円） | `wholesale_credit_line_price` | 数値型 | | | 締日 | `wholesale_closing_day` | 数値型 | | | 備考 | `wholesale_note` | 文字列型 | | | 削除フラグ | `wholesale_deleted_flag` | 文字列型 | | | 作成日 | `wholesale_creation_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `wholesale_creator_id` | 数値型 | | | 作成担当者名 | `wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_wholesale_goods_id-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodswholesale/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "goods_wholesale_goods_id": "T101-Red", "goods_wholesale_wholesale_id": "5555", "goods_wholesale_wholesale_retail_ratio": "10.0", "goods_wholesale_creation_date": "2017-02-13 13:02:37", "goods_wholesale_last_modified_date": "2017-02-13 13:02:37", "goods_wholesale_last_modified_null_safe_date": "2017-02-13 13:02:37", "goods_wholesale_creator_id": "10003", "goods_wholesale_creator_name": "xxxxx", "goods_wholesale_last_modified_by_id": "10003", "goods_wholesale_last_modified_by_null_safe_id": "10003", "goods_wholesale_last_modified_by_name": "xxxxx", "goods_wholesale_last_modified_by_null_safe_name": "xxxxx", "wholesale_id": "5555", "wholesale_name": "hcm - wholesaler", "wholesale_kana": "", "wholesale_post_name": "", "wholesale_zip_code": "70000", "wholesale_address1": "HCM", "wholesale_address2": "", "wholesale_phone": "", "wholesale_fax": "", "wholesale_mail_address": "", "wholesale_destination_pic_name": "Tokyo", "wholesale_destination_pic_kana": "", "wholesale_destination_zip_code": "18000", "wholesale_destination_address1": "Tokyo", "wholesale_destination_address2": "", "wholesale_destination_phone": "", "wholesale_delivery_id": "10", "wholesale_delivery_name": "佐川急便(e飛伝PRO)", "wholesale_payment_method_id": "0", "wholesale_payment_method_name": "クレジットカード", "wholesale_retail_ratio": null, "wholesale_destination_no": "1", "wholesale_credit_line_price": null, "wholesale_closing_day": null, "wholesale_note": null, "wholesale_deleted_flag": "0", "wholesale_creation_date": "2017-02-09 16:24:31", "wholesale_last_modified_date": "2017-02-13 12:52:58", "wholesale_last_modified_null_safe_date": "2017-02-13 12:52:58", "wholesale_creator_id": "0", "wholesale_creator_name": "System", "wholesale_last_modified_by_id": "0", "wholesale_last_modified_by_null_safe_id": "0", "wholesale_last_modified_by_name": "System", "wholesale_last_modified_by_null_safe_name": "System" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_goodswholesale_search/`](/api/operations/api_v1_master_goodswholesale_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (商品別卸先マスタ) - [商品別卸先マスタ件数取得](/api/api_v1_master_goodswholesale/count/) — `POST /api_v1_master_goodswholesale/count` --- # 区分け在庫マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_keepstock/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_keepstock/count Tag: 区分け在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_keepstock/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 区分け在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `keep_stock_goods_id` | 文字列型 | | | 区分け在庫名 | `keep_stock_name` | 文字列型 | | | 区分け在庫数 | `keep_stock_quantity` | 数値型 | | | 期限 | `keep_stock_due_date` | 日時型 | | | 備考 | `keep_stock_note` | 文字列型 | | | 削除フラグ | `keep_stock_deleted_flag` | 文字列型 | | | 作成日 | `keep_stock_creation_date` | 日時型 | | | 最終更新日 | `keep_stock_last_modified_date` | 日時型 | | | 最終更新日 | `keep_stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `keep_stock_creator_id` | 数値型 | | | 作成担当者名 | `keep_stock_creator_name` | 文字列型 | | | 最終更新者ID | `keep_stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `keep_stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `keep_stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `keep_stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F keep_stock_name-like=test https://api.next-engine.org/api_v1_master_keepstock/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_keepstock_count/`](/api/operations/api_v1_master_keepstock_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分け在庫マスタ) - [区分け在庫マスタ検索](/api/api_v1_master_keepstock/search/) — `POST /api_v1_master_keepstock/search` --- # 区分け在庫マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_keepstock/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_keepstock/search Tag: 区分け在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_keepstock/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 区分け在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `keep_stock_goods_id` | 文字列型 | | | 区分け在庫名 | `keep_stock_name` | 文字列型 | | | 区分け在庫数 | `keep_stock_quantity` | 数値型 | | | 期限 | `keep_stock_due_date` | 日時型 | | | 備考 | `keep_stock_note` | 文字列型 | | | 削除フラグ | `keep_stock_deleted_flag` | 文字列型 | | | 作成日 | `keep_stock_creation_date` | 日時型 | | | 最終更新日 | `keep_stock_last_modified_date` | 日時型 | | | 最終更新日 | `keep_stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `keep_stock_creator_id` | 数値型 | | | 作成担当者名 | `keep_stock_creator_name` | 文字列型 | | | 最終更新者ID | `keep_stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `keep_stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `keep_stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `keep_stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_keepstock/search -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F 'fields=keep_stock_goods_id,keep_stock_name,keep_stock_quantity,keep_stock_due_date,keep_stock_note,keep_stock_deleted_flag,keep_stock_creation_date,keep_stock_last_modified_date,keep_stock_last_modified_null_safe_date,keep_stock_creator_id,keep_stock_creator_name,keep_stock_last_modified_by_id,keep_stock_last_modified_by_null_safe_id,keep_stock_last_modified_by_name,keep_stock_last_modified_by_null_safe_name' -F keep_stock_name-like=test -F offset=0 -F limit=1 ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "keep_stock_goods_id": "T101", "keep_stock_name": "test", "keep_stock_quantity": "1", "keep_stock_due_date": "2017-01-19 00:00:00", "keep_stock_note": "", "keep_stock_deleted_flag": "0", "keep_stock_creation_date": "2017-01-18 16:12:04", "keep_stock_last_modified_date": null, "keep_stock_last_modified_null_safe_date": "2017-01-18 16:12:04", "keep_stock_creator_id": "10004", "keep_stock_creator_name": "xxxxxxx", "keep_stock_last_modified_by_id": null, "keep_stock_last_modified_by_null_safe_id": "10004", "keep_stock_last_modified_by_name": null, "keep_stock_last_modified_by_null_safe_name": "xxxxxxxxx" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_keepstock_search/`](/api/operations/api_v1_master_keepstock_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分け在庫マスタ) - [区分け在庫マスタ件数取得](/api/api_v1_master_keepstock/count/) — `POST /api_v1_master_keepstock/count` --- # メールタグ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_mailtag/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_mailtag/count Tag: メールタグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_mailtag/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### メールタグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | メールタグ | `mail_tag_id` | 文字列型 | | | 対応月 | `mail_tag_month` | 数値型 | 0-12の値が設定される。0:メール送信月に対応する1-12の設定がない場合、適用される。1-12:メール送信月の１月～１２月に対応する。 | | メールタグ概要 | `mail_tag_name` | 文字列型 | | | メールタグ備考 | `mail_tag_note` | 文字列型 | | | メッセージ1 | `mail_tag_message1` | 文字列型 | メール送信時、メッセージ1~6の中からランダムにメッセージが選択される。 | | メッセージ2 | `mail_tag_message2` | 文字列型 | | | メッセージ1 | `mail_tag_message3` | 文字列型 | | | メッセージ2 | `mail_tag_message4` | 文字列型 | | | メッセージ1 | `mail_tag_message5` | 文字列型 | | | メッセージ2 | `mail_tag_message6` | 文字列型 | | | 削除フラグ | `mail_tag_deleted_flag` | 文字列型 | | | 作成日 | `mail_tag_creation_date` | 日時型 | | | 最終更新日 | `mail_tag_last_modified_date` | 日時型 | | | 最終更新日 | `mail_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `mail_tag_creator_id` | 数値型 | | | 作成担当者名 | `mail_tag_creator_name` | 文字列型 | | | 最終更新者ID | `mail_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `mail_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `mail_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `mail_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxx &refresh_token=xxxxxxx&wait_flag=1&mail_tag_id-like=MyMailTag&mail_tag_month-eq=2' https://api.next-engine.org/api_v1_master_mailtag/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_mailtag_count/`](/api/operations/api_v1_master_mailtag_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (メールタグ) - [メールタグ検索](/api/api_v1_master_mailtag/search/) — `POST /api_v1_master_mailtag/search` --- # メールタグ検索 URL: https://developer.next-engine.com/api/api_v1_master_mailtag/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_mailtag/search Tag: メールタグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_mailtag/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### メールタグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | メールタグ | `mail_tag_id` | 文字列型 | | | 対応月 | `mail_tag_month` | 数値型 | 0-12の値が設定される。0:メール送信月に対応する1-12の設定がない場合、適用される。1-12:メール送信月の１月～１２月に対応する。 | | メールタグ概要 | `mail_tag_name` | 文字列型 | | | メールタグ備考 | `mail_tag_note` | 文字列型 | | | メッセージ1 | `mail_tag_message1` | 文字列型 | メール送信時、メッセージ1~6の中からランダムにメッセージが選択される。 | | メッセージ2 | `mail_tag_message2` | 文字列型 | | | メッセージ1 | `mail_tag_message3` | 文字列型 | | | メッセージ2 | `mail_tag_message4` | 文字列型 | | | メッセージ1 | `mail_tag_message5` | 文字列型 | | | メッセージ2 | `mail_tag_message6` | 文字列型 | | | 削除フラグ | `mail_tag_deleted_flag` | 文字列型 | | | 作成日 | `mail_tag_creation_date` | 日時型 | | | 最終更新日 | `mail_tag_last_modified_date` | 日時型 | | | 最終更新日 | `mail_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `mail_tag_creator_id` | 数値型 | | | 作成担当者名 | `mail_tag_creator_name` | 文字列型 | | | 最終更新者ID | `mail_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `mail_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `mail_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `mail_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxx&refresh_token=xxxxxx&wait_flag=1&'fields=mail_tag_id,mail_tag_month,mail_tag_name,mail_tag_note,mail_tag_message1,mail_tag_message2,mail_tag_message3,mail_tag_message4,mail_tag_message5,mail_tag_message6,mail_tag_deleted_flag,mail_tag_creation_date,mail_tag_last_modified_date,mail_tag_last_modified_null_safe_date,mail_tag_creator_id,mail_tag_creator_name,mail_tag_last_modified_by_id,mail_tag_last_modified_by_null_safe_id,mail_tag_last_modified_by_name,mail_tag_last_modified_by_null_safe_name'&mail_tag_id-like='MyMailTag'&mail_tag_month-eq=2&offset=0&limit=2' https://api.next-engine.org/api_v1_master_mailtag/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "mail_tag_id": "MyMailTag", "mail_tag_month": "2", "mail_tag_name": "ok", "mail_tag_note": "ok", "mail_tag_message1": "ammamamamamamam", "mail_tag_message2": "", "mail_tag_message3": "", "mail_tag_message4": "", "mail_tag_message5": "", "mail_tag_message6": "", "mail_tag_deleted_flag": "0", "mail_tag_creation_date": "2017-02-09 16:09:01", "mail_tag_last_modified_date": null, "mail_tag_last_modified_null_safe_date": "2017-02-09 16:09:01", "mail_tag_creator_id": "10003", "mail_tag_creator_name": "xxxxxxxx", "mail_tag_last_modified_by_id": null, "mail_tag_last_modified_by_null_safe_id": "10003", "mail_tag_last_modified_by_name": null, "mail_tag_last_modified_by_null_safe_name": "xxxxxxx" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_mailtag_search/`](/api/operations/api_v1_master_mailtag_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (メールタグ) - [メールタグ件数取得](/api/api_v1_master_mailtag/count/) — `POST /api_v1_master_mailtag/count` --- # セット商品マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_setgoods/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_setgoods/count Tag: セット商品マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_setgoods/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### セット商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | セット商品コード | `set_goods_id` | 文字列型 | | | セット商品名 | `set_goods_name` | 文字列型 | | | セット商品単価（セット販売価格） | `set_goods_selling_price` | 数値型 | | | 商品コード（内訳） | `set_goods_detail_goods_id` | 文字列型 | | | 数量（内訳） | `set_goods_detail_quantity` | 数値型 | | | 代表商品コード | `set_goods_representation_id` | 文字列型 | | | 消費税率 | `set_goods_tax_rate` | 数値型 | | | JANコード | `set_goods_jan_code` | 文字列型 | | | 英語表記名 | `set_goods_foreign_name` | 文字列型 | | | 定価 | `set_goods_display_price` | 数値型 | | | 消費税 | `set_goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | 型番 | `set_goods_model_number` | 文字列型 | | | ロケーションコード | `set_goods_location` | 文字列型 | | | ギフト可否 | `set_goods_gift_ok_flg` | 数値型 | 0:不可 1:可 | | サイズ | `set_goods_size` | 文字列型 | | | メーカー型番 | `set_goods_maker_model_number` | 文字列型 | | | 商品状態 | `set_goods_condition_id` | 文字列型 | 01:新品 02:中古 03:その他 04:未使用に近い 05:目立った傷や汚れなし 06:やや傷や汚れあり 07:傷や汚れあり 08:全体的に状態が悪い | | 商品状態説明 | `set_goods_condition_description` | 文字列型 | | | パッケージ込みの幅 | `set_goods_width` | 数値型 | | | パッケージ込みの奥行き | `set_goods_length` | 数値型 | | | パッケージ込みの高さ | `set_goods_height` | 数値型 | | | パッケージ込みの重さ | `set_goods_weight` | 数値型 | | | 当日・翌日発送 | `set_goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | のし対応 | `set_goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 色 | `set_goods_color` | 文字列型 | | | ブランド名 | `set_goods_brand_name` | 文字列型 | | | メーカー名 | `set_goods_maker_name` | 文字列型 | | | 販売開始日 | `set_goods_first_time_sold_date` | 日時型 | | | 販売終了日 | `set_goods_last_time_sold_date` | 日時型 | | | 作成日 | `set_goods_creation_date` | 日時型 | | | 作成担当者ID | `set_goods_creator_id` | 数値型 | | | 作成担当者名 | `set_goods_creator_name` | 文字列型 | | | 最終更新日 | `set_goods_last_modified_date` | 日時型 | | | 最終更新担当者ID | `set_goods_last_modified_by_id` | 数値型 | | | 最終更新担当者名 | `set_goods_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&set_goods_detail_goods_id-like=test-syohin0001%" https://api.next-engine.org/api_v1_master_setgoods/count ``` レスポンス ```json { "result": "success", "count": "10", "access_token": "xxx", "access_token_end_date": "2022-09-02 12:10:10", "refresh_token": "xxx", "refresh_token_end_date": "2022-09-04 12:10:10" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_setgoods_count/`](/api/operations/api_v1_master_setgoods_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (セット商品マスタ) - [セット商品マスタ検索](/api/api_v1_master_setgoods/search/) — `POST /api_v1_master_setgoods/search` - [セット商品マスタアップロード](/api/api_v1_master_setgoods/upload/) — `POST /api_v1_master_setgoods/upload` --- # セット商品マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_setgoods/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_setgoods/search Tag: セット商品マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_setgoods/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### セット商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | セット商品コード | `set_goods_id` | 文字列型 | | | セット商品名 | `set_goods_name` | 文字列型 | | | セット商品単価（セット販売価格） | `set_goods_selling_price` | 数値型 | | | 商品コード（内訳） | `set_goods_detail_goods_id` | 文字列型 | | | 数量（内訳） | `set_goods_detail_quantity` | 数値型 | | | 代表商品コード | `set_goods_representation_id` | 文字列型 | | | 消費税率 | `set_goods_tax_rate` | 数値型 | | | JANコード | `set_goods_jan_code` | 文字列型 | | | 英語表記名 | `set_goods_foreign_name` | 文字列型 | | | 定価 | `set_goods_display_price` | 数値型 | | | 消費税 | `set_goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | 型番 | `set_goods_model_number` | 文字列型 | | | ロケーションコード | `set_goods_location` | 文字列型 | | | ギフト可否 | `set_goods_gift_ok_flg` | 数値型 | 0:不可 1:可 | | サイズ | `set_goods_size` | 文字列型 | | | メーカー型番 | `set_goods_maker_model_number` | 文字列型 | | | 商品状態 | `set_goods_condition_id` | 文字列型 | 01:新品 02:中古 03:その他 04:未使用に近い 05:目立った傷や汚れなし 06:やや傷や汚れあり 07:傷や汚れあり 08:全体的に状態が悪い | | 商品状態説明 | `set_goods_condition_description` | 文字列型 | | | パッケージ込みの幅 | `set_goods_width` | 数値型 | | | パッケージ込みの奥行き | `set_goods_length` | 数値型 | | | パッケージ込みの高さ | `set_goods_height` | 数値型 | | | パッケージ込みの重さ | `set_goods_weight` | 数値型 | | | 当日・翌日発送 | `set_goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | のし対応 | `set_goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 色 | `set_goods_color` | 文字列型 | | | ブランド名 | `set_goods_brand_name` | 文字列型 | | | メーカー名 | `set_goods_maker_name` | 文字列型 | | | 販売開始日 | `set_goods_first_time_sold_date` | 日時型 | | | 販売終了日 | `set_goods_last_time_sold_date` | 日時型 | | | 作成日 | `set_goods_creation_date` | 日時型 | | | 作成担当者ID | `set_goods_creator_id` | 数値型 | | | 作成担当者名 | `set_goods_creator_name` | 文字列型 | | | 最終更新日 | `set_goods_last_modified_date` | 日時型 | | | 最終更新担当者ID | `set_goods_last_modified_by_id` | 数値型 | | | 最終更新担当者名 | `set_goods_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&fields=set_goods_id,set_goods_name,set_goods_detail_goods_id,set_goods_detail_quantity&set_goods_detail_goods_id-like=test-syohin00001%&offset=0&limit=100" https://api.next-engine.org/api_v1_master_setgoods/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "set_goods_id": "set-test-syohin00001", "set_goods_name": "セットテスト商品00001", "set_goods_detail_goods_id": "test-syohin00001", "set_goods_detail_quantity": "4" }, { "set_goods_id": "set-test-syohin10001", "set_goods_name": "セットテスト商品10001", "set_goods_detail_goods_id": "test-syohin00001", "set_goods_detail_quantity": "4" } ], "access_token": "xxx", "access_token_end_date": "2022-09-27 18:45:17", "refresh_token": "xxx", "refresh_token_end_date": "2022-09-29 18:45:17" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_setgoods_search/`](/api/operations/api_v1_master_setgoods_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (セット商品マスタ) - [セット商品マスタ件数取得](/api/api_v1_master_setgoods/count/) — `POST /api_v1_master_setgoods/count` - [セット商品マスタアップロード](/api/api_v1_master_setgoods/upload/) — `POST /api_v1_master_setgoods/upload` --- # セット商品マスタアップロード URL: https://developer.next-engine.com/api/api_v1_master_setgoods/upload/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_setgoods/upload Tag: セット商品マスタ Required parameters: access_token, data_type, data Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_setgoods/upload` ## リファレンス内容 ### セット商品マスタ予約一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は商品管理のー括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | csv:セット商品マスタCSV,gz:セット商品マスタCSVをGZIPで圧縮 | | `data` | セット商品マスタCSVのファイル内容 | 必須 | メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8） | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&data_type=csv&data=set_syohin_code,syohin_code,suryo,set_baika_tnk,set_syohin_name test-set1,test-0001,3,100,TEST-0001 3個セット test-set1,test-0002,4,100,TEST-0002 3個セット' https://api.next-engine.org/api_v1_master_setgoods/upload ``` レスポンス ```json { "result": "success", "que_id": "13", "access_token": "xxx", "access_token_end_date": "2022-09-01 14:19:22", "refresh_token": "xxx", "refresh_token_end_date": "2022-09-03 14:19:22" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_setgoods_upload/`](/api/operations/api_v1_master_setgoods_upload/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (セット商品マスタ) - [セット商品マスタ件数取得](/api/api_v1_master_setgoods/count/) — `POST /api_v1_master_setgoods/count` - [セット商品マスタ検索](/api/api_v1_master_setgoods/search/) — `POST /api_v1_master_setgoods/search` --- # セット在庫マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_setstock/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_setstock/count Tag: セット在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_setstock/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### セット在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | セット商品コード | `set_stock_set_goods_id` | 文字列型 | | | フリー在庫数 | `set_stock_free_quantity` | 数値型 | | | 予約フリー在庫数 | `set_stock_advance_order_free_quantity` | 数値型 | | | 商品区分 | `set_stock_type_id` | 文字列型 | セット商品に含まれる商品の商品区分の中で最大の数字 0:通常, 10:予約, 20:受注発注 | | 最終更新日 | `set_stock_last_modified_date` | 日時型 | 以下のうちで最も直近の日時 1. セット商品に含まれる商品の組み合わせか数量が変更された日時 2. セット商品に含まれる商品の在庫数が変更された日時 3. セット商品に含まれる商品が更新された日時 | サンプル ### サンプル リクエスト ```bash curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&set_stock_set_goods_id-eq=set-test-syohin00001" https://api.next-engine.org/api_v1_master_setstock/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxx", "access_token_end_date": "2022-09-02 18:18:12", "refresh_token": "xxx", "refresh_token_end_date": "2022-09-04 18:18:12", } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_setstock_count/`](/api/operations/api_v1_master_setstock_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (セット在庫マスタ) - [セット在庫マスタ検索](/api/api_v1_master_setstock/search/) — `POST /api_v1_master_setstock/search` --- # セット在庫マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_setstock/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_setstock/search Tag: セット在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_setstock/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### セット在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | セット商品コード | `set_stock_set_goods_id` | 文字列型 | | | フリー在庫数 | `set_stock_free_quantity` | 数値型 | | | 予約フリー在庫数 | `set_stock_advance_order_free_quantity` | 数値型 | | | 商品区分 | `set_stock_type_id` | 文字列型 | セット商品に含まれる商品の商品区分の中で最大の数字 0:通常, 10:予約, 20:受注発注 | | 最終更新日 | `set_stock_last_modified_date` | 日時型 | 以下のうちで最も直近の日時 1. セット商品に含まれる商品の組み合わせか数量が変更された日時 2. セット商品に含まれる商品の在庫数が変更された日時 3. セット商品に含まれる商品が更新された日時 | サンプル ### サンプル リクエスト ```bash curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&offset=0&limit=10000&fields=set_stock_set_goods_id,set_stock_free_quantity,set_stock_advance_order_free_quantity,set_stock_type_id,set_stock_last_modified_date&set_stock_set_goods_id-eq=set-test-syohin00001" https://api.next-engine.org/api_v1_master_setstock/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "set_stock_set_goods_id": "set-test-syohin00001", "set_stock_free_quantity": "0", "set_stock_advance_order_free_quantity": "0", "set_stock_type_id": "0", "set_stock_last_modified_date": "2022-08-25 18:52:46" } ], "access_token": "xxx", "access_token_end_date": "2022-09-02 12:10:10", "refresh_token": "xxx", "refresh_token_end_date": "2022-09-04 12:10:10" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_setstock_search/`](/api/operations/api_v1_master_setstock_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (セット在庫マスタ) - [セット在庫マスタ件数取得](/api/api_v1_master_setstock/count/) — `POST /api_v1_master_setstock/count` --- # 店舗マスタ店舗接続確認 URL: https://developer.next-engine.com/api/api_v1_master_shop/checkconnect/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/checkconnect Tag: 店舗マスタ Required parameters: access_token, shop_id Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/checkconnect` ## リファレンス内容 ### 店舗接続確認 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗の接続確認と同じです 接続に成功した場合はresultがsuccessになります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `shop_id` | 店舗ID | 必須 | 接続確認対象の店舗のshop_id | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 店舗マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | | | 店舗名 | `shop_name` | 文字列型 | | | 店舗名カナ | `shop_kana` | 文字列型 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | 閉店日 | `shop_close_date` | 日時型 | | | 備考 | `shop_note` | 文字列型 | | | モールID | `shop_mall_id` | 数値型 | | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | | オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | | | 税区分ID | `shop_tax_id` | 文字列型 | | | 税区分名 | `shop_tax_name` | 文字列型 | | | 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | 削除フラグ | `shop_deleted_flag` | 文字列型 | | | 作成日 | `shop_creation_date` | 日時型 | | | 最終更新日 | `shop_last_modified_date` | 日時型 | | | 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `shop_creator_id` | 数値型 | | | 作成担当者名 | `shop_creator_name` | 文字列型 | | | 最終更新者ID | `shop_last_modified_by_id` | 数値型 | | | 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id=xxx' \ https://api.next-engine.org/api_v1_master_shop/checkconnect ``` レスポンス ```json { "result": "error", "code": "012005", "message": "FTPユーザ名またはパスワードが違います", "request_id": "", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `012001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `012002` | POSTパラメータにshop_idが指定されていない、または値が空です。 | shop_idを指定してください | | `012003` | 店舗[_xxx_]は存在しません。 | shop_idを確認してください | | `012004` | 店舗[_xxx_]は使用停止中の為、接続確認出来ません。 | メイン機能で店舗の使用を再開してください | | `012005` | _xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_ | 接続失敗の理由を確認してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_checkconnect/`](/api/operations/api_v1_master_shop_checkconnect/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count` - [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create` - [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress` - [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search` - [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update` --- # 店舗マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_shop/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/count Tag: 店舗マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 店舗マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | | | 店舗名 | `shop_name` | 文字列型 | | | 店舗名カナ | `shop_kana` | 文字列型 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | 閉店日 | `shop_close_date` | 日時型 | | | 備考 | `shop_note` | 文字列型 | | | モールID | `shop_mall_id` | 数値型 | | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | | オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | | | 税区分ID | `shop_tax_id` | 文字列型 | | | 税区分名 | `shop_tax_name` | 文字列型 | | | 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | 削除フラグ | `shop_deleted_flag` | 文字列型 | | | 作成日 | `shop_creation_date` | 日時型 | | | 最終更新日 | `shop_last_modified_date` | 日時型 | | | 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `shop_creator_id` | 数値型 | | | 作成担当者名 | `shop_creator_name` | 文字列型 | | | 最終更新者ID | `shop_last_modified_by_id` | 数値型 | | | 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id-eq=xxx' \ https://api.next-engine.org/api_v1_master_shop/count ``` レスポンス ```json { "result": "success", "count": "xxx", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_count/`](/api/operations/api_v1_master_shop_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect` - [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create` - [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress` - [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search` - [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update` --- # 店舗マスタ店舗作成 URL: https://developer.next-engine.com/api/api_v1_master_shop/create/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/create Tag: 店舗マスタ Required parameters: access_token, data Optional parameters: refresh_token, wait_flag, fields, offset, limit, test_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/create` ## リファレンス内容 ### 店舗作成 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗追加と同じです 【注意】メイン機能は50店舗まで作成可能ですが、一度登録した店舗は削除出来ません。開発時はチェックのみ実施するtest_flagを1にしてご利用下さい。店舗数が50になってしまった場合はこちらを確認下さい ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `test_flag` | 1:テスト, 1以外:通常 | 0(通常) | テストの場合、入力チェックのみ実施し店舗を登録しません。作成したshop_idは固定で1を返却します | | `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `shop_id` | 登録した店舗のID | | ### XML形式 入力パラメータのdataで指定する値です サンプルはこちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | | | 店舗情報の親タグ | | 3 | | ○ | | | 作成する店舗のフィールド名と値を指定します必須ではないフィールドは、タグ自体を省略することも可能です(値が空欄の場合と同じ挙動になります) | | 2 | | ○ | | | | | 1 | | ○ | | | | XMLサンプル ```xml 1 楽天店 raku スマホグッズ 1 1 1 login_id password 13 ``` ### 作成仕様 APIで指定できるフィールドの一覧です ここに記載されていないフィールドは指定できません #### 店舗情報 | 項目名 | フィールド名 | データ型 | 省略 | 備考 | | --- | --- | --- | --- | --- | | モール/カートID | `shop_mall_id` | 数値型 | 必須 | モール/カートのIDを指定します。この項目は更新時に指定出来ません | | 店舗名 | `shop_name` | 文字列型 | 必須 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | 必須 | | | 店舗カナ | `shop_kana` | 文字列型 | | | | 備考 | `shop_note` | 文字列型 | | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | | 税区分ID | `shop_tax_id` | 文字列型 | 必須 | 税区分のIDを指定します | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 必須 | 0:商品計で税計算, 1:単価から税計算 | | 通貨単位ID | `shop_currency_unit_id` | 文字列型 | 必須 | 通貨単位のIDを指定します | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します | | ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細はこちらを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます | | ログインID_2 | `mall_login_id2` | 文字列型 | | | ログインID_3 | `mall_login_id3` | 文字列型 | | | パスワード_1 | `mall_password1` | 文字列型 | | | パスワード_2 | `mall_password2` | 文字列型 | | | パスワード_3 | `mall_password3` | 文字列型 | | | インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:適用しない | | 規定の発送方法ID | `default_delivery_id` | 文字列型 | | 発送方法区分のIDを指定します。この項目は更新時に指定出来ません。また「21:ヤマト(コレクト)B2v6」、「25:ヤマト(コレクト)B2v5」、「36:楽天コンビニ受取(ゆうパック)」は規定の発送方法に対応していないため、指定しても規定の発送方法が登録されません | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | #### ログインID/パスワードの扱い | モール/カートID | モール/カート名 | フィールド名 : 項目名 | 備考 | | --- | --- | --- | --- | | 1 | 楽天市場 | mall_login_id2 : SMTP AUTH ID mall_password2 : SMTP AUTH password mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | | | 2 | Yahoo!ショッピング | mall_login_id1 : ストアアカウント(API使用時にのみ登録) mall_password1 : リクエストURL(API使用時にのみ登録) mall_login_id2 : 認証キー(API使用時にのみ登録) mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | | | 3 | DeNAショッピング | mall_login_id1 : ID mall_password1 : password | | | 7 | 電脳卸 | 利用しません | | | 8 | 電話FAX | 利用しません | | | 11 | amazon（プロマーチャント） | mall_login_id1 : Eメールアドレス mall_password1 : パスワード mall_login_id2 : 【MWSアカウント】出品者 ID mall_login_id3 : 【MWSアカウント】マーケットプレイス ID | | | 13 | おちゃのこネット | mall_login_id1 : ログインID mall_password1 : password mall_login_id3 : 管理画面URL | | | 14 | ショップサーブ | mall_login_id1 : ショップID password : mall_password1 mall_login_id2 : 管理画面URL | | | 15 | ヤフオク!ストア | mall_login_id1 : Yahoo! JAPANビジネスID mall_password1 : password mall_login_id2 : YahooJapanID mall_password2 : password | | | 19 | `FutureShop2` | mall_login_id1 : FTPユーザ mall_password1 : password mall_login_id2 : ホスト名 | | | 20 | `ZenCartPro-R` | mall_login_id1 : 在庫更新実行URL mall_login_id2 : FTPホスト名 mall_password2 : 読み込み対象ディレクトリ mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | | | 21 | `EC-CUBE` | mall_login_id1 : 在庫更新用URL mall_password1 : ご利用のバージョンを入力してください。例：2.13.1 | | | 22 | カラーミーショップ | mall_login_id1 : ログインID mall_password1 : password | | | 23 | スーパーデリバリー | mall_login_id1 : ログインID mall_password1 : password | | | 25 | マーキュリー | mall_password2 : FTPホスト mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | | | 26 | `WiseCart` | mall_login_id1 : ショップID | | | 28 | DeNA BtoB market | mall_login_id1 : ログインID mall_password1 : password | | | 30 | ぐるなび食市場 | mall_login_id1 : ID mall_password1 : password | | | 31 | `aiship` | mall_login_id1 : ID mall_password1 : password mall_login_id2 : 管理者用ログイン画面URL | | | 32 | `BuyersClub` | mall_login_id2 : 企業ID | | | 33 | Qoo10(Gmarket) | mall_login_id1 : IDまたはメール mall_password1 : password | | | 35 | MakeShop & NEカート | mall_login_id1 : ショップID mall_password1 : password | | | 40 | `SHOPLIST` | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント 認証キー : mall_login_id2 | | | 41 | 楽天B2B | mall_login_id1 : FTP用 ユーザ mall_password1 : FTP用 password | | | 42 | ポンパレモール | mall_login_id1 : ショップログインID mall_password1 : ショップパスワード | | | 90 | 汎用 | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント mall_login_id2 : 認証キー mall_login_id3 : Ver.1の場合 : 空文字を指定、Ver.2の場合: 2を指定 | | | 91 | 卸 | 利用しません | | ### 店舗数が最大になってしまった場合 開発環境：リカバリすることは出来ませんが、[013011]のエラー(店舗数のチェック)が最後のチェックになっております。このエラーになる場合は、本番環境では登録が成功します 本番環境：お手数ですが弊社まで問い合わせするよう回答をお願いします ### 店舗マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | | | 店舗名 | `shop_name` | 文字列型 | | | 店舗名カナ | `shop_kana` | 文字列型 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | 閉店日 | `shop_close_date` | 日時型 | | | 備考 | `shop_note` | 文字列型 | | | モールID | `shop_mall_id` | 数値型 | | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | | オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | | | 税区分ID | `shop_tax_id` | 文字列型 | | | 税区分名 | `shop_tax_name` | 文字列型 | | | 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | 削除フラグ | `shop_deleted_flag` | 文字列型 | | | 作成日 | `shop_creation_date` | 日時型 | | | 最終更新日 | `shop_last_modified_date` | 日時型 | | | 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `shop_creator_id` | 数値型 | | | 作成担当者名 | `shop_creator_name` | 文字列型 | | | 最終更新者ID | `shop_last_modified_by_id` | 数値型 | | | 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&test_flag=1&data=xxx' \ https://api.next-engine.org/api_v1_master_shop/create ``` レスポンス ```json { "result": "success", "shop_id": "xxx", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `013001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `013002` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください | | `013003` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | XMLの形式を修正してください | | `013004` | dataにshopタグが設定されておりません。 | shopタグを設定してください | | `013005` | 必須の[_xxxxxx_]タグが設定されておりません。 | 必須タグ xxxxxx を設定してください | | `013006` | 必須の[_xxxxxx_]タグの値が設定されておりません。 | 必須タグ xxxxxx に値を設定してください | | `013007` | [_xxxxxx_]タグは指定出来ません。 | タグ xxxxxx は指定できません | | `013008` | shopタグにネストしたタグを設定することは出来ません。 | shopタグのネストは指定できません | | `013009` | _xxxxxx_[_xxxxxxxxx_]は、メイン機能に登録されていない値です。 | フィールド xxxxxx の値を確認してください | | `013010` | shop_tax_calculation_sequence_id[_xxx_]には0又は1を設定して下さい。 | 0または1の値を設定してください | | `013011` | 店舗は50件まで登録可能です。 | 店舗数が上限に達しています。お問い合わせください | | `013012` | shop_hit_syohin_alert_flag[xxxxx]には0又は1を設定して下さい。 | 0または1の値を設定してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_create/`](/api/operations/api_v1_master_shop_create/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect` - [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count` - [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress` - [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search` - [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update` --- # 店舗マスタ受注情報取り込み用メールアドレス取得 URL: https://developer.next-engine.com/api/api_v1_master_shop/mailaddress/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/mailaddress Tag: 店舗マスタ Required parameters: access_token, shop_id Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/mailaddress` ## リファレンス内容 ### 受注情報取り込み用メールアドレス取得 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | | | `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります | | `shop_id` | 店舗ID | 必須 | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `data` | 受注情報取り込み用メールアドレスを含んだ情報。`shop_id` と `receiveorder_mail_address` の2フィールドのみ返却。 | `fields` パラメータなし、固定2フィールド返却のみ。 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 （例） 2016-01-01 01:01:01 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 （例） 2016-01-01 01:01:01 | | ### レスポンスデータ（data フィールド） このエンドポイントは `fields` パラメータを持たず、以下の2フィールドを固定で返します。 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | 入力パラメータで指定した店舗ID | | 受注情報取り込み用メールアドレス | `receiveorder_mail_address` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&shop_id=xxx' https://api.next-engine.org/api_v1_master_shop/mailaddress ``` レスポンス ```json { "result": "success", "data": { "shop_id": "1", "receiveorder_mail_address": "xxxxxxx@xxxxxxx.xxxxx.xxx" }, "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `018001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `018002` | POSTパラメータにshop_idが指定されていない、または値が空です。 | shop_idを指定してください | | `018003` | 店舗[xxx]は存在しません。 | shop_idを確認してください | | `018004` | 店舗[xxx]は使用停止中の為、情報を取得できません。 | メイン機能で店舗の使用を再開してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_mailaddress/`](/api/operations/api_v1_master_shop_mailaddress/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect` - [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count` - [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create` - [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search` - [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update` --- # 店舗マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_shop/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/search Tag: 店舗マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 店舗マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | | | 店舗名 | `shop_name` | 文字列型 | | | 店舗名カナ | `shop_kana` | 文字列型 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | 閉店日 | `shop_close_date` | 日時型 | | | 備考 | `shop_note` | 文字列型 | | | モールID | `shop_mall_id` | 数値型 | | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | | オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | | | 税区分ID | `shop_tax_id` | 文字列型 | | | 税区分名 | `shop_tax_name` | 文字列型 | | | 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | 削除フラグ | `shop_deleted_flag` | 文字列型 | | | 作成日 | `shop_creation_date` | 日時型 | | | 最終更新日 | `shop_last_modified_date` | 日時型 | | | 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `shop_creator_id` | 数値型 | | | 作成担当者名 | `shop_creator_name` | 文字列型 | | | 最終更新者ID | `shop_last_modified_by_id` | 数値型 | | | 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### モール/カート | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モール/カートID | `mall_id` | 数値型 | | | モール/カート名 | `mall_name` | 文字列型 | | | モール/カートカナ | `mall_kana` | 文字列型 | | | 備考 | `mall_note` | 文字列型 | | | 国ID | `mall_country_id` | 文字列型 | | | 削除フラグ | `mall_deleted_flag` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=xxx&shop_id-eq=xxx' \ https://api.next-engine.org/api_v1_master_shop/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "shop_id": "1", "shop_name": "Test01", "shop_kana": "", "shop_abbreviated_name": "tst1", "shop_handling_goods_name": null, "shop_close_date": null, "shop_note": "", "shop_mall_id": "1", "shop_authorization_type_id": "0", "shop_authorization_type_name": null, "shop_tax_id": "0", "shop_tax_name": "税込", "shop_currency_unit_id": "1", "shop_currency_unit_name": "円", "shop_tax_calculation_sequence_id": "1", "shop_type_id": null, "shop_deleted_flag": "0", "shop_creation_date": "2016-12-19 18:04:03", "shop_last_modified_date": "2016-12-19 18:04:03", "shop_last_modified_null_safe_date": "2016-12-19 18:04:03", "shop_creator_id": "2", "shop_creator_name": "xxx", "shop_last_modified_by_id": "2", "shop_last_modified_by_null_safe_id": "2", "shop_last_modified_by_name": "xxx", "shop_last_modified_by_null_safe_name": "xxx" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_search/`](/api/operations/api_v1_master_shop_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect` - [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count` - [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create` - [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress` - [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update` --- # 店舗マスタ店舗更新 URL: https://developer.next-engine.com/api/api_v1_master_shop/update/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_shop/update Tag: 店舗マスタ Required parameters: access_token, shop_id, shop_last_modified_date, data Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_shop/update` ## リファレンス内容 ### 店舗更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗更新と同じです ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `shop_id` | 店舗ID | 必須 | 更新する店舗のshop_id | | `shop_last_modified_date` | 最終更新日 | 必須 | 更新する店舗のshop_last_modified_date API実行時にメイン機能またはアプリで、店舗が更新されていないかを確認するために利用します メイン機能またはアプリで店舗が更新されている場合はエラーになります エラーになったら再度、店舗を検索してAPIを実行して下さい | | `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### XML形式 入力パラメータのdataで指定する値です [店舗作成](/api/param/create_shop#xml)と同じです。更新可能なフィールドのみ異なります XMLサンプル ```xml ラクテン ``` ### 更新仕様 APIで指定できるフィールドの一覧です ここに記載されていないフィールドは指定できません #### 店舗情報 | 項目名 | フィールド名 | データ型 | 値必須 | 備考 | | --- | --- | --- | --- | --- | | 店舗名 | `shop_name` | 文字列型 | ○ | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | ○ | | | 店舗カナ | `shop_kana` | 文字列型 | | | | 備考 | `shop_note` | 文字列型 | | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | | 税区分ID | `shop_tax_id` | 文字列型 | ○ | 税区分のIDを指定します | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | ○ | 0:商品計で税計算, 1:単価から税計算 | | 通貨単位ID | `shop_currency_unit_id` | 文字列型 | ○ | 通貨単位のIDを指定します | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します | | ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細は店舗作成のログインID/パスワードの扱いを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます | | ログインID_2 | `mall_login_id2` | 文字列型 | | | ログインID_3 | `mall_login_id3` | 文字列型 | | | パスワード_1 | `mall_password1` | 文字列型 | | | パスワード_2 | `mall_password2` | 文字列型 | | | パスワード_3 | `mall_password3` | 文字列型 | | | インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:変更しない | | ヤマト請求先顧客コード | `claim_id_yamato` | 文字列型 | | | | 西濃荷送人コード | `claim_id_seinou` | 文字列型 | | | | 福山荷送人コード | `claim_id_fukuyama` | 文字列型 | | | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id=1&shop_last_modified_date=xxx&data=xxx' \ https://api.next-engine.org/api_v1_master_shop/update ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `014001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `014002` | POSTパラメータにshop_idが指定されていない、または値が空です。 | shop_idを指定してください | | `014003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください | | `014004` | POSTパラメータにshop_last_modified_dateが指定されておりません。 | shop_last_modified_dateを指定してください | | `014005` | 店舗[_xxx_]は存在しません。 | shop_idを確認してください | | `014006` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | XMLの形式を修正してください | | `014007` | dataにshopタグが設定されておりません。 | shopタグを設定してください | | `014008` | [_xxxxxx_]タグを指定する場合、値が必須です。 | タグ xxxxxx に値を設定してください | | `014009` | [_xxxxxx_]タグは指定出来ません。 | タグ xxxxxx は指定できません | | `014010` | shopタグにネストしたタグを設定することは出来ません。 | shopタグのネストは指定できません | | `014011` | 更新フィールドが設定されておりません。 | 更新するフィールドを設定してください | | `014012` | _xxxxxx_[_xxxxxxxxxxxx_]は、メイン機能に登録されていない値です。 | フィールド xxxxxx の値を確認してください | | `014013` | shop_tax_calculation_sequence_id[_xxx_]には0又は1を設定して下さい。 | 0または1の値を設定してください | | `014014` | shop_last_modified_dateが更新されています。再度店舗を検索してAPIを実行して下さい。 | 店舗を再検索して最新の日時を取得してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_shop_update/`](/api/operations/api_v1_master_shop_update/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_shop/`](/guides/fields/master_shop/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (店舗マスタ) - [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect` - [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count` - [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create` - [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress` - [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search` --- # 在庫マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_stock/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_stock/count Tag: 在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_stock/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `stock_goods_id` | 文字列型 | | | 在庫数 | `stock_quantity` | 数値型 | | | 引当数 | `stock_allocation_quantity` | 数値型 | | | 不良在庫数 | `stock_defective_quantity` | 数値型 | | | 発注残数 | `stock_remaining_order_quantity` | 数値型 | | | 欠品数 | `stock_out_quantity` | 数値型 | | | フリー在庫数 | `stock_free_quantity` | 数値型 | | | 予約在庫数 | `stock_advance_order_quantity` | 数値型 | | | 予約引当数 | `stock_advance_order_allocation_quantity` | 数値型 | | | 予約フリー在庫数 | `stock_advance_order_free_quantity` | 数値型 | | | 削除フラグ | `stock_deleted_flag` | 文字列型 | | | 作成日 | `stock_creation_date` | 日時型 | | | 最終更新日 | `stock_last_modified_date` | 日時型 | | | 最終更新日 | `stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_creator_id` | 数値型 | | | 作成担当者名 | `stock_creator_name` | 文字列型 | | | 最終更新者ID | `stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F stock_goods_id-like=abcd -F stock_quantity-eq=170 https://api.next-engine.org/api_v1_master_stock/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_stock_count/`](/api/operations/api_v1_master_stock_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (在庫マスタ) - [在庫マスタ検索](/api/api_v1_master_stock/search/) — `POST /api_v1_master_stock/search` --- # 在庫マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_stock/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_stock/search Tag: 在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_stock/search` ## 概要 :::note[在庫数を更新するには] 在庫マスタ API は**参照専用**です。在庫数を更新（登録・変更）する場合は [拠点在庫マスタアップロード](/api/api_v1_warehouse_stock/upload/) を使用してください。 ::: ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `stock_goods_id` | 文字列型 | | | 在庫数 | `stock_quantity` | 数値型 | | | 引当数 | `stock_allocation_quantity` | 数値型 | | | 不良在庫数 | `stock_defective_quantity` | 数値型 | | | 発注残数 | `stock_remaining_order_quantity` | 数値型 | | | 欠品数 | `stock_out_quantity` | 数値型 | | | フリー在庫数 | `stock_free_quantity` | 数値型 | | | 予約在庫数 | `stock_advance_order_quantity` | 数値型 | | | 予約引当数 | `stock_advance_order_allocation_quantity` | 数値型 | | | 予約フリー在庫数 | `stock_advance_order_free_quantity` | 数値型 | | | 削除フラグ | `stock_deleted_flag` | 文字列型 | | | 作成日 | `stock_creation_date` | 日時型 | | | 最終更新日 | `stock_last_modified_date` | 日時型 | | | 最終更新日 | `stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_creator_id` | 数値型 | | | 作成担当者名 | `stock_creator_name` | 文字列型 | | | 最終更新者ID | `stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_stock/search -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F 'fields=stock_goods_id,stock_quantity,stock_allocation_quantity,stock_defective_quantity,stock_remaining_order_quantity,stock_out_quantity,stock_free_quantity,stock_advance_order_quantity,stock_advance_order_allocation_quantity,stock_advance_order_free_quantity,stock_deleted_flag,stock_creation_date,stock_last_modified_date,stock_last_modified_null_safe_date,stock_creator_id,stock_creator_name,stock_last_modified_by_id,stock_last_modified_by_null_safe_id,stock_last_modified_by_name,stock_last_modified_by_null_safe_name' -F stock_goods_id-eq="abcd" -F offset=0 -F limit=1 ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "stock_goods_id": "abcd", "stock_quantity": "170", "stock_allocation_quantity": "0", "stock_defective_quantity": "0", "stock_remaining_order_quantity": "0", "stock_out_quantity": "0", "stock_free_quantity": "170", "stock_advance_order_quantity": "102", "stock_advance_order_allocation_quantity": "0", "stock_advance_order_free_quantity": "102", "stock_deleted_flag": "0", "stock_creation_date": "2017-02-09 17:04:44", "stock_last_modified_date": "2017-02-23 15:06:55", "stock_last_modified_null_safe_date": "2017-02-23 15:06:55", "stock_creator_id": "10003", "stock_creator_name": "xxxxxxxx", "stock_last_modified_by_id": "10003", "stock_last_modified_by_null_safe_id": "10003", "stock_last_modified_by_name": "xxxxxxxx", "stock_last_modified_by_null_safe_name": "xxxxxxxxx" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_stock_search/`](/api/operations/api_v1_master_stock_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (在庫マスタ) - [在庫マスタ件数取得](/api/api_v1_master_stock/count/) — `POST /api_v1_master_stock/count` --- # 在庫入出庫履歴件数取得 URL: https://developer.next-engine.com/api/api_v1_master_stockiohistory/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_stockiohistory/count Tag: 在庫入出庫履歴 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_stockiohistory/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 在庫入出庫履歴 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 在庫入出庫履歴ID | `stock_io_history_id` | 数値型 | | | 店舗コード | `stock_io_history_shop_id` | 数値型 | | | 商品コード | `stock_io_history_goods_id` | 文字列型 | | | 入出庫日 | `stock_io_history_date` | 日時型 | | | 更新前在庫数 | `stock_io_history_before_stock_quantity` | 数値型 | | | 更新後在庫数 | `stock_io_history_after_stock_quantity` | 数値型 | | | 更新前不良在庫数 | `stock_io_history_before_bad_stock_quantity` | 数値型 | | | 更新後不良在庫数 | `stock_io_history_after_bad_stock_quantity` | 数値型 | | | 入出庫数 | `stock_io_history_quantity` | 数値型 | | | 伝票番号 | `stock_io_history_cut_form_id` | 数値型 | 入出庫した処理別の伝票番号が設定される。例えば受注伝票により出庫された場合は受注伝票の伝票番号が設定される。 | | 入出庫フラグ | `stock_io_history_io_flag` | 文字列型 | 0:入庫、1:出庫 | | 入出庫区分 | `stock_io_history_io_type_id` | 文字列型 | | | 入出庫名 | `stock_io_history_io_type_name` | 文字列型 | | | 事由 | `stock_io_history_reason` | 文字列型 | | | 担当者ID | `stock_io_history_pic_id` | 数値型 | | | 担当者名 | `stock_io_history_pic_name` | 文字列型 | | | 削除フラグ | `stock_io_history_deleted_flag` | 文字列型 | | | 作成日 | `stock_io_history_creation_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_io_history_creator_id` | 数値型 | | | 作成担当者名 | `stock_io_history_creator_name` | 文字列型 | | | 最終更新者ID | `stock_io_history_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_io_history_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_io_history_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_io_history_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&stock_io_history_deleted_flag-eq=0' https://api.next-engine.org/api_v1_master_stockiohistory/count ``` レスポンス ```json { "result": "success", "count": "66", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_stockiohistory_count/`](/api/operations/api_v1_master_stockiohistory_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_stockiohistory/`](/guides/fields/master_stockiohistory/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (在庫入出庫履歴) - [在庫入出庫履歴検索](/api/api_v1_master_stockiohistory/search/) — `POST /api_v1_master_stockiohistory/search` --- # 在庫入出庫履歴検索 URL: https://developer.next-engine.com/api/api_v1_master_stockiohistory/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_stockiohistory/search Tag: 在庫入出庫履歴 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_stockiohistory/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 在庫入出庫履歴 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 在庫入出庫履歴ID | `stock_io_history_id` | 数値型 | | | 店舗コード | `stock_io_history_shop_id` | 数値型 | | | 商品コード | `stock_io_history_goods_id` | 文字列型 | | | 入出庫日 | `stock_io_history_date` | 日時型 | | | 更新前在庫数 | `stock_io_history_before_stock_quantity` | 数値型 | | | 更新後在庫数 | `stock_io_history_after_stock_quantity` | 数値型 | | | 更新前不良在庫数 | `stock_io_history_before_bad_stock_quantity` | 数値型 | | | 更新後不良在庫数 | `stock_io_history_after_bad_stock_quantity` | 数値型 | | | 入出庫数 | `stock_io_history_quantity` | 数値型 | | | 伝票番号 | `stock_io_history_cut_form_id` | 数値型 | 入出庫した処理別の伝票番号が設定される。例えば受注伝票により出庫された場合は受注伝票の伝票番号が設定される。 | | 入出庫フラグ | `stock_io_history_io_flag` | 文字列型 | 0:入庫、1:出庫 | | 入出庫区分 | `stock_io_history_io_type_id` | 文字列型 | | | 入出庫名 | `stock_io_history_io_type_name` | 文字列型 | | | 事由 | `stock_io_history_reason` | 文字列型 | | | 担当者ID | `stock_io_history_pic_id` | 数値型 | | | 担当者名 | `stock_io_history_pic_name` | 文字列型 | | | 削除フラグ | `stock_io_history_deleted_flag` | 文字列型 | | | 作成日 | `stock_io_history_creation_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_io_history_creator_id` | 数値型 | | | 作成担当者名 | `stock_io_history_creator_name` | 文字列型 | | | 最終更新者ID | `stock_io_history_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_io_history_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_io_history_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_io_history_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&stock_io_history_deleted_flag-eq=0&fields=stock_io_history_id, stock_io_history_goods_id, stock_io_history_date&offset=0&limit=5' https://api.next-engine.org/api_v1_master_stockiohistory/search ``` レスポンス ```json { "result": "success", "count": "5", "data": [ { "stock_io_history_id": "1", "stock_io_history_goods_id": "T101", "stock_io_history_date": "2017-01-18 15:40:06" }, { "stock_io_history_id": "2", "stock_io_history_goods_id": "T101", "stock_io_history_date": "2017-01-18 15:50:26" }, { "stock_io_history_id": "3", "stock_io_history_goods_id": "T101", "stock_io_history_date": "2017-01-18 16:12:04" }, { "stock_io_history_id": "4", "stock_io_history_goods_id": "T101", "stock_io_history_date": "2017-02-10 14:55:59" }, { "stock_io_history_id": "5", "stock_io_history_goods_id": "T101", "stock_io_history_date": "2017-02-10 14:58:10" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_stockiohistory_search/`](/api/operations/api_v1_master_stockiohistory_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_stockiohistory/`](/guides/fields/master_stockiohistory/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (在庫入出庫履歴) - [在庫入出庫履歴件数取得](/api/api_v1_master_stockiohistory/count/) — `POST /api_v1_master_stockiohistory/count` --- # 仕入先マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_supplier/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_supplier/count Tag: 仕入先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_supplier/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 仕入先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入先コード | `supplier_id` | 文字列型 | | | 仕入先名 | `supplier_name` | 文字列型 | | | 仕入先カナ | `supplier_kana` | 文字列型 | | | 郵便番号 | `supplier_zip_code` | 文字列型 | | | 住所１ | `supplier_address1` | 文字列型 | | | 住所２ | `supplier_address2` | 文字列型 | | | 電話番号 | `supplier_tel` | 文字列型 | | | FAX番号 | `supplier_fax` | 文字列型 | | | メールアドレス | `supplier_mail_address` | 文字列型 | | | 部署名 | `supplier_post` | 文字列型 | | | 担当者名 | `supplier_pic_name` | 文字列型 | | | 担当者カナ | `supplier_pic_kana` | 文字列型 | | | 部署郵便番号 | `supplier_post_zip_code` | 文字列型 | | | 部署住所１ | `supplier_post_address1` | 文字列型 | | | 部署住所２ | `supplier_post_address2` | 文字列型 | | | 部署電話番号 | `supplier_post_tel` | 文字列型 | | | 部署FAX | `supplier_post_fax` | 文字列型 | | | 部署メールアドレス | `supplier_post_mail_address` | 文字列型 | | | 発注区分 | `supplier_order_id` | 文字列型 | | | 発注名 | `supplier_order_name` | 文字列型 | | | 数量条件 | `supplier_condition_quantity` | 数値型 | | | 金額条件 | `supplier_condition_money` | 数値型 | | | 発注条件区分 | `supplier_order_condition_id` | 文字列型 | | | 発注条件名 | `supplier_order_condition_name` | 文字列型 | | | 発注保留日 | `supplier_order_pending_date` | 文字列型 | | | 支払方法区分 | `supplier_pay_out_id` | 文字列型 | | | 支払方法名 | `supplier_pay_out_name` | 文字列型 | | | 締日 | `supplier_closing_day` | 文字列型 | | | 支払サイト日 | `supplier_usance_date` | 文字列型 | | | 発注無効フラグ | `supplier_order_invalid_flag` | 文字列型 | | | 発注禁止日 | `supplier_order_forbid_date` | 日時型 | | | 備考 | `supplier_note` | 文字列型 | | | 掛率 | `supplier_wholesale_retail_ratio` | 数値型 | | | 削除フラグ | `supplier_deleted_flag` | 文字列型 | | | 作成日 | `supplier_creation_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supplier_creator_id` | 数値型 | | | 作成担当者名 | `supplier_creator_name` | 文字列型 | | | 最終更新者ID | `supplier_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supplier_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supplier_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supplier_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_supplier/count -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F supplier_name-like=%VENDOR -F supplier_id-eq=8888 ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_supplier_count/`](/api/operations/api_v1_master_supplier_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入先マスタ) - [仕入先マスタ検索](/api/api_v1_master_supplier/search/) — `POST /api_v1_master_supplier/search` --- # 仕入先マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_supplier/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_supplier/search Tag: 仕入先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_supplier/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 仕入先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入先コード | `supplier_id` | 文字列型 | | | 仕入先名 | `supplier_name` | 文字列型 | | | 仕入先カナ | `supplier_kana` | 文字列型 | | | 郵便番号 | `supplier_zip_code` | 文字列型 | | | 住所１ | `supplier_address1` | 文字列型 | | | 住所２ | `supplier_address2` | 文字列型 | | | 電話番号 | `supplier_tel` | 文字列型 | | | FAX番号 | `supplier_fax` | 文字列型 | | | メールアドレス | `supplier_mail_address` | 文字列型 | | | 部署名 | `supplier_post` | 文字列型 | | | 担当者名 | `supplier_pic_name` | 文字列型 | | | 担当者カナ | `supplier_pic_kana` | 文字列型 | | | 部署郵便番号 | `supplier_post_zip_code` | 文字列型 | | | 部署住所１ | `supplier_post_address1` | 文字列型 | | | 部署住所２ | `supplier_post_address2` | 文字列型 | | | 部署電話番号 | `supplier_post_tel` | 文字列型 | | | 部署FAX | `supplier_post_fax` | 文字列型 | | | 部署メールアドレス | `supplier_post_mail_address` | 文字列型 | | | 発注区分 | `supplier_order_id` | 文字列型 | | | 発注名 | `supplier_order_name` | 文字列型 | | | 数量条件 | `supplier_condition_quantity` | 数値型 | | | 金額条件 | `supplier_condition_money` | 数値型 | | | 発注条件区分 | `supplier_order_condition_id` | 文字列型 | | | 発注条件名 | `supplier_order_condition_name` | 文字列型 | | | 発注保留日 | `supplier_order_pending_date` | 文字列型 | | | 支払方法区分 | `supplier_pay_out_id` | 文字列型 | | | 支払方法名 | `supplier_pay_out_name` | 文字列型 | | | 締日 | `supplier_closing_day` | 文字列型 | | | 支払サイト日 | `supplier_usance_date` | 文字列型 | | | 発注無効フラグ | `supplier_order_invalid_flag` | 文字列型 | | | 発注禁止日 | `supplier_order_forbid_date` | 日時型 | | | 備考 | `supplier_note` | 文字列型 | | | 掛率 | `supplier_wholesale_retail_ratio` | 数値型 | | | 削除フラグ | `supplier_deleted_flag` | 文字列型 | | | 作成日 | `supplier_creation_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_date` | 日時型 | | | 最終更新日 | `supplier_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supplier_creator_id` | 数値型 | | | 作成担当者名 | `supplier_creator_name` | 文字列型 | | | 最終更新者ID | `supplier_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supplier_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supplier_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supplier_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST https://api.next-engine.org/api_v1_master_supplier/search -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxxx -F wait_flag=1 -F 'fields=supplier_id,supplier_name,supplier_kana,supplier_zip_code,supplier_address1,supplier_address2,supplier_tel,supplier_fax,supplier_mail_address,supplier_post,supplier_pic_name,supplier_pic_kana,supplier_post_zip_code,supplier_post_address1,supplier_post_address2,supplier_post_tel,supplier_post_fax,supplier_post_mail_address,supplier_order_id,supplier_order_name,supplier_condition_quantity,supplier_condition_money,supplier_order_condition_id,supplier_order_condition_name,supplier_order_pending_date,supplier_pay_out_id,supplier_pay_out_name,supplier_closing_day,supplier_usance_date,supplier_order_invalid_flag,supplier_order_forbid_date,supplier_note,supplier_wholesale_retail_ratio,supplier_deleted_flag,supplier_creation_date,supplier_last_modified_date,supplier_last_modified_null_safe_date,supplier_creator_id,supplier_creator_name,supplier_last_modified_by_id,supplier_last_modified_by_null_safe_id,supplier_last_modified_by_name,supplier_last_modified_by_null_safe_name' -F offset=0 -F limit=1 -F supplier_name-like=%VENDOR -F supplier_id-eq=8888 ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "supplier_id": "8888", "supplier_name": "TEST VENDOR", "supplier_kana": "", "supplier_zip_code": "", "supplier_address1": "", "supplier_address2": "", "supplier_tel": "", "supplier_fax": "", "supplier_mail_address": "", "supplier_post": "", "supplier_pic_name": "", "supplier_pic_kana": "", "supplier_post_zip_code": "", "supplier_post_address1": "", "supplier_post_address2": "", "supplier_post_tel": "", "supplier_post_fax": "", "supplier_post_mail_address": "", "supplier_order_id": "20", "supplier_order_name": "PDFとXLS", "supplier_condition_quantity": "0", "supplier_condition_money": "0.00", "supplier_order_condition_id": "0", "supplier_order_condition_name": "無し", "supplier_order_pending_date": null, "supplier_pay_out_id": null, "supplier_pay_out_name": null, "supplier_closing_day": null, "supplier_usance_date": null, "supplier_order_invalid_flag": "0", "supplier_order_forbid_date": null, "supplier_note": "", "supplier_wholesale_retail_ratio": "0.0", "supplier_deleted_flag": "0", "supplier_creation_date": "2017-02-09 16:19:57", "supplier_last_modified_date": null, "supplier_last_modified_null_safe_date": "2017-02-09 16:19:57", "supplier_creator_id": "10003", "supplier_creator_name": "xxxxxxxx", "supplier_last_modified_by_id": null, "supplier_last_modified_by_null_safe_id": "10003", "supplier_last_modified_by_name": null, "supplier_last_modified_by_null_safe_name": "xxxxxxxxx" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_supplier_search/`](/api/operations/api_v1_master_supplier_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入先マスタ) - [仕入先マスタ件数取得](/api/api_v1_master_supplier/count/) — `POST /api_v1_master_supplier/count` --- # 卸先マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_master_wholesale/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_wholesale/count Tag: 卸先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_wholesale/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 卸先コード | `wholesale_id` | 文字列型 | | | 卸先名 | `wholesale_name` | 文字列型 | | | 卸先カナ | `wholesale_kana` | 文字列型 | | | 部署名 | `wholesale_post_name` | 文字列型 | | | 郵便番号 | `wholesale_zip_code` | 文字列型 | | | 住所1 | `wholesale_address1` | 文字列型 | | | 住所2 | `wholesale_address2` | 文字列型 | | | 電話番号 | `wholesale_phone` | 文字列型 | | | FAX番号 | `wholesale_fax` | 文字列型 | | | メールアドレス | `wholesale_mail_address` | 文字列型 | | | 送付先名 | `wholesale_destination_pic_name` | 文字列型 | | | 送付先カナ | `wholesale_destination_pic_kana` | 文字列型 | | | 送付先郵便番号 | `wholesale_destination_zip_code` | 文字列型 | | | 送付先住所1 | `wholesale_destination_address1` | 文字列型 | | | 送付先住所2 | `wholesale_destination_address2` | 文字列型 | | | 送付先電話番号 | `wholesale_destination_phone` | 文字列型 | | | 発送方法区分 | `wholesale_delivery_id` | 文字列型 | | | 発送方法名 | `wholesale_delivery_name` | 文字列型 | | | 支払区分 | `wholesale_payment_method_id` | 文字列型 | | | 支払名 | `wholesale_payment_method_name` | 文字列型 | | | 掛率 | `wholesale_retail_ratio` | 数値型 | | | 卸先番号 | `wholesale_destination_no` | 数値型 | | | 与信枠（円） | `wholesale_credit_line_price` | 数値型 | | | 締日 | `wholesale_closing_day` | 数値型 | | | 備考 | `wholesale_note` | 文字列型 | | | 削除フラグ | `wholesale_deleted_flag` | 文字列型 | | | 作成日 | `wholesale_creation_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `wholesale_creator_id` | 数値型 | | | 作成担当者名 | `wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&wholesale_deleted_flag-eq=0' https://api.next-engine.org/api_v1_master_wholesale/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_wholesale_count/`](/api/operations/api_v1_master_wholesale_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_wholesale/`](/guides/fields/master_wholesale/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (卸先マスタ) - [卸先マスタ検索](/api/api_v1_master_wholesale/search/) — `POST /api_v1_master_wholesale/search` --- # 卸先マスタ検索 URL: https://developer.next-engine.com/api/api_v1_master_wholesale/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_master_wholesale/search Tag: 卸先マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_master_wholesale/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 卸先コード | `wholesale_id` | 文字列型 | | | 卸先名 | `wholesale_name` | 文字列型 | | | 卸先カナ | `wholesale_kana` | 文字列型 | | | 部署名 | `wholesale_post_name` | 文字列型 | | | 郵便番号 | `wholesale_zip_code` | 文字列型 | | | 住所1 | `wholesale_address1` | 文字列型 | | | 住所2 | `wholesale_address2` | 文字列型 | | | 電話番号 | `wholesale_phone` | 文字列型 | | | FAX番号 | `wholesale_fax` | 文字列型 | | | メールアドレス | `wholesale_mail_address` | 文字列型 | | | 送付先名 | `wholesale_destination_pic_name` | 文字列型 | | | 送付先カナ | `wholesale_destination_pic_kana` | 文字列型 | | | 送付先郵便番号 | `wholesale_destination_zip_code` | 文字列型 | | | 送付先住所1 | `wholesale_destination_address1` | 文字列型 | | | 送付先住所2 | `wholesale_destination_address2` | 文字列型 | | | 送付先電話番号 | `wholesale_destination_phone` | 文字列型 | | | 発送方法区分 | `wholesale_delivery_id` | 文字列型 | | | 発送方法名 | `wholesale_delivery_name` | 文字列型 | | | 支払区分 | `wholesale_payment_method_id` | 文字列型 | | | 支払名 | `wholesale_payment_method_name` | 文字列型 | | | 掛率 | `wholesale_retail_ratio` | 数値型 | | | 卸先番号 | `wholesale_destination_no` | 数値型 | | | 与信枠（円） | `wholesale_credit_line_price` | 数値型 | | | 締日 | `wholesale_closing_day` | 数値型 | | | 備考 | `wholesale_note` | 文字列型 | | | 削除フラグ | `wholesale_deleted_flag` | 文字列型 | | | 作成日 | `wholesale_creation_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `wholesale_creator_id` | 数値型 | | | 作成担当者名 | `wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=wholesale_id, wholesale_name,wholesale_kana,wholesale_deleted_flag&wholesale_deleted_flag-eq=0&offset=0&limit=100' https://api.next-engine.org/api_v1_master_wholesale/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "wholesale_id": "5555", "wholesale_name": "hcm - wholesaler", "wholesale_kana": "", "wholesale_deleted_flag": "0" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_master_wholesale_search/`](/api/operations/api_v1_master_wholesale_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/master_wholesale/`](/guides/fields/master_wholesale/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (卸先マスタ) - [卸先マスタ件数取得](/api/api_v1_master_wholesale/count/) — `POST /api_v1_master_wholesale/count` --- # 実行結果お知らせの追加 URL: https://developer.next-engine.com/api/api_v1_notice_execution/add/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_notice_execution/add Tag: 実行結果お知らせ Required parameters: access_token, execution_notice_title, execution_notice_content Optional parameters: refresh_token, wait_flag, fields, offset, limit, execution_notice_success ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_notice_execution/add` ## リファレンス内容 ### 実行結果お知らせ追加について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 実行結果のお知らせを追加します 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `execution_notice_success` | 成功/失敗フラグ | 可能 省略時は成功(1)とする | 1:成功通知 0:失敗通知 | | `execution_notice_title` | お知らせの件名 | 必須 | | | `execution_notice_content` | お知らせの内容 | 必須 | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `execution_notice_id` | お知らせ通知ID | このIDは実行結果お知らせの検索などに利用できます | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | ### 実行結果お知らせ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | お知らせ通知ID | `execution_notice_id` | 数値型 | 実行結果お知らせ通知に一意に付与される番号 | | 成功/失敗フラグ | `execution_notice_success` | 数値型 | 0=失敗、1=成功 | | 件名 | `execution_notice_title` | 文字列型 | お知らせ通知件名 | | 内容 | `execution_notice_content` | 文字列型 | お知らせ通知内容 | | 既読/未読フラグ | `execution_notice_read` | 数値型 | 0=未読、1=既読 | | 作成日 | `execution_notice_creation_date` | 日時型 | 実行結果通知が作成された日時 | | 最終更新日 | `execution_notice_last_modified_date` | 日時型 | 実行結果通知が最後に修正された日時 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&execution_notice_success=1&execution_notice_title=xxx&execution_notice_content=xxx' http://api.next-engine.org/api_v1_notice_execution/add ``` レスポンス ```json { "execution_notice_id": "29", "result": "success", "access_token": "xxx", "access_token_end_date": "2018-08-02 10:41:04", "refresh_token": "xxx", "refresh_token_end_date": "2018-08-04 10:41:04" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `019001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `019002` | POSTパラメータにexecution_notice_titleが指定されていない、または値が空です。 | execution_notice_titleを指定してください | | `019003` | POSTパラメータにexecution_notice_contentが指定されていない、または値が空です。 | execution_notice_contentを指定してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_notice_execution_add/`](/api/operations/api_v1_notice_execution_add/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (実行結果お知らせ) - [実行結果お知らせ件数取得](/api/api_v1_notice_execution/count/) — `POST /api_v1_notice_execution/count` - [実行結果お知らせ検索](/api/api_v1_notice_execution/search/) — `POST /api_v1_notice_execution/search` --- # 実行結果お知らせ件数取得 URL: https://developer.next-engine.com/api/api_v1_notice_execution/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_notice_execution/count Tag: 実行結果お知らせ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_notice_execution/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 実行結果お知らせ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | お知らせ通知ID | `execution_notice_id` | 数値型 | 実行結果お知らせ通知に一意に付与される番号 | | 成功/失敗フラグ | `execution_notice_success` | 数値型 | 0=失敗、1=成功 | | 件名 | `execution_notice_title` | 文字列型 | お知らせ通知件名 | | 内容 | `execution_notice_content` | 文字列型 | お知らせ通知内容 | | 既読/未読フラグ | `execution_notice_read` | 数値型 | 0=未読、1=既読 | | 作成日 | `execution_notice_creation_date` | 日時型 | 実行結果通知が作成された日時 | | 最終更新日 | `execution_notice_last_modified_date` | 日時型 | 実行結果通知が最後に修正された日時 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx' http://api.next-engine.org/api_v1_notice_execution/count ``` レスポンス ```json { "result": "success", "count": "20", "access_token": "xxx", "access_token_end_date": "2018-08-02 10:41:04", "refresh_token": "xxx", "refresh_token_end_date": "2018-08-04 10:41:04" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_notice_execution_count/`](/api/operations/api_v1_notice_execution_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (実行結果お知らせ) - [実行結果お知らせの追加](/api/api_v1_notice_execution/add/) — `POST /api_v1_notice_execution/add` - [実行結果お知らせ検索](/api/api_v1_notice_execution/search/) — `POST /api_v1_notice_execution/search` --- # 実行結果お知らせ検索 URL: https://developer.next-engine.com/api/api_v1_notice_execution/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_notice_execution/search Tag: 実行結果お知らせ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_notice_execution/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 実行結果お知らせ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | お知らせ通知ID | `execution_notice_id` | 数値型 | 実行結果お知らせ通知に一意に付与される番号 | | 成功/失敗フラグ | `execution_notice_success` | 数値型 | 0=失敗、1=成功 | | 件名 | `execution_notice_title` | 文字列型 | お知らせ通知件名 | | 内容 | `execution_notice_content` | 文字列型 | お知らせ通知内容 | | 既読/未読フラグ | `execution_notice_read` | 数値型 | 0=未読、1=既読 | | 作成日 | `execution_notice_creation_date` | 日時型 | 実行結果通知が作成された日時 | | 最終更新日 | `execution_notice_last_modified_date` | 日時型 | 実行結果通知が最後に修正された日時 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&fields=execution_notice_id, execution_notice_title' http://api.next-engine.org/api_v1_notice_execution/search ``` レスポンス ```json { "result": "success", "count": "5", "data": [ { "execution_notice_id": "1", "execution_notice_title": "受注一括更新が成功しました" }, { "execution_notice_id": "2", "execution_notice_title": "受注一括更新が成功しました" }, { "execution_notice_id": "3", "execution_notice_title": "受注一括更新が成功しました" }, { "execution_notice_id": "4", "execution_notice_title": "受注一括更新が一部失敗しました" }, { "execution_notice_id": "5", "execution_notice_title": "受注一括更新が一部失敗しました" } ], "access_token": "xxx", "access_token_end_date":"2018-08-02 10:41:04" "refresh_token": "xxx", "refresh_token_end_date": "2018-08-04 10:41:04" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_notice_execution_search/`](/api/operations/api_v1_notice_execution_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (実行結果お知らせ) - [実行結果お知らせの追加](/api/api_v1_notice_execution/add/) — `POST /api_v1_notice_execution/add` - [実行結果お知らせ件数取得](/api/api_v1_notice_execution/count/) — `POST /api_v1_notice_execution/count` --- # 発注伝票件数取得 URL: https://developer.next-engine.com/api/api_v1_placeorder_base/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_placeorder_base/count Tag: 発注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_placeorder_base/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 発注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_id` | 数値型 | | | 発注日 | `place_order_date` | 日時型 | | | 仕入コード | `place_order_supplier_id` | 文字列型 | | | 発注合計金 | `place_order_total_amount` | 数値型 | | | 備考 | `place_order_note` | 文字列型 | | | 発注伝票区分 | `place_order_status_id` | 文字列型 | | | 発注伝票区分名 | `place_order_status_name` | 文字列型 | | | 数量条件 | `place_order_condition_quantity` | 数値型 | | | 金額条件 | `place_order_condition_money` | 数値型 | | | 発注条件区分 | `place_order_condition_id` | 文字列型 | | | 発注条件区分名 | `place_order_condition_name` | 文字列型 | | | キャンセルフラグ | `place_order_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 作成日 | `place_order_creation_date` | 日時型 | | | 作成担当者ID | `place_order_creator_id` | 数値型 | | | 作成担当者名 | `place_order_creator_name` | 文字列型 | | | 最終更新日 | `place_order_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 最終更新者ID | `place_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&place_order_last_modified_null_safe_date-gt=2020-07-01 00:00:00' https://api.next-engine.org/api_v1_placeorder_base/count ``` レスポンス ```json { "result": "success" "count": "xxx", "access_token":"xxxxxxxxxx", "access_token_end_date":"2020-07-01 00:00:00", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2020-07-01 00:00:00" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_placeorder_base_count/`](/api/operations/api_v1_placeorder_base_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (発注伝票) - [発注伝票検索](/api/api_v1_placeorder_base/search/) — `POST /api_v1_placeorder_base/search` --- # 発注伝票検索 URL: https://developer.next-engine.com/api/api_v1_placeorder_base/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_placeorder_base/search Tag: 発注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_placeorder_base/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 発注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_id` | 数値型 | | | 発注日 | `place_order_date` | 日時型 | | | 仕入コード | `place_order_supplier_id` | 文字列型 | | | 発注合計金 | `place_order_total_amount` | 数値型 | | | 備考 | `place_order_note` | 文字列型 | | | 発注伝票区分 | `place_order_status_id` | 文字列型 | | | 発注伝票区分名 | `place_order_status_name` | 文字列型 | | | 数量条件 | `place_order_condition_quantity` | 数値型 | | | 金額条件 | `place_order_condition_money` | 数値型 | | | 発注条件区分 | `place_order_condition_id` | 文字列型 | | | 発注条件区分名 | `place_order_condition_name` | 文字列型 | | | キャンセルフラグ | `place_order_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 作成日 | `place_order_creation_date` | 日時型 | | | 作成担当者ID | `place_order_creator_id` | 数値型 | | | 作成担当者名 | `place_order_creator_name` | 文字列型 | | | 最終更新日 | `place_order_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 最終更新者ID | `place_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&fields=place_order_id,place_order_date,place_order_supplier_id,place_order_total_amount,place_order_note,place_order_status_id,place_order_status_name,place_order_condition_quantity,place_order_condition_money,place_order_condition_id,place_order_condition_name,place_order_cancel_flag,place_order_creation_date,place_order_creator_id,place_order_creator_name,place_order_last_modified_date,place_order_last_modified_by_id,place_order_last_modified_by_name&offset=0&limit=10&place_order_last_modified_null_safe_date-gt=2020-07-01 00:00:00' https://api.next-engine.org/api_v1_placeorder_base/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "place_order_id": "1", "place_order_date": "2019-09-25 11:31:06", "place_order_supplier_id": "9999", "place_order_total_amount": "2.00", "place_order_note": "", "place_order_status_id": "50", "place_order_status_name": "仕入完了", "place_order_condition_quantity": "0", "place_order_condition_money": "0.00", "place_order_condition_id": "0", "place_order_condition_name": "無し", "place_order_cancel_flag": "0", "place_order_creation_date": "2019-09-24 14:50:01", "place_order_creator_id": "2", "place_order_creator_name": "2019-03-26のユーザー", "place_order_last_modified_date": "2019-09-25 12:23:53", "place_order_last_modified_by_id": "2", "place_order_last_modified_by_name": "2019-03-26のユーザー" } ], "access_token": "xxxx", "access_token_end_date": "2022-10-01 14:55:24", "refresh_token": "xxxx", "refresh_token_end_date": "2022-10-03 14:55:24" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_placeorder_base_search/`](/api/operations/api_v1_placeorder_base_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (発注伝票) - [発注伝票件数取得](/api/api_v1_placeorder_base/count/) — `POST /api_v1_placeorder_base/count` --- # 発注明細件数取得 URL: https://developer.next-engine.com/api/api_v1_placeorder_row/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_placeorder_row/count Tag: 発注明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_placeorder_row/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 発注明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_row_place_order_id` | 数値型 | | | 発注明細行 | `place_order_row_no` | 数値型 | | | 商品コード | `place_order_row_goods_id` | 文字列型 | | | 商品区分 | `place_order_row_goods_type_id` | 文字列型 | | | 商品区分名 | `place_order_row_goods_type_name` | 文字列型 | | | 商品名 | `place_order_row_goods_name` | 文字列型 | | | 商品オプション | `place_order_row_goods_option` | 文字列型 | | | 発注単価 | `place_order_row_unit_price` | 数値型 | | | 発注数 | `place_order_row_place_quantity` | 数値型 | | | 小計金 | `place_order_row_sub_total_price` | 数値型 | | | 受注伝票番号 | `place_order_row_receive_order_id` | 数値型 | | | 受注明細行 | `place_order_row_receive_order_row_no` | 数値型 | | | 仕入数 | `place_order_row_supply_quantity` | 数値型 | | | キャンセルフラグ | `place_order_row_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 完了フラグ | `place_order_row_completed_flag` | 文字列型 | 1:完了 1以外:完了でない | | 発注種別区分 | `place_order_row_type_id` | 文字列型 | | | 発注種別区分名 | `place_order_row_type_name` | 文字列型 | | | 備考 | `place_order_row_note` | 文字列型 | | | 予定納期 | `place_order_row_delivery_date` | 日時型 | | | 作成日 | `place_order_row_creation_date` | 日時型 | | | 最終更新日 | `place_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `place_order_row_creator_id` | 数値型 | | | 作成担当者名 | `place_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `place_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 発注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_id` | 数値型 | | | 発注日 | `place_order_date` | 日時型 | | | 仕入コード | `place_order_supplier_id` | 文字列型 | | | 発注合計金 | `place_order_total_amount` | 数値型 | | | 備考 | `place_order_note` | 文字列型 | | | 発注伝票区分 | `place_order_status_id` | 文字列型 | | | 発注伝票区分名 | `place_order_status_name` | 文字列型 | | | 数量条件 | `place_order_condition_quantity` | 数値型 | | | 金額条件 | `place_order_condition_money` | 数値型 | | | 発注条件区分 | `place_order_condition_id` | 文字列型 | | | 発注条件区分名 | `place_order_condition_name` | 文字列型 | | | キャンセルフラグ | `place_order_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 作成日 | `place_order_creation_date` | 日時型 | | | 作成担当者ID | `place_order_creator_id` | 数値型 | | | 作成担当者名 | `place_order_creator_name` | 文字列型 | | | 最終更新日 | `place_order_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 最終更新者ID | `place_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1' https://api.next-engine.org/api_v1_placeorder_row/count ``` レスポンス ```json { "result": "success" "count": "xxx", "access_token":"xxxxxxxxxx", "access_token_end_date":"2020-07-01 00:00:00", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2020-07-01 00:00:00" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_placeorder_row_count/`](/api/operations/api_v1_placeorder_row_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (発注明細) - [発注明細検索](/api/api_v1_placeorder_row/search/) — `POST /api_v1_placeorder_row/search` --- # 発注明細検索 URL: https://developer.next-engine.com/api/api_v1_placeorder_row/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_placeorder_row/search Tag: 発注明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_placeorder_row/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 発注明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_row_place_order_id` | 数値型 | | | 発注明細行 | `place_order_row_no` | 数値型 | | | 商品コード | `place_order_row_goods_id` | 文字列型 | | | 商品区分 | `place_order_row_goods_type_id` | 文字列型 | | | 商品区分名 | `place_order_row_goods_type_name` | 文字列型 | | | 商品名 | `place_order_row_goods_name` | 文字列型 | | | 商品オプション | `place_order_row_goods_option` | 文字列型 | | | 発注単価 | `place_order_row_unit_price` | 数値型 | | | 発注数 | `place_order_row_place_quantity` | 数値型 | | | 小計金 | `place_order_row_sub_total_price` | 数値型 | | | 受注伝票番号 | `place_order_row_receive_order_id` | 数値型 | | | 受注明細行 | `place_order_row_receive_order_row_no` | 数値型 | | | 仕入数 | `place_order_row_supply_quantity` | 数値型 | | | キャンセルフラグ | `place_order_row_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 完了フラグ | `place_order_row_completed_flag` | 文字列型 | 1:完了 1以外:完了でない | | 発注種別区分 | `place_order_row_type_id` | 文字列型 | | | 発注種別区分名 | `place_order_row_type_name` | 文字列型 | | | 備考 | `place_order_row_note` | 文字列型 | | | 予定納期 | `place_order_row_delivery_date` | 日時型 | | | 作成日 | `place_order_row_creation_date` | 日時型 | | | 最終更新日 | `place_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `place_order_row_creator_id` | 数値型 | | | 作成担当者名 | `place_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `place_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 発注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注伝票番号 | `place_order_id` | 数値型 | | | 発注日 | `place_order_date` | 日時型 | | | 仕入コード | `place_order_supplier_id` | 文字列型 | | | 発注合計金 | `place_order_total_amount` | 数値型 | | | 備考 | `place_order_note` | 文字列型 | | | 発注伝票区分 | `place_order_status_id` | 文字列型 | | | 発注伝票区分名 | `place_order_status_name` | 文字列型 | | | 数量条件 | `place_order_condition_quantity` | 数値型 | | | 金額条件 | `place_order_condition_money` | 数値型 | | | 発注条件区分 | `place_order_condition_id` | 文字列型 | | | 発注条件区分名 | `place_order_condition_name` | 文字列型 | | | キャンセルフラグ | `place_order_cancel_flag` | 文字列型 | 1:キャンセル 1以外:キャンセルでない | | 作成日 | `place_order_creation_date` | 日時型 | | | 作成担当者ID | `place_order_creator_id` | 数値型 | | | 作成担当者名 | `place_order_creator_name` | 文字列型 | | | 最終更新日 | `place_order_last_modified_date` | 日時型 | | | 最終更新日 | `place_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 最終更新者ID | `place_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `place_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `place_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `place_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&fields=place_order_row_place_order_id,place_order_row_no,place_order_row_goods_id,place_order_row_goods_type_id,place_order_row_goods_type_name,place_order_row_goods_name,place_order_row_goods_option,place_order_row_unit_price,place_order_row_place_quantity,place_order_row_sub_total_price,place_order_row_receive_order_id,place_order_row_receive_order_row_no,place_order_row_supply_quantity,place_order_row_cancel_flag,place_order_row_completed_flag,place_order_row_confirmed_flag,place_order_row_type_id,place_order_row_type_name,place_order_row_note,place_order_row_delivery_date,place_order_row_creation_date,place_order_row_creator_id,place_order_row_creator_name,place_order_row_last_modified_date,place_order_row_last_modified_by_id,place_order_row_last_modified_by_name&offset=0&limit=10' https://api.next-engine.org/api_v1_placeorder_row/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "place_order_row_place_order_id": "1", "place_order_row_no": "1", "place_order_row_goods_id": "test", "place_order_row_goods_type_id": "0", "place_order_row_goods_type_name": "通常", "place_order_row_goods_name": "test", "place_order_row_goods_option": " ", "place_order_row_unit_price": "1.00", "place_order_row_place_quantity": "2", "place_order_row_sub_total_price": "2.00", "place_order_row_receive_order_id": "0", "place_order_row_receive_order_row_no": "0", "place_order_row_supply_quantity": "0", "place_order_row_cancel_flag": "0", "place_order_row_completed_flag": "0", "place_order_row_confirmed_flag": "1", "place_order_row_type_id": "2", "place_order_row_type_name": "手入力", "place_order_row_note": "", "place_order_row_delivery_date": "2019-09-24 00:00:00", "place_order_row_creation_date": "2019-09-24 14:50:01", "place_order_row_creator_id": "2", "place_order_row_creator_name": "2019-03-26のユーザー", "place_order_row_last_modified_date": "2019-09-24 14:50:01", "place_order_row_last_modified_by_id": "2", "place_order_row_last_modified_by_name": "2019-03-26のユーザー" } ], "access_token": "xxxx", "access_token_end_date": "2022-10-01 14:55:24", "refresh_token": "xxxx", "refresh_token_end_date": "2022-10-03 14:55:24" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_placeorder_row_search/`](/api/operations/api_v1_placeorder_row_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (発注明細) - [発注明細件数取得](/api/api_v1_placeorder_row/count/) — `POST /api_v1_placeorder_row/count` --- # 受注伝票一括更新 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bulkupdate Tag: 受注伝票 Required parameters: access_token, data_type, data Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_shipped_update_flag, receive_order_row_cancel_update_flag, receive_order_recalculate_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/bulkupdate` ## リファレンス内容 ### 受注伝票一括更新について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 受注伝票の項目をパラメータで指定した値で一括更新します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | xml:更新データXML, gz:更新データをgzipで圧縮 | | `data` | 更新するデータ | 必須 | XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します [形式はこちら](#xml形式)を参照 | | `receive_order_shipped_update_flag` | 1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可 | 可能(省略時は1以外とする) | | | `receive_order_row_cancel_update_flag` | 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし | 可能(省略時は1以外とする) | このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。 | | `receive_order_recalculate_flag` | 1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない | 可能(省略時は1以外とする) | 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `message` | 一括更新処理の状態を表すメッセージ | 更新が成功している場合は空になります 更新が失敗した場合は失敗した各伝票ごとにreceive_order_id, code, messageが返ります。 詳細はサンプルをご覧ください。 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | ### XML形式 入力パラメータのdataで指定する値です 完成サンプルはこちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | ○ | receive_order_id receive_order_last_modified_date | 受注伝票番号と最終更新日を指定します。 更新する受注伝票が複数ある場合はその分、要素を繰り返します | | 3 | | | | | 受注伝票の項目を指定する要素 更新する受注伝票のフィールド名と値を指定します | | 4 | | | | | | | 4 | | | | | | | 3 | | | | | | | 3 | | | | | 受注伝票オプションの項目を指定する要素 更新する受注伝票オプションのフィールド名と値を指定します | | 4 | | | | | | | 4 | | | | | | | 3 | | | | | | | 3 | | | | | 受注明細の項目を指定する要素 | | 4 | | | ○ | `value` | 属性に更新対象の明細行を指定します 更新する明細行が複数ある場合はその分、要素を繰り返します | | 5 | | | | | 更新する受注明細のフィールド名と値を指定します | | 5 | | | | | | | 4 | <\receive_order_row_no> | | ○ | | | | 3 | <\receiveorder_row> | | | | | | 2 | | ○ | ○ | | | | 1 | | ○ | | | | XML完成サンプル1（受注伝票の更新） ```xml 12345-6789 2014-05-01 00:00:00 ``` XML完成サンプル2（複数の受注伝票の更新） ```xml 12345-6789 2014-05-01 00:00:00 12346-8879 2014-06-02 00:00:00 ``` XML完成サンプル3（受注伝票の更新、オプション項目を含む） ```xml 12345-6789 2014-05-01 00:00:00 xxx ``` XML完成サンプル4（複数の受注伝票と明細の更新） ```xml 12345-6789 2014-05-01 00:00:00 テスト商品1 1 テスト商品2 3 12346-8879 2014-06-02 00:00:00 ``` ### 更新仕様 更新内容の詳細は[受注伝票受注伝票更新ページ](/api/api_v1_receiveorder_base/update)を参照してください ### サンプル リクエスト ```bash curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx&receive_order_shipped_update_flag=1' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdate" ``` 更新成功レスポンス ```json { "result": "success", "message": "", "access_token":"xxxxxxxx", "refresh_token":"xxxxxxxx", "access_token_end_date":"2017-04-15 18:24:53" "refresh_token_end_date":"2017-04-15 18:24:53" } ``` 更新失敗レスポンス ```json { "result": "error", "message": [ { "receive_order_id": "7", "code": "020006", "message": "receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。", }, { "receive_order_id": "8", "code": "020015", "message": "[receive_order_date]日付の形式ではありません。" } ], "access_token":"xxxxxxxx", "refresh_token":"xxxxxxxx", "access_token_end_date":"2017-04-15 18:24:53" "refresh_token_end_date":"2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `020001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `020002` | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `020003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください | | `020004` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください | | `020005` | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `020006` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `020007` | 受注取込中のため、更新出来ません。 | 受注伝票を再検索してAPIを実行してください | | `020008` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください | | `020009` | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | 該当項目は受注メール取込済伝票では更新不可です | | `020010` | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は更新できません | | `020011` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `020014` | 更新フィールドが1つも設定されておりません。 | 更新するフィールドを設定してください | | `020015` | [xxxx]xxxxxxxxxx | フィールド名xxxx についてエラー内容を確認してください | | `020016` | 明細行xx[xxxx]xxxxxxxxxx | 明細行xx のフィールド名xxxx についてエラーを確認してください | | `020017` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注明細追加の条件を確認してください | | `020018` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注伝票と明細の更新条件を確認してください | | `020019` | xxxx[xx]は、メイン機能に登録されていない値です。 | フィールド名xxxx の値xx を確認してください | | `020021` | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | 1000件以内に分割してください | | `020022` | 更新対象が１つも指定されていません。 | 更新対象を指定してください | | `020023` | POSTパラメータにdata_typeが指定されていない、または値が空です。 | data_typeを指定してください | | `020024` | data_typeの値を正しい形式で指定して下さい。 | data_typeを正しい形式で指定してください | | `020025` | data_type[xxx]とdataの形式が一致しません。正しい形式で指定してください。 | data_typeとdataの形式を合わせてください | | `020030` | 所属拠点が異なる店舗に変更することはできません。 | 異なる拠点の店舗への変更はできません。複写後キャンセル処理を実施してください | | `020500` | xxxxxxx | 更新に失敗した伝票を確認してください | | `020999` | 更新処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_bulkupdate/`](/api/operations/api_v1_receiveorder_base_bulkupdate/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 納品書印刷済み一括更新 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdatereceipted/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bulkupdatereceipted Tag: 受注伝票 Required parameters: access_token, data_type, data Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/bulkupdatereceipted` ## リファレンス内容 ### 納品書印刷済み一括更新について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 指定した受注伝票を一括で納品書印刷済みに更新します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | xml:更新データXML, gz:更新データをgzipで圧縮 | | `data` | 更新するデータ | 必須 | XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します [形式はこちら](#xml形式)を参照 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `message` | 一括更新処理の状態を表すメッセージ | 詳細はサンプルをご覧ください。 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | ### XML形式 入力パラメータのdataで指定する値です 完成サンプルはこちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | ○ | receive_order_id receive_order_last_modified_date | 受注伝票番号と最終更新日を指定します。 更新する受注伝票が複数ある場合はその分、要素を繰り返します | | 3 | < receive_order_label_print_flag> | | | | ラベル発行フラグ。1：配送情報出力対象にする | | 2 | | ○ | ○ | | | | 1 | | ○ | | | | XML完成サンプル ```xml 1 0 ``` ### サンプル リクエスト ```bash curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdatereceipted" ``` 更新成功レスポンス ```json { "result": "success", "message": "", "access_token":"xxxxxxxx", "refresh_token":"xxxxxxxx", "access_token_end_date":"2017-04-15 18:24:53" "refresh_token_end_date":"2017-04-15 18:24:53" } ``` 更新失敗レスポンス ```json { "result": "error", "code": "021500", "message": [ { "receive_order_id": "2", "code": "021005", "message": "受注伝票[2]は納品書印刷待ちではありません。" }, { "receive_order_id": "3", "code": "021004", "message": "受注伝票[3]は存在しません。" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2019-09-28 14:55:24", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2019-09-30 14:55:24" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `024001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `024002` | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `024003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください | | `024004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください | | `024005` | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | 伝票の状態を確認してください | | `024006` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません | | `024007` | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | 納品書印刷処理終了後に実行してください | | `024008` | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `024009` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `024010` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `024011` | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | 納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください | | `024013` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 配送情報出力済みの伝票は処理できません | | `024014` | data_typeの値を正しい形式で指定して下さい。 | data_typeを正しい形式で指定してください | | `024015` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください | | `024016` | data_type[xml or gz]とdataの形式が一致しません。正しい形式で指定してください。 | data_typeとdataの形式を合わせてください | | `024018` | POSTパラメータにdata_typeが指定されていない、または値が空です。 | data_typeを指定してください | | `024019` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください | | `024020` | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | 1000件以内に分割してください | | `024021` | 更新対象の受注伝票が１つも指定されていません。 | 更新対象を指定してください | | `024500` | xxxxxxx | 納品書印刷済み一括更新エラーを確認してください | | `024999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_bulkupdatereceipted/`](/api/operations/api_v1_receiveorder_base_bulkupdatereceipted/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票一括同梱 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bundle/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bundle Tag: 受注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/bundle` ## 概要 受注伝票の同梱（複数伝票を1配送にまとめる）を実行する。複数の同梱ジョブを1リクエストで一括処理できる。 同梱先ごとに「どの受注伝票をまとめるか」を指定する。楽観ロック（最終更新日一致）により、他操作との競合を防ぐ。 事前に `bundle_candidate_groups` で同梱可能グループを確認してから実行することを推奨する。 ## 必要なアクセス権限 受注情報更新 ## リファレンス内容 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | | | `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | | | `wait_flag` | 1:メイン機能過負荷でも可能な限りエラーにせず実行 1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい | | `data` | 同梱ジョブの配列（JSON文字列） | 必須 | 下記「`data` の構造」参照 | | `receive_order_recalculate_flag` | 再計算フラグ | 可能 | `"1"`（再計算する）または `"0"`。省略時は `"1"` | #### `data` の構造 `data` は JSON 文字列にエンコードされた配列。各要素が1同梱ジョブ（同梱先1件 + 同梱元N件）を表す。 ```json [ { "receive_order_id": "同梱先の受注伝票番号（文字列）", "receive_order_last_modified_date": "同梱先の最終更新日時 (YYYY-MM-DD HH:MM:SS)", "bundles": [ { "receive_order_id": "同梱元の受注伝票番号（文字列）", "receive_order_last_modified_date": "同梱元の最終更新日時 (YYYY-MM-DD HH:MM:SS)" } ] } ] ``` `receive_order_last_modified_date` は楽観ロック用。DB の最終更新日と一致しない受注伝票はスキップされる。 `data` 配列の要素数は **1〜100 件**。 ### 出力フィールド | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 処理結果 | `result` | string | 成功時は `"success"` | | メッセージ | `message` | string | | | ジョブ結果一覧 | `results` | 配列 | 各ジョブの処理結果。下記参照 | | アクセストークン | `access_token` | string | | | アクセストークン有効期限 | `access_token_end_date` | string | | | リフレッシュトークン | `refresh_token` | string | | | リフレッシュトークン有効期限 | `refresh_token_end_date` | string | | #### `results` の各要素 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 同梱先の受注伝票番号 | `receive_order_id` | integer | | | 同梱成功した受注伝票番号 | `bundled_receive_order_ids` | integer[] | 同梱元として処理された受注伝票番号の配列 | | スキップされた受注伝票番号 | `skipped_receive_order_ids` | integer[] | 楽観ロック不一致などでスキップされた番号の配列 | | スキップ理由 | `skipped_receive_order_reasons` | 配列 | スキップされた受注ごとの理由。下記参照 | #### `skipped_receive_order_reasons` の各要素 | フィールド名 | データ型 | 備考 | | --- | --- | --- | | `receive_order_id` | integer | スキップされた受注伝票番号 | | `reason_message` | string | スキップ理由のメッセージ | #### リクエスト例 ```bash curl -X POST 'https://api.next-engine.org/api_v1_receiveorder_base/bundle' \ -d 'access_token=XXXX' \ -d 'wait_flag=1' \ -d 'receive_order_recalculate_flag=1' \ --data-urlencode 'data=[{"receive_order_id":"72057","receive_order_last_modified_date":"2026-04-01 17:46:04","bundles":[{"receive_order_id":"72056","receive_order_last_modified_date":"2026-04-01 17:46:04"}]}]' ``` `data` パラメータは JSON 文字列なので `--data-urlencode` でエンコードする。 #### レスポンス例（全件成功） ```json { "result": "success", "results": [ { "receive_order_id": 72057, "bundled_receive_order_ids": [72056], "skipped_receive_order_ids": [], "skipped_receive_order_reasons": [] } ], "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` #### レスポンス例（エラー：全同梱元の楽観ロック不一致） 同梱元がすべてスキップ対象になった場合はレスポンスではなくエラーになる（コード `028013`）。 ```json { "result": "error", "code": "028013", "message": "同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致する伝票が1件もありません。", "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` #### レスポンス例（一部スキップ） ```json { "result": "success", "results": [ { "receive_order_id": 72057, "bundled_receive_order_ids": [72056], "skipped_receive_order_ids": [72055], "skipped_receive_order_reasons": [ { "receive_order_id": 72055, "reason_message": "同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致しません。" } ] } ], "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` ### エラーコード このエンドポイント固有のエラーコードを以下に示す。共通エラーコードについては[メッセージコード一覧](/api/param/message/)を参照。 | コード | メッセージ | リカバリ | | --- | --- | --- | | `028001` | 同梱先の受注伝票が存在しません。receive_order_id=を確認してください。 | × | | `028002` | 同梱元のreceive_order_idが指定されていません。 | × | | `028003` | 指定した同梱元の受注伝票がすべて存在しません。 | × | | `028004` | POSTパラメータにdataが指定されていない、または値が空です。 | × | | `028005` | ジョブまたはbundles要素に必須フィールドが指定されていません。 | × | | `028006` | receive_order_idは数字のみで指定してください。 | × | | `028007` | dataのreceive_order_last_modified_dateはYYYY-MM-DD HH:MM:SS形式で指定してください。 | × | | `028008` | 同梱元のreceive_order_idに同梱先と同じ値が指定されています。 | × | | `028009` | 同一ジョブ内で同梱元のreceive_order_idが重複しています。 | × | | `028010` | 発注計算バッチ実行中のため、処理を実行できません。 | ○ | | `028011` | 棚卸中のため、処理を実行できません。 | ○ | | `028012` | 同梱先の受注伝票が同梱条件を満たしていません。 | × | | `028013` | 同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致する伝票が1件もありません。 | × | | `028014` | 同梱先のreceive_order_last_modified_dateがDBの最終更新日と一致しません。 | × | | `028015` | 同梱先・同梱元の組み合わせが同梱条件を満たしていません。 | × | | `028016` | 引当バッチ実行中のため、処理を実行できません。 | ○ | | `028017` | dataの値をJSONとして解析できませんでした。 | × | | `028018` | dataにはJSON配列を指定してください。 | × | | `028019` | 同梱先ジョブ数が上限（100件）を超えています。 | × | | `028020` | 一括同梱の一部または全ジョブが失敗した場合に表示されます。 | × | | `028021` | 同梱処理中に例外が発生したため、処理を行いませんでした。 | × | --- # 受注伝票 同梱候補グループ取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bundle_candidate_groups/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bundle_candidate_groups Tag: 受注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/bundle_candidate_groups` ## 概要 同梱可能な受注伝票をグループ化して返す。各グループ内の受注伝票は互いに同梱可能。 `target_receive_order_ids` を省略すると、同梱可能なすべての受注伝票を対象とする。 ### 同梱候補グループの判定条件 グループに含まれる受注伝票は以下の条件をすべて満たす必要がある： 1. 同じ店舗 2. 有効な伝票（キャンセルされていない） 3. 受注状態が「起票済み」「納品書印刷待ち」「納品書印刷済」のいずれか 4. 送り先名が同じ 5. 送り先住所が同じ 6. 送り先電話番号が同じ 7. 送り先情報がマスク化されていない ## 必要なアクセス権限 受注情報取得 ## リファレンス内容 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | | | `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | | | `wait_flag` | 1:メイン機能過負荷でも可能な限りエラーにせず実行 1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい | | `target_receive_order_ids` | 同梱候補を絞り込む受注伝票番号（カンマ区切り） | 可能 | 省略時は全受注を対象。数値のみ有効。非数値が含まれるとエラー | ### 出力フィールド | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 処理結果 | `result` | string | 成功時は `"success"` | | 同梱候補グループ一覧 | `groups` | 配列の配列（integer） | 各要素は1グループ内の受注伝票番号の配列。グループ内は受注伝票番号の降順、グループ自体も各グループ最大番号の降順で返る。空のグループは返らない | | アクセストークン | `access_token` | string | | | アクセストークン有効期限 | `access_token_end_date` | string | | | リフレッシュトークン | `refresh_token` | string | | | リフレッシュトークン有効期限 | `refresh_token_end_date` | string | | #### リクエスト例 ```bash curl -X POST 'https://api.next-engine.org/api_v1_receiveorder_base/bundle_candidate_groups' \ -d 'access_token=XXXX' \ -d 'target_receive_order_ids=72057,72056,72055' ``` `target_receive_order_ids` を省略すると同梱可能な全受注を対象にする。 #### レスポンス例（成功） ```json { "result": "success", "groups": [ [72057, 72056], [72055, 72054, 72053] ], "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` 同梱可能な受注伝票が存在しない場合: ```json { "result": "success", "groups": [], "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` #### レスポンス例（エラー：非数値の受注伝票番号指定） ```json { "result": "error", "code": "004002", "message": "target_receive_order_ids は数値の ID をカンマ区切りで指定してください。", "access_token": "XXXX", "access_token_end_date": "2026-04-01 18:00:00", "refresh_token": "XXXX", "refresh_token_end_date": "2026-04-08 18:00:00" } ``` ### エラーコード このエンドポイントで返却されるエラーコードを以下に示す。共通エラーコードについては[メッセージコード一覧](/api/param/message/)を参照。 | コード | メッセージ | リカバリ | | --- | --- | --- | | `029001` | receive_order_ids は 10000 件以内で指定してください。 | × | | `029002` | receive_order_ids は半角数字のみをカンマ区切りで指定してください。 | × | | `029003` | 同梱可能グループ検索エラー | × | --- # 受注伝票件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/count Tag: 受注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, extension_execution_id ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `extension_execution_id` | 拡張機能実行ID | 可能 | 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_shop_id-eq=xxx' https://api.next-engine.org/api_v1_receiveorder_base/count ``` レスポンス ```json { "result": "success", "count": "xxx", "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_count/`](/api/operations/api_v1_receiveorder_base_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票分割 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/divide/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/divide Tag: 受注伝票 Required parameters: access_token, receive_order_id, receive_order_last_modified_date, data Optional parameters: refresh_token, wait_flag, fields, offset, limit, credit_unauthorized_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/divide` ## リファレンス内容 ### 索引 - 受注伝票分割 - 入力パラメータ - 出力パラメータ - XML形式 ### 受注伝票分割 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は分割処理と同じで、受注伝票をパラメータで指定した値で分割処理します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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形式で指定します [形式はこちら](#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)=空 ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `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になります | ### XML形式 入力パラメータのdataで指定する値です。 分割先の明細行、受注数を指定します。 引当数・予約引当数の指定は出来ません。分割元から引当数・予約引当数が割り当てられ、余った値が分割先の引当数・予約引当数となります。 有効な明細行のみを全て、明細行順に指定してください。 完成サンプルは[こちら](/api/fields/create_shop_sample)を参照。 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | | | 受注明細の項目を指定する要素 | | 3 | | | ○ | `value` | 属性に更新対象の明細行を指定します更新する明細行が複数ある場合はその分、要素を繰り返します | | 4 | | ○ | | | 分割先の受注数を正の整数で指定します | | 3 | | | | | | | 2 | | | | | | | 1 | | ○ | | | | XML完成サンプル（有効な受注明細行のみを、受注明細行順に全て指定する） ```xml 1 0 0 ``` ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | サンプル ### サンプル リクエスト ```bash 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 ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `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` | 分割処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_divide/`](/api/operations/api_v1_receiveorder_base_divide/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票配送情報出力済み URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/labelprinted Tag: 受注伝票 Required parameters: access_token, receive_order_id, receive_order_last_modified_date Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_label_print_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/labelprinted` ## リファレンス内容 ### 配送情報出力済み 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 有効な受注伝票の配送情報ステータスを出力済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | | `receive_order_label_print_flag` | ラベル発行フラグ | | 1：配送情報出力対象にする2：配送情報出力済みにするパラメータが無い場合は「2：配送情報出力済みにする」として処理します。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 出力済みにできる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | ラベル発行フラグ | `receive_order_label_print_flag` | 0：配送情報出力対象にする1：配送情報出力済みにする | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xx&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/labelprinted ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `010001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `010002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `010003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください | | `010004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください | | `010005` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません | | `010006` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 既に出力済みの伝票は処理できません | | `010007` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `010008` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `010009` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `010010` | receive_order_label_print_flag[xxxxxx]は不正な値です。 | 1または2の値を指定してください | | `010012` | 受注伝票[xxxxxx]は配送情報出力済みに出来る状態ではありません。 | 配送情報出力対象の伝票のみ変更可能です | | `010999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_labelprinted/`](/api/operations/api_v1_receiveorder_base_labelprinted/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票納品書印刷済み URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/receipted Tag: 受注伝票 Required parameters: access_token, receive_order_id, receive_order_last_modified_date Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_label_print_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/receipted` ## リファレンス内容 ### 納品書印刷済み 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 有効な納品書印刷待ちの受注伝票を納品書印刷済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | | `receive_order_label_print_flag` | ラベル発行フラグ | 可能 | 1：配送情報出力対象にする上記以外の値は何も処理しません。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 納品書印刷済みにできる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | 受注状態区分 | `receive_order_order_status_id` | 20：納品書印刷待ちの受注伝票 | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること | | ラベル発行フラグ | `receive_order_label_print_flag` | ラベル発行フラグが「0」または「1」ただしこの条件は、上記の入力パラメータreceive_order_label_print_flagで「1」を指定した場合のみ有効。 | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | サンプル ### サンプル リクエスト ```bash 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 ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `008001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `008002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `008003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください | | `008004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください | | `008005` | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | 伝票の状態を確認してください | | `008006` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません | | `008007` | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | 納品書印刷処理終了後に実行してください | | `008008` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `008009` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `008010` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `008011` | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | 納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください | | `008013` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 配送情報出力済みの伝票は処理できません | | `008999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_receipted/`](/api/operations/api_v1_receiveorder_base_receipted/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/search Tag: 受注伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, extension_execution_id ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `extension_execution_id` | 拡張機能実行ID | 可能 | 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。 | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは 成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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_unattended_delivery_flg` | 文字列型 | 0:置き配指定なし 1:置き配指定あり | | 置き配場所名称 | `receive_order_unattended_delivery_location_name` | 文字列型 | 例：宅配ボックス、玄関前、メータボックス | | 発送伝票番号 | `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の場合作成者名 | ### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_option_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | | 受注時店舗原資クーポン | `receive_order_option_received_time_shop_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 受注時モール原資クーポン | `receive_order_option_received_time_mall_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 作成日 | `receive_order_option_creation_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `receive_order_option_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_option_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_option_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_option_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_option_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_option_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル :::tip[はじめての受注検索：推奨フィールドセット] `fields` は必須パラメータですが、130以上あるフィールドから何を選べばいいか迷う場合は、以下の7フィールドが「受注の基本情報」を網羅した最小セットです。 ``` receive_order_id,receive_order_shop_id,receive_order_date,receive_order_import_date,receive_order_status_id,receive_order_status_name,receive_order_buyer_name ``` ::: リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=receive_order_shop_id, receive_order_id, receive_order_cancel_date&receive_order_shop_id-eq=xxx' https://api.next-engine.org/api_v1_receiveorder_base/search ``` レスポンス ```json { "result": "success", "count": "14", "data": [ { "receive_order_shop_id": "1", "receive_order_id": "1", "receive_order_shop_cut_form_id": "12345-6789", "receive_order_date": "2014-05-01 00:00:00", "receive_order_import_date": "2017-01-19 12:55:37", "receive_order_important_check_id": "0", "receive_order_important_check_name": "", "receive_order_confirm_check_id": "1", "receive_order_confirm_check_name": "確認必要（表示）", "receive_order_confirm_ids": "AA:AA#232:AA", "receive_order_gruoping_tag": null, "receive_order_import_type_id": "1", "receive_order_import_type_name": "ＣＳＶ", "receive_order_cancel_type_id": "1", "receive_order_cancel_type_name": "顧客依頼によりキャンセル", "receive_order_cancel_date": "0000-00-00 00:00:00", "receive_order_order_status_id": "2", "receive_order_order_status_name": "起票済(CSV/手入力)", "receive_order_delivery_id": "10", "receive_order_delivery_name": "佐川急便(e飛伝PRO)", "receive_order_payment_method_id": "15", "receive_order_payment_method_name": "銀行振込前払い", "receive_order_total_amount": "2300.00", "receive_order_tax_amount": "0.00", "receive_order_charge_amount": "0.00", "receive_order_delivery_fee_amount": "300.00", "receive_order_other_amount": "0.00", "receive_order_point_amount": "0.00", "receive_order_goods_amount": "2000.00", "receive_order_deposit_amount": "0.00", "receive_order_deposit_type_id": "0", "receive_order_deposit_type_name": "未入金", "receive_order_deposit_date": null, "receive_order_note": "ok\n▼伝票2より▼\n先に頼んだものと一緒に発送お願いします。", "receive_order_include_possible_order_id": "0", "receive_order_include_to_order_id": "3", "receive_order_multi_delivery_parent_order_id": null, "receive_order_divide_from_order_id": null, "receive_order_copy_from_order_id": null, "receive_order_multi_delivery_parent_flag": "0", "receive_order_statement_delivery_instruct_printing_date": "0000-00-00 00:00:00", "receive_order_statement_delivery_printing_date": null, "receive_order_statement_delivery_text": null, "receive_order_send_date": null, "receive_order_send_plan_date": null, "receive_order_send_sequence": null, "receive_order_worker_text": null, "receive_order_picking_instruct": null, "receive_order_label_print_date": null, "receive_order_label_print_flag": "0", "receive_order_hope_delivery_date": null, "receive_order_hope_delivery_time_slot_id": null, "receive_order_hope_delivery_time_slot_name": null, "receive_order_delivery_method_id": "000", "receive_order_delivery_method_name": null, "receive_order_seal1_id": null, "receive_order_seal1_name": null, "receive_order_seal2_id": null, "receive_order_seal2_name": null, "receive_order_seal3_id": null, "receive_order_seal3_name": null, "receive_order_seal4_id": null, "receive_order_seal4_name": null, "receive_order_business_office_stop_id": null, "receive_order_business_office_stop_name": null, "receive_order_invoice_id": null, "receive_order_invoice_name": null, "receive_order_temperature_id": null, "receive_order_temperature_name": null, "receive_order_business_office_name": null, "receive_order_gift_flag": "0", "receive_order_delivery_cut_form_id": null, "receive_order_delivery_cut_form_note": null, "receive_order_credit_type_id": "0", "receive_order_credit_type_name": "なし", "receive_order_credit_approval_no": null, "receive_order_credit_approval_amount": "0.00", "receive_order_credit_approval_type_id": "0", "receive_order_credit_approval_type_name": "必要なし", "receive_order_credit_approval_date": null, "receive_order_credit_approval_rate": "0.00", "receive_order_credit_number_payments": null, "receive_order_credit_authorization_center_id": null, "receive_order_credit_authorization_center_name": null, "receive_order_credit_approval_fax_printing_date": null, "receive_order_customer_type_id": "0", "receive_order_customer_type_name": "一般顧客", "receive_order_customer_id": null, "receive_order_purchaser_name": "テスト 太郎", "receive_order_purchaser_kana": "テスト タロウ", "receive_order_purchaser_zip_code": "2500111", "receive_order_purchaser_address1": "神奈川県 小田原市", "receive_order_purchaser_address2": "栄町2-9-39 小田原EPO", "receive_order_purchaser_tel": "0311112222", "receive_order_purchaser_fax": null, "receive_order_purchaser_mail_address": "test@example.com", "receive_order_consignee_name": "テスト 太郎", "receive_order_consignee_kana": "テスト タロウ", "receive_order_consignee_zip_code": "0111111", "receive_order_consignee_address1": "神奈川県 小田原市", "receive_order_consignee_address2": "栄町2-9-39 小田原EPO", "receive_order_consignee_tel": "0311112222", "receive_order_consignee_fax": null, "receive_order_reminder_start_date": null, "receive_order_reminder_last_date": null, "receive_order_reminder_count": "0", "receive_order_important_check_pic_id": null, "receive_order_important_check_pic_name": null, "receive_order_pic_id": "10002", "receive_order_pic_name": "xxxxxxxx", "receive_order_send_pic_id": null, "receive_order_send_pic_name": null, "receive_order_deleted_flag": "0", "receive_order_creation_date": "2017-01-19 12:55:37", "receive_order_last_modified_date": "2017-03-22 16:19:16", "receive_order_last_modified_null_safe_date": "2017-03-22 16:19:16", "receive_order_creator_id": "10002", "receive_order_creator_name": "xxxxxxx", "receive_order_last_modified_by_id": "9999", "receive_order_last_modified_by_null_safe_id": "9999", "receive_order_last_modified_by_name": "管理者", "receive_order_last_modified_by_null_safe_name": "管理者" }, { "receive_order_shop_id": "1", "receive_order_id": "2", "receive_order_shop_cut_form_id": "RAKUTEN-123TEST", "receive_order_date": "2014-02-06 03:09:00", "receive_order_import_date": "2017-01-19 12:55:38", "receive_order_important_check_id": "0", "receive_order_important_check_name": "", "receive_order_confirm_check_id": "1", "receive_order_confirm_check_name": "確認必要（表示）", "receive_order_confirm_ids": "AG:AO:CT:AA#1:AA#2", "receive_order_gruoping_tag": null, "receive_order_import_type_id": "1", "receive_order_import_type_name": "ＣＳＶ", "receive_order_cancel_type_id": "3", "receive_order_cancel_type_name": "他の伝票への統合の為キャンセル", "receive_order_cancel_date": "2017-02-09 18:26:03", "receive_order_order_status_id": "2", "receive_order_order_status_name": "起票済(CSV/手入力)", "receive_order_delivery_id": "10", "receive_order_delivery_name": "佐川急便(e飛伝PRO)", "receive_order_payment_method_id": "15", "receive_order_payment_method_name": "銀行振込前払い", "receive_order_total_amount": "3180.00", "receive_order_tax_amount": "0.00", "receive_order_charge_amount": "0.00", "receive_order_delivery_fee_amount": "0.00", "receive_order_other_amount": "0.00", "receive_order_point_amount": "0.00", "receive_order_goods_amount": "3180.00", "receive_order_deposit_amount": "0.00", "receive_order_deposit_type_id": "0", "receive_order_deposit_type_name": "未入金", "receive_order_deposit_date": null, "receive_order_note": "先に頼んだものと一緒に発送お願いします。", "receive_order_include_possible_order_id": "1", "receive_order_include_to_order_id": "1", "receive_order_multi_delivery_parent_order_id": null, "receive_order_divide_from_order_id": null, "receive_order_copy_from_order_id": null, "receive_order_multi_delivery_parent_flag": "0", "receive_order_statement_delivery_instruct_printing_date": "0000-00-00 00:00:00", "receive_order_statement_delivery_printing_date": null, "receive_order_statement_delivery_text": null, "receive_order_send_date": null, "receive_order_send_plan_date": null, "receive_order_send_sequence": null, "receive_order_worker_text": null, "receive_order_picking_instruct": null, "receive_order_label_print_date": null, "receive_order_label_print_flag": "0", "receive_order_hope_delivery_date": null, "receive_order_hope_delivery_time_slot_id": null, "receive_order_hope_delivery_time_slot_name": null, "receive_order_delivery_method_id": "000", "receive_order_delivery_method_name": null, "receive_order_seal1_id": null, "receive_order_seal1_name": null, "receive_order_seal2_id": null, "receive_order_seal2_name": null, "receive_order_seal3_id": null, "receive_order_seal3_name": null, "receive_order_seal4_id": null, "receive_order_seal4_name": null, "receive_order_business_office_stop_id": null, "receive_order_business_office_stop_name": null, "receive_order_invoice_id": null, "receive_order_invoice_name": null, "receive_order_temperature_id": " ", "receive_order_temperature_name": null, "receive_order_business_office_name": null, "receive_order_gift_flag": "0", "receive_order_delivery_cut_form_id": null, "receive_order_delivery_cut_form_note": null, "receive_order_credit_type_id": "0", "receive_order_credit_type_name": "なし", "receive_order_credit_approval_no": null, "receive_order_credit_approval_amount": "0.00", "receive_order_credit_approval_type_id": "0", "receive_order_credit_approval_type_name": "必要なし", "receive_order_credit_approval_date": null, "receive_order_credit_approval_rate": "0.00", "receive_order_credit_number_payments": null, "receive_order_credit_authorization_center_id": null, "receive_order_credit_authorization_center_name": null, "receive_order_credit_approval_fax_printing_date": null, "receive_order_customer_type_id": "0", "receive_order_customer_type_name": "一般顧客", "receive_order_customer_id": null, "receive_order_purchaser_name": "テスト 太郎", "receive_order_purchaser_kana": "テスト タロウ", "receive_order_purchaser_zip_code": "2500111", "receive_order_purchaser_address1": "神奈川県 小田原市", "receive_order_purchaser_address2": "栄町2-9-39 小田原EPO", "receive_order_purchaser_tel": "0311112222", "receive_order_purchaser_fax": null, "receive_order_purchaser_mail_address": "test@example.com", "receive_order_consignee_name": "テスト 太郎", "receive_order_consignee_kana": "テスト タロウ", "receive_order_consignee_zip_code": "0111111", "receive_order_consignee_address1": "神奈川県 小田原市", "receive_order_consignee_address2": "栄町2-9-39 小田原EPO", "receive_order_consignee_tel": "0311112222", "receive_order_consignee_fax": null, "receive_order_reminder_start_date": null, "receive_order_reminder_last_date": null, "receive_order_reminder_count": "0", "receive_order_important_check_pic_id": null, "receive_order_important_check_pic_name": null, "receive_order_pic_id": "10002", "receive_order_pic_name": "xxxxxxx", "receive_order_send_pic_id": null, "receive_order_send_pic_name": null, "receive_order_deleted_flag": "0", "receive_order_creation_date": "2017-01-19 12:55:38", "receive_order_last_modified_date": "2017-02-09 18:26:03", "receive_order_last_modified_null_safe_date": "2017-02-09 18:26:03", "receive_order_creator_id": "10002", "receive_order_creator_name": "xxxxxxx", "receive_order_last_modified_by_id": "10003", "receive_order_last_modified_by_null_safe_id": "10003", "receive_order_last_modified_by_name": "xxxxxxxx", "receive_order_last_modified_by_null_safe_name": "xxxxxxx" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_search/`](/api/operations/api_v1_receiveorder_base_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票出荷確定処理 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/shipped Tag: 受注伝票 Required parameters: access_token, receive_order_id, receive_order_last_modified_date Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/shipped` ## リファレンス内容 ### 出荷確定処理 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は出荷確定処理と同じで、有効な納品書印刷済みの受注伝票を出荷確定済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 出荷確定処理できる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | 受注状態区分 | `receive_order_order_status_id` | 20または40：納品書印刷待ちまたは納品書印刷済みの受注伝票 | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=7&receive_order_last_modified_date=xxx' \ https://api.next-engine.org/api_v1_receiveorder_base/shipped ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `009001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `009002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `009003` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `009004` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `009005` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください | | `009006` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `009007` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | データの内容を確認して正しい形式に修正してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_shipped/`](/api/operations/api_v1_receiveorder_base_shipped/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票更新 URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/update/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/update Tag: 受注伝票 Required parameters: access_token, receive_order_id, receive_order_last_modified_date, data Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_shipped_update_flag, receive_order_row_cancel_update_flag, receive_order_recalculate_flag ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/update` ## リファレンス内容 ### 索引 - 受注伝票更新 - 入力パラメータ - 出力パラメータ - XML形式 - 更新仕様 ### 受注伝票更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 受注伝票の項目をパラメータで指定した値で更新します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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形式で指定します [形式はこちら](#xml形式)を参照 | | `receive_order_shipped_update_flag` | 1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可 | 可能(省略時は1以外とする) | | | `receive_order_row_cancel_update_flag` | 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし | 可能(省略時は1以外とする) | このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。 | | `receive_order_recalculate_flag` | 1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない | 可能(省略時は1以外とする) | 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは 成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | ### XML形式 入力パラメータのdataで指定する値です 完成サンプルは こちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | | | | 受注伝票の項目を指定する要素 更新する 受注伝票のフィールド名と値を指定します | | 3 | | | | | | | 3 | | | | | | | 2 | | | | | | | 2 | | | | | 受注伝票オプションの項目を指定する要素 更新する 受注伝票オプションのフィールド名と値を指定します | | 3 | | | | | | | 3 | | | | | | | 2 | | | | | | | 2 | | | | | 受注明細の項目を指定する要素 | | 3 | | | ○ | `value` | 属性に更新対象の明細行を指定します 更新する明細行が複数ある場合はその分、要素を繰り返します | | 4 | | | | | 更新する 受注明細のフィールド名と値を指定します | | 4 | | | | | | | 3 | | | | | | | 2 | | | | | | | 1 | | ○ | | | | XML完成サンプル1（受注伝票と受注明細を更新） ```xml 12345-6789 2014-05-01 00:00:00 テスト商品 1 テスト商品2 3 ``` XML完成サンプル2（受注伝票の更新と、受注明細の更新と追加） ```xml 12345-6789 2014-05-01 00:00:00 テスト商品 1 テスト商品2 3 ``` XML完成サンプル3（受注伝票のみ更新） ```xml 12345-6789 2014-05-01 00:00:00 ``` ### 更新仕様 APIで指定出来るフィールドの一覧です。 ここに記載されていないフィールドは指定できません。 以下のフィールドはAPIで更新成功した場合、自動的に登録・更新されます。 - 最終更新日 - 最終更新者ID - 重要チェックをつけた場合、重要チェック担当者ID - 更新した受注伝票の操作履歴 受注メール取込済の伝票は、以下のフィールドのみAPIで更新できます。 - 受注キャンセル区分 - 作業用欄 - 受注分類タグ #### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `receive_order_shop_id` | 数値型 | | | 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | メイン機能内でユニークかのチェックはしない | | 受注日 | `receive_order_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 受注確認内容 | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDを":"区切りで設定します。明細行に対する確認は"#"の後に明細行番号が設定されます。 Ex: "AO:AA#1:AA#2"の場合 送り先の郵便番号と住所があってません。 商品コードが商品マスタに存在しません。：1行目 商品コードが商品マスタに存在しません。：2行目 | | 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0：チェックを外す 1：チェックをつける チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る 納品書印刷済み以降はエラーが返る | | 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | タグを[ ]で括る 例：[テストタグ][倉庫A] メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 0：有効 1：顧客依頼によりキャンセル 受注キャンセルコードを指定 | | 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない 整合性が必要な場合は、 発送方法別項目タイプの値を指定 | | 支払区分 | `receive_order_payment_method_id` | 文字列型 | 出荷可能設定の整合性チェックはしない 整合性が必要な場合は、アプリ側で考慮して設定して下さい。 | | 商品計 | `receive_order_goods_amount` | 数値型 | | | 税金 | `receive_order_tax_amount` | 数値型 | | | 手数料 | `receive_order_charge_amount` | 数値型 | | | 発送代 | `receive_order_delivery_fee_amount` | 数値型 | | | 他費用 | `receive_order_other_amount` | 数値型 | | | ポイント数 | `receive_order_point_amount` | 数値型 | | | 総合計 | `receive_order_total_amount` | 数値型 | | | 入金額 | `receive_order_deposit_amount` | 文字列型 | | | 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | | | 入金日 | `receive_order_deposit_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 備考 | `receive_order_note` | 文字列型 | | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | | | 作業用欄 | `receive_order_worker_text` | 文字列型 | | | ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | | | 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 送り状区分 | `receive_order_invoice_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 温度区分 | `receive_order_temperature_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール1区分 | `receive_order_seal1_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール2区分 | `receive_order_seal2_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール3区分 | `receive_order_seal3_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール4区分 | `receive_order_seal4_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | ギフトフラグ | `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_approval_no` | 文字列型 | | | クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | | | クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | | | クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | | | クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 顧客区分 | `receive_order_customer_type_id` | 文字列型 | | | 顧客コード | `receive_order_customer_id` | 文字列型 | | | 購入者名 | `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` | 文字列型 | ハイフンは不要 | | 購入者メールアドレス | `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` | 文字列型 | ハイフンは不要 | | 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 0：チェックしない 1：チェックする | | 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | クレジット支払い回数 | `receive_order_credit_number_payments` | 数値型 | | | 出荷予定日 | `receive_order_send_plan_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 請求金額（0%） | `receive_order_request_amount_tax0` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（8%） | `receive_order_request_amount_tax8` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（10%） | `receive_order_request_amount_tax10` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求額に対する税額（8%） | `receive_order_request_amount_tax_tax8` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 請求額に対する税額（10%） | `receive_order_request_amount_tax_tax10` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 手数料（0%） | `receive_order_charge_amount_tax0` | 数値型 | | | 手数料（8%） | `receive_order_charge_amount_tax8` | 数値型 | | | 手数料（10%） | `receive_order_charge_amount_tax10` | 数値型 | | | 他費用（0%） | `receive_order_other_amount_tax0` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（8%） | `receive_order_other_amount_tax8` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（10%） | `receive_order_other_amount_tax10` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | クーポン割引額（0%） | `receive_order_coupon_amount_tax0` | 数値型 | | | クーポン割引額（8%） | `receive_order_coupon_amount_tax8` | 数値型 | | | クーポン割引額（10%） | `receive_order_coupon_amount_tax10` | 数値型 | | | クーポン割引額（按分） | `receive_order_coupon_amount_distribute` | 数値型 | | | ポイント（0%） | `receive_order_point_amount_tax0` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（8%） | `receive_order_point_amount_tax8` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（10%） | `receive_order_point_amount_tax10` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（按分） | `receive_order_point_amount_distribute` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント） | | ポイント（支払い） | `receive_order_point_amount_payment` | 数値型 | | #### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | #### 受注明細 | 項目名 | フィールド名 | データ型 | 登録 | 更新 | 備考 | | --- | --- | --- | --- | --- | --- | | 明細行番号 | `receive_order_row_no` | 数値型 | | 必須 | 更新のキーとして利用 空の場合、商品コード＋受注数＋αで明細行を最後尾に登録する | | 商品コード | `receive_order_row_goods_id` | 文字列型 | 必須 | | 更新不可 登録時のみ必須 メイン機能の商品マスタにない商品は登録できない | | 商品名 | `receive_order_row_goods_name` | 文字列型 | | | | | 受注数 | `receive_order_row_quantity` | 数値型 | 必須 | | | | 単価 | `receive_order_row_unit_price` | 数値型 | | | | | 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | | | 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | | | 小計金額 | `receive_order_row_sub_total_price` | 数値型 | | | 金額の再計算および整合性チェックはしない 整合性が必要な場合は、アプリ側で計算して設定する | | 商品OP | `receive_order_row_goods_option` | 文字列型 | | | | | キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 0：有効 1：キャンセル 明細は削除できない キャンセルフラグを指定してキャンセルにする | ### サンプル リクエスト ```bash 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' ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `011001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `011002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください | | `011003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください | | `011004` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください | | `011005` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください | | `011006` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください | | `011007` | 受注取込中のため、更新出来ません。 | 受注伝票を再検索してAPIを実行してください | | `011008` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください | | `011009` | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | 該当項目は受注メール取込済伝票では更新不可です | | `011010` | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は更新できません | | `011011` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください | | `011014` | 更新フィールドが1つも設定されておりません。 | 更新するフィールドを設定してください | | `011015` | [xxxx]xxxxxxxxxx | フィールド名xxxx についてエラー内容xxを確認してください | | `011016` | 明細行xx[xxxx]xxxxxxxxxx | 明細行xx のフィールド名xxxx についてエラー内容を確認してください | | `011017` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注明細追加の条件を確認してください | | `011018` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注伝票と明細の更新条件を確認してください | | `011019` | xxxx[xx]は、メイン機能に登録されていない値です。 | フィールド名xxxx の値xx を確認してください | | `011030` | 所属拠点が異なる店舗に変更することはできません。 | 異なる拠点の店舗への変更はできません。複写後キャンセル処理を実施してください | | `011999` | 更新処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_update/`](/api/operations/api_v1_receiveorder_base_update/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload` --- # 受注伝票アップロード URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/upload/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/upload Tag: 受注伝票 Required parameters: access_token, receive_order_upload_pattern_id, data_type_1, data_type_2, data_1, data_2 Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_base/upload` ## リファレンス内容 ### 受注一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は受注一括登録と同じですが、必ず非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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_upload_pattern_id` | 登録対象の受注一括登録パターンID | 必須 | | | `data_type_1` | data_1のファイル種類 | 必須 | csv:受注CSV,gz:受注CSVをGZIPで圧縮 | | `data_type_2` | data_2のファイル種類 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | csv:受注CSV,gz:受注CSVをGZIPで圧縮 | | `data_1` | 受注CSVのファイル内容 | 必須 | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 | | `data_2` | 受注CSVのファイル内容 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_upload_pattern_id=2&data_type_1=csv&data_1=店舗伝票番号,受注日,受注郵便番号,受注住所１,受注住所２,受注名,受注名カナ,受注電話番号,受注メールアドレス,発送郵便番号,発送先住所１,発送先住所２,発送先名,発送先カナ,発送電話番号,支払方法,発送方法,商品計,税金,発送料,手数料,ポイント,その他費用,合計金額,ギフトフラグ,時間帯指定,日付指定,作業者欄,備考,商品名,商品コード,商品価格,受注数量,商品オプション,出荷済フラグ,顧客区分,顧客コード,消費税率（%）,のし,ラッピング,メッセージ test1,2019/03/02 10:00:00,2500011,神奈川県小田原市栄町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,9900845,山形県山形市飯塚町,xxx番地,山田花子,ヤマダハナコ,09011112222,代金引換,宅急便,2400,240,350,200,0,0,3190,0,時間帯指定[午前中],2019/03/15,,よろしくお願いします！,メンズTシャツ：(Lサイズ)ブラック,test-xxx,2400,1,,,,,,,, test2,2019/03/10 10:00:00,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,コンビニ,メール便,3000,300,350,0,0,0,3650,0,時間帯指定[13時-14時],,,ポスト投函でお願いします。,レディースTシャツ：（Mサイズ）レッド,test-099,1000,1,,,,,,,, test2,2019/03/10 10:00:00,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,コンビニ,メール便,3000,300,350,0,0,0,3650,0,時間帯指定[13時-14時],,,ポスト投函でお願いします。,レディースTシャツ：（Mサイズ）ピンク,test-101,500,2,,,,,,,,' https://api.next-engine.org/api_v1_receiveorder_base/upload ``` レスポンス ```json { "result": "success", "que_id": "45", "access_token": "xxxxx", "access_token_end_date": "2022-09-27 18:45:17", "refresh_token": "xxxxx", "refresh_token_end_date": "2022-09-29 18:45:17" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `006001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `006002` | POSTパラメータに_xxxxx_が指定されていません。 | データ種類の指定をしてください | | `006003` | _xxxxx_のデータ種類[_xxx_]が不正です。 | データ種類を正しい値に修正してください | | `006004` | POSTパラメータに_xxxxx_が指定されていません。 | データの指定をしてください | | `006005` | _xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_ | データの内容を正しい形式に修正してください | | `006006` | POSTパラメータにreceive_order_upload_pattern_idが指定されていません。 | receive_order_upload_pattern_idを指定してください | | `006007` | 存在しない受注一括登録パターン[_xxxxxxxxxxxxxxxxx_]です。 | receive_order_upload_pattern_idを正しい値に修正してください | | `006008` | POSTパラメータにdata_type_2を指定する場合は、data_2も指定して下さい。 | data_2を指定してください | | `006009` | POSTパラメータにdata_2を指定する場合は、data_type_2も指定して下さい。 | data_type_2を指定してください | | `006010` | 指定されたファイルは存在していません | アップロードしたファイルを確認してください。保存期間は3日です | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_base_upload/`](/api/operations/api_v1_receiveorder_base_upload/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票) - [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate` - [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted` - [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count` - [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide` - [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted` - [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted` - [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search` - [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped` - [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update` --- # 受注確認内容件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_confirm/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_confirm/count Tag: 受注確認内容 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_confirm/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 受注確認内容 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注確認内容ID | `confirm_id` | 文字列型 | | | 受注確認内容 | `confirm_name` | 文字列型 | 詳細はこちら | | 表示順序 | `confirm_display_order` | 数値型 | | | 説明文(HTML) | `confirm_html` | 文字列型 | 改行や強調表示のHTMLが含まれています | | 設定値 | `confirm_value` | 文字列型 | 受注確認内容設定画面で設定した値（設定可能な項目のみ） | | 有効フラグ | `confirm_valid_flag` | 数値型 | 1:有効 1以外:無効 | | 削除フラグ | `confirm_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `confirm_creation_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `confirm_creator_id` | 数値型 | | | 作成担当者名 | `confirm_creator_name` | 文字列型 | | | 最終更新者ID | `confirm_last_modified_by_id` | 数値型 | | | 最終更新者ID | `confirm_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `confirm_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `confirm_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_confirm/count ``` レスポンス ```json { "result": "success", "count": "75", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_confirm_count/`](/api/operations/api_v1_receiveorder_confirm_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_confirm/`](/guides/fields/receiveorder_confirm/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注確認内容) - [受注確認内容検索](/api/api_v1_receiveorder_confirm/search/) — `POST /api_v1_receiveorder_confirm/search` - [受注確認内容更新](/api/api_v1_receiveorder_confirm/update/) — `POST /api_v1_receiveorder_confirm/update` --- # 受注確認内容検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_confirm/search Tag: 受注確認内容 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_confirm/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注確認内容 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注確認内容ID | `confirm_id` | 文字列型 | | | 受注確認内容 | `confirm_name` | 文字列型 | 詳細はこちら | | 表示順序 | `confirm_display_order` | 数値型 | | | 説明文(HTML) | `confirm_html` | 文字列型 | 改行や強調表示のHTMLが含まれています | | 設定値 | `confirm_value` | 文字列型 | 受注確認内容設定画面で設定した値（設定可能な項目のみ） | | 有効フラグ | `confirm_valid_flag` | 数値型 | 1:有効 1以外:無効 | | 削除フラグ | `confirm_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `confirm_creation_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `confirm_creator_id` | 数値型 | | | 作成担当者名 | `confirm_creator_name` | 文字列型 | | | 最終更新者ID | `confirm_last_modified_by_id` | 数値型 | | | 最終更新者ID | `confirm_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `confirm_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `confirm_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=xxx' \ https://api.next-engine.org/api_v1_receiveorder_confirm/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "confirm_id": "AA", "confirm_name": "商品コードが商品マスタに存在しません。", "confirm_display_order": "1", "confirm_html": "商品コードが商品マスタに存在しない場合、確認内容に表示します。", "confirm_value": null, "confirm_valid_flag": "0", "confirm_deleted_flag": "0", "confirm_creation_date": "2007-02-28 00:00:00", "confirm_last_modified_date": "0000-00-00 00:00:00", "confirm_last_modified_null_safe_date": "0000-00-00 00:00:00", "confirm_creator_id": "9978", "confirm_creator_name": null, "confirm_last_modified_by_id": "0", "confirm_last_modified_by_null_safe_id": "0", "confirm_last_modified_by_name": "System", "confirm_last_modified_by_null_safe_name": "System" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_confirm_search/`](/api/operations/api_v1_receiveorder_confirm_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_confirm/`](/guides/fields/receiveorder_confirm/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注確認内容) - [受注確認内容件数取得](/api/api_v1_receiveorder_confirm/count/) — `POST /api_v1_receiveorder_confirm/count` - [受注確認内容更新](/api/api_v1_receiveorder_confirm/update/) — `POST /api_v1_receiveorder_confirm/update` --- # 受注確認内容更新 URL: https://developer.next-engine.com/api/api_v1_receiveorder_confirm/update/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_confirm/update Tag: 受注確認内容 Required parameters: access_token, confirm_id, confirm_value, confirm_last_modified_date Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_confirm/update` ## リファレンス内容 ### 受注確認内容更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 本機能では、受注確認内容更新の設定値を更新する事のみ可能です（店舗ごとに受注確認内容が有効/無効か設定することは出来ません。）。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `confirm_id` | 受注確認内容ID | 必須 | 更新する受注確認内容のconfirm_id。設定値が有効(confirm_valid_flagが'1')の受注確認内容のみ指定可能です | | `confirm_value` | 設定値 | 必須 | 更新する受注確認内容のconfirm_value。値を空に更新することは出来ません | | `confirm_last_modified_date` | 最終更新日 | 必須 | 更新する店舗のconfirm_last_modified_date API実行時にメイン機能またはアプリで、受注確認内容が更新されていないかを確認するために利用します メイン機能またはアプリで受注確認内容が更新されている場合はエラーになります エラーになったら再度、受注確認内容を検索してAPIを実行して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&confirm_id=xxx&confirm_value=xxx&confirm_last_modified_date=xxx' \ https://api.next-engine.org/api_v1_receiveorder_confirm/update ``` レスポンス ```json { "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 | エラーコード | メッセージ | 対処方法 | |---|---|---| | `017001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります | | `017002` | POSTパラメータにconfirm_idが指定されていない、または値が空です。 | confirm_idを指定してください | | `017003` | POSTパラメータにconfirm_valueが指定されていない、または値が空です。 | confirm_valueを指定してください | | `017004` | POSTパラメータにconfirm_last_modified_dateが指定されていません。 | confirm_last_modified_dateを指定してください | | `017005` | 受注確認内容ID[_xx_]は、メイン機能に登録されていない値です。 | 受注確認内容IDを確認してください | | `017006` | 受注確認内容ID[_xx_]は、設定値が設定出来ない受注確認内容です。 | 設定可能な確認内容IDを指定してください | | `017007` | confirm_last_modified_dateが更新されています。再度受注確認内容を検索してAPIを実行して下さい。 | 確認内容を再検索して最新の日時を取得してください | ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_confirm_update/`](/api/operations/api_v1_receiveorder_confirm_update/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_confirm/`](/guides/fields/receiveorder_confirm/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注確認内容) - [受注確認内容件数取得](/api/api_v1_receiveorder_confirm/count/) — `POST /api_v1_receiveorder_confirm/count` - [受注確認内容検索](/api/api_v1_receiveorder_confirm/search/) — `POST /api_v1_receiveorder_confirm/search` --- # 発送方法別区分件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_forwardingagent/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_forwardingagent/count Tag: 発送方法別区分 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_forwardingagent/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 発送方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発送方法区分 | `forwarding_agent_id` | 文字列型 | 発送方法区分のdelivery_idと紐付きます | | 発送方法別項目タイプ | `forwarding_agent_type` | 文字列型 | 値は次の通り。binsyu_kbn:便種、eigyosyo_dome_kbn:営業所止め、jikantaisitei_kbn:時間帯、okurijyo_kbn:送り状、ondo_kbn:温度帯、seal1_kbn:シール1、seal2_kbn:シール2、seal3_kbn:シール3、seal4_kbn:シール4 | | 発送方法別項目区分 | `forwarding_agent_type_id` | 文字列型 | 各項目の区分値 | | 発送方法別項目名 | `forwarding_agent_type_name` | 文字列型 | 各項目の名称 | | 表示順序 | `forwarding_agent_display_order` | 数値型 | | | 削除フラグ | `forwarding_agent_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_forwardingagent/count ``` レスポンス ```json { "result": "success", "count": "396", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_forwardingagent_count/`](/api/operations/api_v1_receiveorder_forwardingagent_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_forwardingagent/`](/guides/fields/receiveorder_forwardingagent/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (発送方法別区分) - [発送方法別区分検索](/api/api_v1_receiveorder_forwardingagent/search/) — `POST /api_v1_receiveorder_forwardingagent/search` --- # 発送方法別区分検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_forwardingagent/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_forwardingagent/search Tag: 発送方法別区分 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_forwardingagent/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 発送方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発送方法区分 | `forwarding_agent_id` | 文字列型 | 発送方法区分のdelivery_idと紐付きます | | 発送方法別項目タイプ | `forwarding_agent_type` | 文字列型 | 値は次の通り。binsyu_kbn:便種、eigyosyo_dome_kbn:営業所止め、jikantaisitei_kbn:時間帯、okurijyo_kbn:送り状、ondo_kbn:温度帯、seal1_kbn:シール1、seal2_kbn:シール2、seal3_kbn:シール3、seal4_kbn:シール4 | | 発送方法別項目区分 | `forwarding_agent_type_id` | 文字列型 | 各項目の区分値 | | 発送方法別項目名 | `forwarding_agent_type_name` | 文字列型 | 各項目の名称 | | 表示順序 | `forwarding_agent_display_order` | 数値型 | | | 削除フラグ | `forwarding_agent_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=xxx&forwarding_agent_id-eq=xxx' \ https://api.next-engine.org/api_v1_receiveorder_forwardingagent/search ``` レスポンス ```json { "result": "success", "count": "107", "data": [ { "forwarding_agent_id": "10", "forwarding_agent_type": "binsyu_kbn", "forwarding_agent_type_id": "001", "forwarding_agent_type_name": "飛脚宅配便", "forwarding_agent_display_order": "0", "forwarding_agent_deleted_flag": "0" }, { "forwarding_agent_id": "10", "forwarding_agent_type": "binsyu_kbn", "forwarding_agent_type_id": "001_o", "forwarding_agent_type_name": "陸便", "forwarding_agent_display_order": "0", "forwarding_agent_deleted_flag": "1" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_forwardingagent_search/`](/api/operations/api_v1_receiveorder_forwardingagent_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_forwardingagent/`](/guides/fields/receiveorder_forwardingagent/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (発送方法別区分) - [発送方法別区分件数取得](/api/api_v1_receiveorder_forwardingagent/count/) — `POST /api_v1_receiveorder_forwardingagent/count` --- # 受注分類タグ検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_groupingtag/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_groupingtag/search Tag: 受注分類タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_groupingtag/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注分類タグID | `grouping_tag_id` | 数値型 | | | 受注分類タグ名 | `grouping_tag_name` | 文字列型 | | | 受注分類タグの背景色 | `grouping_tag_color` | 文字列型 | | | 受注分類タグの文字色 | `grouping_tag_str_color` | 文字列型 | | | 受注分類タグのメモ欄 | `grouping_tag_memo` | 文字列型 | | | 作成日 | `grouping_tag_creation_date` | 日付型 | | | 最終更新日 | `grouping_tag_last_modified_date` | 日付型 | | | 最終更新日 | `grouping_tag_last_modified_null_safe_date` | 日付型 | NULLの場合作成日 | | 作成担当者ID | `grouping_tag_creator_id` | 数値型 | | | 作成担当者名 | `grouping_tag_creator_name` | 文字列型 | | | 最終更新者ID | `grouping_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `grouping_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `grouping_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `grouping_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=grouping_tag_id, grouping_tag_name, grouping_tag_color&grouping_tag_id-eq=xxx' https://api.next-engine.org/api_v1_receiveorder_groupingtag/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "grouping_tag_id": "1", "grouping_tag_name": "1", "grouping_tag_color": "gray" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_groupingtag_search/`](/api/operations/api_v1_receiveorder_groupingtag_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) --- # 受注伝票オプション件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_option/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_option/count Tag: 受注伝票オプション Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_option/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_option_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | | 受注時店舗原資クーポン | `receive_order_option_received_time_shop_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 受注時モール原資クーポン | `receive_order_option_received_time_mall_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 作成日 | `receive_order_option_creation_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `receive_order_option_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_option_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_option_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_option_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_option_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_option_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_option_receive_order_id-eq=xxx' \ https://api.next-engine.org/api_v1_receiveorder_option/count ``` レスポンス ```json { "result": "success", "count": "1", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_option_count/`](/api/operations/api_v1_receiveorder_option_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_option/`](/guides/fields/receiveorder_option/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票オプション) - [受注伝票オプション検索](/api/api_v1_receiveorder_option/search/) — `POST /api_v1_receiveorder_option/search` --- # 受注伝票オプション検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_option/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_option/search Tag: 受注伝票オプション Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_option/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_option_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | | 受注時店舗原資クーポン | `receive_order_option_received_time_shop_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 受注時モール原資クーポン | `receive_order_option_received_time_mall_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 作成日 | `receive_order_option_creation_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `receive_order_option_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_option_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_option_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_option_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_option_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_option_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx8&wait_flag=1&fields=xxx&receive_order_option_receive_order_id-eq=xxx&offset=0&limit=10' \ https://api.next-engine.org/api_v1_receiveorder_option/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "receive_order_option_receive_order_id": "1", "receive_order_option_single_word_memo": "", "receive_order_option_message": "", "receive_order_option_noshi": "", "receive_order_option_rapping": "", "receive_order_option_1": "", "receive_order_option_2": "", "receive_order_option_3": "", "receive_order_option_4": "", "receive_order_option_5": "", "receive_order_option_6": "", "receive_order_option_7": "", "receive_order_option_8": "", "receive_order_option_9": "", "receive_order_option_10": "", "receive_order_option_received_time_shop_coupon": "0.00", "receive_order_option_received_time_mall_coupon": "0.00", "receive_order_option_deleted_flag": "0", "receive_order_option_creation_date": "2017-01-19 12:55:38", "receive_order_option_last_modified_date": "2017-04-14 16:24:36", "receive_order_option_last_modified_null_safe_date": "2017-04-14 16:24:36", "receive_order_option_creator_id": "10002", "receive_order_option_creator_name": "xxx", "receive_order_option_last_modified_by_id": "10003", "receive_order_option_last_modified_by_null_safe_id": "10003", "receive_order_option_last_modified_by_name": "xxx", "receive_order_option_last_modified_by_null_safe_name": "xxx" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_option_search/`](/api/operations/api_v1_receiveorder_option_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_option/`](/guides/fields/receiveorder_option/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注伝票オプション) - [受注伝票オプション件数取得](/api/api_v1_receiveorder_option/count/) — `POST /api_v1_receiveorder_option/count` --- # 支払発送変換件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_paymentdeliveryconvert/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_paymentdeliveryconvert/count Tag: 支払い発送変換 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_paymentdeliveryconvert/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 支払発送変換 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 変換元テキスト | `payment_delivery_convert_text` | 文字列型 | CSV(API)などメイン機能に取り込む前の受注情報のテキスト | | 項目種類 | `payment_delivery_convert_type` | 文字列型 | 本項目の値と対応するオブジェクトは次の通り。 "siharai_kbn":支払区分 "hasou_kbn"：発送方法区分 "credit_kbn"：クレジット種類区分 "nyukin_kbn":入金区分 "jikantaisitei_kbn":発送方法区分の発送方法別項目タイプが"jikantaisitei_kbn" | | 各種ID | `payment_delivery_convert_multi_id` | 文字列型 | 項目種類で指定されたオブジェクトのID | | 発送方法区分 | `payment_delivery_convert_delivery_id` | 文字列型 | 項目種類が"jikantaisitei_kbn"の時のみ値がある | | 削除フラグ | `payment_delivery_convert_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `payment_delivery_convert_creation_date` | 日付型 | | | 最終更新日 | `payment_delivery_convert_last_modified_date` | 日付型 | | | 作成担当者ID | `payment_delivery_convert_creator_id` | 数値型 | | | 作成担当者名 | `payment_delivery_convert_creator_name` | 文字列型 | | | 最終更新者ID | `payment_delivery_convert_last_modified_by_id` | 数値型 | | | 最終更新者名 | `payment_delivery_convert_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&payment_delivery_convert_text-eq=xxx' \ https://api.next-engine.org/api_v1_receiveorder_paymentdeliveryconvert/count ``` レスポンス ```json { "result": "success", "count": "xxx", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_paymentdeliveryconvert_count/`](/api/operations/api_v1_receiveorder_paymentdeliveryconvert_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (支払い発送変換) - [支払発送変換検索](/api/api_v1_receiveorder_paymentdeliveryconvert/search/) — `POST /api_v1_receiveorder_paymentdeliveryconvert/search` --- # 支払発送変換検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_paymentdeliveryconvert/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_paymentdeliveryconvert/search Tag: 支払い発送変換 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_paymentdeliveryconvert/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 支払発送変換 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 変換元テキスト | `payment_delivery_convert_text` | 文字列型 | CSV(API)などメイン機能に取り込む前の受注情報のテキスト | | 項目種類 | `payment_delivery_convert_type` | 文字列型 | 本項目の値と対応するオブジェクトは次の通り。 "siharai_kbn":支払区分 "hasou_kbn"：発送方法区分 "credit_kbn"：クレジット種類区分 "nyukin_kbn":入金区分 "jikantaisitei_kbn":発送方法区分の発送方法別項目タイプが"jikantaisitei_kbn" | | 各種ID | `payment_delivery_convert_multi_id` | 文字列型 | 項目種類で指定されたオブジェクトのID | | 発送方法区分 | `payment_delivery_convert_delivery_id` | 文字列型 | 項目種類が"jikantaisitei_kbn"の時のみ値がある | | 削除フラグ | `payment_delivery_convert_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `payment_delivery_convert_creation_date` | 日付型 | | | 最終更新日 | `payment_delivery_convert_last_modified_date` | 日付型 | | | 作成担当者ID | `payment_delivery_convert_creator_id` | 数値型 | | | 作成担当者名 | `payment_delivery_convert_creator_name` | 文字列型 | | | 最終更新者ID | `payment_delivery_convert_last_modified_by_id` | 数値型 | | | 最終更新者名 | `payment_delivery_convert_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=payment_delivery_convert_text,payment_delivery_convert_type,payment_delivery_convert_multi_id&payment_delivery_convert_text-eq=xxx' \ https://api.next-engine.org/api_v1_receiveorder_paymentdeliveryconvert/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "payment_delivery_convert_text": "xxx", "payment_delivery_convert_type": "siharai_kbn", "payment_delivery_convert_multi_id": "0", "payment_delivery_convert_delivery_id": null, "payment_delivery_convert_deleted_flag": "0", "payment_delivery_convert_creation_date": "2006-12-25 00:00:00", "payment_delivery_convert_last_modified_date": "2017-02-21 14:05:38", "payment_delivery_convert_creator_id": "9978", "payment_delivery_convert_creator_name": null, "payment_delivery_convert_last_modified_by_id": "10008", "payment_delivery_convert_last_modified_by_name": "xxx" }, { "payment_delivery_convert_text": "xxx", "payment_delivery_convert_type": "credit_kbn", "payment_delivery_convert_multi_id": "1", "payment_delivery_convert_delivery_id": null, "payment_delivery_convert_deleted_flag": "0", "payment_delivery_convert_creation_date": "2006-12-30 00:00:00", "payment_delivery_convert_last_modified_date": "2017-02-21 14:05:40", "payment_delivery_convert_creator_id": "9978", "payment_delivery_convert_creator_name": null, "payment_delivery_convert_last_modified_by_id": "10008", "payment_delivery_convert_last_modified_by_name": "xxx" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_paymentdeliveryconvert_search/`](/api/operations/api_v1_receiveorder_paymentdeliveryconvert_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (支払い発送変換) - [支払発送変換件数取得](/api/api_v1_receiveorder_paymentdeliveryconvert/count/) — `POST /api_v1_receiveorder_paymentdeliveryconvert/count` --- # 受注明細件数取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_row/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_row/count Tag: 受注明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_row/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 受注明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_row_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 受注番号 | `receive_order_row_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） | | 明細行番号 | `receive_order_row_no` | 数値型 | ネクストエンジンで付与した明細行番号 | | 受注明細行番号 | `receive_order_row_shop_row_no` | 文字列型 | 店舗で付与された明細行番号 | | 商品コード | `receive_order_row_goods_id` | 文字列型 | | | 商品名 | `receive_order_row_goods_name` | 文字列型 | | | 受注数 | `receive_order_row_quantity` | 数値型 | | | 単価 | `receive_order_row_unit_price` | 数値型 | | | 受注時原価 | `receive_order_row_received_time_first_cost` | 数値型 | 受注時の商品マスタの原価。 | | 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | 小計金額 | `receive_order_row_sub_total_price` | 数値型 | 単価*(掛率/10)*受注数 | | 商品OP | `receive_order_row_goods_option` | 文字列型 | | | キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 同梱元伝票番号 | `receive_order_include_from_order_id` | 数値型 | | | 同梱元明細行番号 | `receive_order_include_from_row_no` | 数値型 | | | 複数配送親伝票番号 | `receive_order_row_multi_delivery_parent_order_id` | 数値型 | | | 分割元明細行番号 | `receive_order_row_divide_from_row_no` | 数値型 | | | 複写元明細行番号 | `receive_order_row_copy_from_row_no` | 数値型 | | | 引当数 | `receive_order_row_stock_allocation_quantity` | 数値型 | | | 予約引当数 | `receive_order_row_advance_order_stock_allocation_quantity` | 数値型 | | | 引当日 | `receive_order_row_stock_allocation_date` | 日時型 | | | 受注時取扱区分 | `receive_order_row_received_time_merchandise_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時取扱名 | `receive_order_row_received_time_merchandise_name` | 文字列型 | | | 受注時商品区分 | `receive_order_row_received_time_goods_type_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時商品名 | `receive_order_row_received_time_goods_type_name` | 文字列型 | | | 良品返品数 | `receive_order_row_returned_good_quantity` | 数値型 | | | 不良品返品数 | `receive_order_row_returned_bad_quantity` | 数値型 | | | 返品事由区分 | `receive_order_row_returned_reason_id` | 文字列型 | | | 返品事由名 | `receive_order_row_returned_reason_name` | 文字列型 | | | 元受注明細行番号 | `receive_order_row_org_row_no` | 数値型 | | | 削除フラグ | `receive_order_row_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `receive_order_row_creation_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 受注伝票・受注明細の最終更新日 | `receive_order_row_last_modified_newest_date` | 日時型 | 受注伝票と受注明細の内、より新しい方の最終更新日 | | 作成担当者ID | `receive_order_row_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 拠点 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 拠点名 | `warehouse_name` | 文字列型 | | | 作成日 | `warehouse_creation_date` | 日時型 | 拠点の作成日 | | 最終更新日 | `warehouse_last_modified_date` | 日時型 | 拠点マスタの最終更新日 | | 作成担当者ID | `warehouse_creator_id` | 数値型 | 拠点の作成担当者ID | | 作成担当者名 | `warehouse_creator_name` | 文字列型 | 拠点の作成担当者名 | | 最終更新者ID | `warehouse_last_modified_by_id` | 数値型 | 拠点マスタの最終更新者ID | | 最終更新者名 | `warehouse_last_modified_by_name` | 文字列型 | 拠点マスタの最終更新者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_row_receive_order_id-eq=1' \ https://api.next-engine.org/api_v1_receiveorder_row/count ``` レスポンス ```json { "result": "success", "count": "3", "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_row_count/`](/api/operations/api_v1_receiveorder_row_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_row/`](/guides/fields/receiveorder_row/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注明細) - [受注明細検索](/api/api_v1_receiveorder_row/search/) — `POST /api_v1_receiveorder_row/search` --- # 受注明細検索 URL: https://developer.next-engine.com/api/api_v1_receiveorder_row/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_row/search Tag: 受注明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_row/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_row_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 受注番号 | `receive_order_row_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） | | 明細行番号 | `receive_order_row_no` | 数値型 | ネクストエンジンで付与した明細行番号 | | 受注明細行番号 | `receive_order_row_shop_row_no` | 文字列型 | 店舗で付与された明細行番号 | | 商品コード | `receive_order_row_goods_id` | 文字列型 | | | 商品名 | `receive_order_row_goods_name` | 文字列型 | | | 受注数 | `receive_order_row_quantity` | 数値型 | | | 単価 | `receive_order_row_unit_price` | 数値型 | | | 受注時原価 | `receive_order_row_received_time_first_cost` | 数値型 | 受注時の商品マスタの原価。 | | 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | 小計金額 | `receive_order_row_sub_total_price` | 数値型 | 単価*(掛率/10)*受注数 | | 商品OP | `receive_order_row_goods_option` | 文字列型 | | | キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 同梱元伝票番号 | `receive_order_include_from_order_id` | 数値型 | | | 同梱元明細行番号 | `receive_order_include_from_row_no` | 数値型 | | | 複数配送親伝票番号 | `receive_order_row_multi_delivery_parent_order_id` | 数値型 | | | 分割元明細行番号 | `receive_order_row_divide_from_row_no` | 数値型 | | | 複写元明細行番号 | `receive_order_row_copy_from_row_no` | 数値型 | | | 引当数 | `receive_order_row_stock_allocation_quantity` | 数値型 | | | 予約引当数 | `receive_order_row_advance_order_stock_allocation_quantity` | 数値型 | | | 引当日 | `receive_order_row_stock_allocation_date` | 日時型 | | | 受注時取扱区分 | `receive_order_row_received_time_merchandise_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時取扱名 | `receive_order_row_received_time_merchandise_name` | 文字列型 | | | 受注時商品区分 | `receive_order_row_received_time_goods_type_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時商品名 | `receive_order_row_received_time_goods_type_name` | 文字列型 | | | 良品返品数 | `receive_order_row_returned_good_quantity` | 数値型 | | | 不良品返品数 | `receive_order_row_returned_bad_quantity` | 数値型 | | | 返品事由区分 | `receive_order_row_returned_reason_id` | 文字列型 | | | 返品事由名 | `receive_order_row_returned_reason_name` | 文字列型 | | | 元受注明細行番号 | `receive_order_row_org_row_no` | 数値型 | | | 削除フラグ | `receive_order_row_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `receive_order_row_creation_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 受注伝票・受注明細の最終更新日 | `receive_order_row_last_modified_newest_date` | 日時型 | 受注伝票と受注明細の内、より新しい方の最終更新日 | | 作成担当者ID | `receive_order_row_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | ### 拠点 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 拠点名 | `warehouse_name` | 文字列型 | | | 作成日 | `warehouse_creation_date` | 日時型 | 拠点の作成日 | | 最終更新日 | `warehouse_last_modified_date` | 日時型 | 拠点マスタの最終更新日 | | 作成担当者ID | `warehouse_creator_id` | 数値型 | 拠点の作成担当者ID | | 作成担当者名 | `warehouse_creator_name` | 文字列型 | 拠点の作成担当者名 | | 最終更新者ID | `warehouse_last_modified_by_id` | 数値型 | 拠点マスタの最終更新者ID | | 最終更新者名 | `warehouse_last_modified_by_name` | 文字列型 | 拠点マスタの最終更新者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=xxx&receive_order_row_receive_order_id-eq=1' \ https://api.next-engine.org/api_v1_receiveorder_row/search ``` レスポンス ```json { [ { "receive_order_row_receive_order_id": "1", "receive_order_row_shop_cut_form_id": "xxx", "receive_order_row_no": "1", "receive_order_row_shop_row_no": "93656155", "receive_order_row_goods_id": "TEST-804575", "receive_order_row_goods_name": "テスト商品", "receive_order_row_quantity": "0", "receive_order_row_unit_price": "5650.00", "receive_order_row_received_time_first_cost": "0.00", "receive_order_row_wholesale_retail_ratio": "10.0", "receive_order_row_sub_total_price": "0.00", "receive_order_row_goods_option": null, "receive_order_row_cancel_flag": "0", "receive_order_include_from_order_id": null, "receive_order_include_from_row_no": null, "receive_order_row_multi_delivery_parent_order_id": null, "receive_order_row_divide_from_row_no": null, "receive_order_row_copy_from_row_no": null, "receive_order_row_stock_allocation_quantity": "0", "receive_order_row_advance_order_stock_allocation_quantity": "0", "receive_order_row_stock_allocation_date": null, "receive_order_row_received_time_merchandise_id": null, "receive_order_row_received_time_merchandise_name": null, "receive_order_row_received_time_goods_type_id": null, "receive_order_row_received_time_goods_type_name": null, "receive_order_row_returned_good_quantity": "0", "receive_order_row_returned_bad_quantity": "0", "receive_order_row_returned_reason_id": null, "receive_order_row_returned_reason_name": null, "receive_order_row_org_row_no": null, "receive_order_row_deleted_flag": "0", "receive_order_row_creation_date": "2017-01-19 12:55:38", "receive_order_row_last_modified_date": "2017-03-22 16:19:16", "receive_order_row_last_modified_null_safe_date": "2017-03-22 16:19:16", "receive_order_row_last_modified_newest_date": "2017-04-14 16:24:36", "receive_order_row_creator_id": "10002", "receive_order_row_creator_name": "xxx", "receive_order_row_last_modified_by_id": "9999", "receive_order_row_last_modified_by_null_safe_id": "9999", "receive_order_row_last_modified_by_name": "管理者", "receive_order_row_last_modified_by_null_safe_name": "管理者" }, { "receive_order_row_receive_order_id": "1", "receive_order_row_shop_cut_form_id": "xxx", "receive_order_row_no": "2", "receive_order_row_shop_row_no": "93816145", "receive_order_row_goods_id": "TEST-504893", "receive_order_row_goods_name": "テスト商品2", "receive_order_row_quantity": "1", "receive_order_row_unit_price": "1000.00", "receive_order_row_received_time_first_cost": "0.00", "receive_order_row_wholesale_retail_ratio": "10.0", "receive_order_row_sub_total_price": "1000.00", "receive_order_row_goods_option": null, "receive_order_row_cancel_flag": "1", "receive_order_include_from_order_id": "2", "receive_order_include_from_row_no": "1", "receive_order_row_multi_delivery_parent_order_id": null, "receive_order_row_divide_from_row_no": null, "receive_order_row_copy_from_row_no": null, "receive_order_row_stock_allocation_quantity": "0", "receive_order_row_advance_order_stock_allocation_quantity": "0", "receive_order_row_stock_allocation_date": null, "receive_order_row_received_time_merchandise_id": null, "receive_order_row_received_time_merchandise_name": null, "receive_order_row_received_time_goods_type_id": null, "receive_order_row_received_time_goods_type_name": null, "receive_order_row_returned_good_quantity": "0", "receive_order_row_returned_bad_quantity": "0", "receive_order_row_returned_reason_id": null, "receive_order_row_returned_reason_name": null, "receive_order_row_org_row_no": null, "receive_order_row_deleted_flag": "0", "receive_order_row_creation_date": "2017-02-09 18:26:03", "receive_order_row_last_modified_date": "2017-03-22 16:19:16", "receive_order_row_last_modified_null_safe_date": "2017-03-22 16:19:16", "receive_order_row_last_modified_newest_date": "2017-04-14 16:24:36", "receive_order_row_creator_id": "10003", "receive_order_row_creator_name": "xxx", "receive_order_row_last_modified_by_id": "9999", "receive_order_row_last_modified_by_null_safe_id": "9999", "receive_order_row_last_modified_by_name": "管理者", "receive_order_row_last_modified_by_null_safe_name": "管理者" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_row_search/`](/api/operations/api_v1_receiveorder_row_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/receiveorder_row/`](/guides/fields/receiveorder_row/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (受注明細) - [受注明細件数取得](/api/api_v1_receiveorder_row/count/) — `POST /api_v1_receiveorder_row/count` --- # 受注税金内訳取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_tax_account/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_tax_account/search Tag: 受注税金内訳 Required parameters: access_token, receive_order_ids Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_tax_account/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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_ids` | 検索対象にする受注伝票の伝票番号（カンマ区切りで複数可） | 必須 | 最大1000件まで指定可能です | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 受注税金内訳 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 請求金額（0%） | `receive_order_request_amount_tax0` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（8%） | `receive_order_request_amount_tax8` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（10%） | `receive_order_request_amount_tax10` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求額に対する税額（8%） | `receive_order_request_amount_tax_tax8` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 請求額に対する税額（10%） | `receive_order_request_amount_tax_tax10` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 手数料（0%） | `receive_order_charge_amount_tax0` | 数値型 | | | 手数料（8%） | `receive_order_charge_amount_tax8` | 数値型 | | | 手数料（10%） | `receive_order_charge_amount_tax10` | 数値型 | | | 他費用（0%） | `receive_order_other_amount_tax0` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（8%） | `receive_order_other_amount_tax8` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（10%） | `receive_order_other_amount_tax10` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 按分済みクーポン割引額（0%） | `receive_order_distributed_coupon_amount_tax0` | 数値型 | （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください） 受注伝票の「他費用」の値引金額（税率毎） | | 按分済みクーポン割引額（8%） | `receive_order_distributed_coupon_amount_tax8` | 数値型 | （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください） 受注伝票の「他費用」の値引金額（税率毎） | | 按分済みクーポン割引額（10%） | `receive_order_distributed_coupon_amount_tax10` | 数値型 | （「クーポン割引額（按分）」を対象税率毎に按分済みのクーポン割引額です。請求書の出力等に利用してください） 受注伝票の「他費用」のうち、値引の金額（税率毎） | | クーポン割引額（0%） | `receive_order_coupon_amount_tax0` | 数値型 | 受注伝票の「他費用」のうち、値引の金額（税率毎） | | クーポン割引額（8%） | `receive_order_coupon_amount_tax8` | 数値型 | 受注伝票の「他費用」のうち、値引の金額（税率毎） | | クーポン割引額（10%） | `receive_order_coupon_amount_tax10` | 数値型 | 受注伝票の「他費用」のうち、値引の金額（税率毎） | | クーポン割引額（按分） | `receive_order_coupon_amount_distribute` | 数値型 | 受注伝票の「他費用」のうち、値引の金額（按分されるクーポン割引額） | | 按分済みポイント（0%） | `receive_order_distributed_point_amount_tax0` | 数値型 | (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください） ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | 按分済みポイント（8%） | `receive_order_distributed_point_amount_tax8` | 数値型 | (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください） ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | 按分済みポイント（10%） | `receive_order_distributed_point_amount_tax10` | 数値型 | (「ポイント（按分）」を対象税率毎に按分済みのポイントです。請求書の出力等に利用してください） ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（0%） | `receive_order_point_amount_tax0` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（8%） | `receive_order_point_amount_tax8` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（10%） | `receive_order_point_amount_tax10` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（按分） | `receive_order_point_amount_distribute` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント） | | ポイント（支払い） | `receive_order_point_amount_payment` | 数値型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_ids=10001,10002' https://api.next-engine.org/api_v1_receiveorder_tax_account/search ``` レスポンス ```json { "result": "success", "count": 2, "data": [ { "receive_order_id": 10001, "receive_order_request_amount_tax0": 0, "receive_order_request_amount_tax8": 0, "receive_order_request_amount_tax10": 11000, "receive_order_request_amount_tax_tax8": 0, "receive_order_request_amount_tax_tax10": 1000, "receive_order_charge_amount_tax0": 0, "receive_order_charge_amount_tax8": 0, "receive_order_charge_amount_tax10": 220, "receive_order_other_amount_tax0": 0, "receive_order_other_amount_tax8": 0, "receive_order_other_amount_tax10": 440, "receive_order_distributed_coupon_amount_tax0": 0, "receive_order_distributed_coupon_amount_tax8": 0, "receive_order_distributed_coupon_amount_tax10": 990, "receive_order_coupon_amount_tax0": 0, "receive_order_coupon_amount_tax8": 0, "receive_order_coupon_amount_tax10": 550, "receive_order_coupon_amount_distribute": 440, "receive_order_distributed_point_amount_tax0": 0, "receive_order_distributed_point_amount_tax8": 0, "receive_order_distributed_point_amount_tax10": 330, "receive_order_point_amount_tax0": 0, "receive_order_point_amount_tax8": 0, "receive_order_point_amount_tax10": 220, "receive_order_point_amount_distribute": 110, "receive_order_point_amount_payment": 1000 }, { "receive_order_id": 10002, "receive_order_request_amount_tax0": 100000, "receive_order_request_amount_tax8": 108000, "receive_order_request_amount_tax10": 110000, "receive_order_request_amount_tax_tax8": 8000, "receive_order_request_amount_tax_tax10": 10000, "receive_order_charge_amount_tax0": 1400, "receive_order_charge_amount_tax8": 1300, "receive_order_charge_amount_tax10": 1200, "receive_order_other_amount_tax0": 1100, "receive_order_other_amount_tax8": 1000, "receive_order_other_amount_tax10": 900, "receive_order_distributed_coupon_amount_tax0": 957, "receive_order_distributed_coupon_amount_tax8": 869, "receive_order_distributed_coupon_amount_tax10": 774, "receive_order_coupon_amount_tax0": 800, "receive_order_coupon_amount_tax8": 700, "receive_order_coupon_amount_tax10": 600, "receive_order_coupon_amount_distribute": 500, "receive_order_distributed_point_amount_tax0": 431, "receive_order_distributed_point_amount_tax8": 333, "receive_order_distributed_point_amount_tax10": 236, "receive_order_point_amount_tax0": 400, "receive_order_point_amount_tax8": 300, "receive_order_point_amount_tax10": 200, "receive_order_point_amount_distribute": 100, "receive_order_point_amount_payment": 1000 }, ], "access_token": "xxx", "access_token_end_date": "2023-09-21 09:01:00", "refresh_token": "xxx", "refresh_token_end_date": "2023-09-23 09:01:00" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_tax_account_search/`](/api/operations/api_v1_receiveorder_tax_account_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) --- # 受注一括登録パターン情報取得 URL: https://developer.next-engine.com/api/api_v1_receiveorder_uploadpattern/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_receiveorder_uploadpattern/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_receiveorder_uploadpattern/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 受注一括登録パターン | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注一括登録パターンID | `receive_order_upload_pattern_id` | 数値型 | | | 受注一括登録パターン名 | `receive_order_upload_pattern_name` | 文字列型 | | | 受注一括登録フォーマットパターンID | `receive_order_upload_pattern_format_id` | 数値型 | 参考資料：受注一括登録フォーマットパターンのIDと名称参照 | | 店舗ID | `receive_order_upload_pattern_shop_id` | 数値型 | | | 削除フラグ | `receive_order_upload_pattern_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `receive_order_upload_pattern_creation_date` | 日付型 | | | 最終更新日 | `receive_order_upload_pattern_last_modified_date` | 日付型 | | | 作成担当者ID | `receive_order_upload_pattern_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_upload_pattern_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_upload_pattern_last_modified_by_id` | 数値型 | | | 最終更新者名 | `receive_order_upload_pattern_last_modified_by_name` | 文字列型 | | ### 参考資料：受注一括登録フォーマットパターンのID・名称 | 受注一括登録フォーマットパターンID | 受注一括登録フォーマットパターン名 | | --- | --- | | 15 | Yahooオークション標準パターン | | 40 | DeNA BtoB market標準パターン | | 48 | ebay標準パターン | | 50 | 楽天全カラムDLパターン | | 90 | 汎用標準パターン | | 9001 | たまごリピートパターン | | 10001 | 楽天ペイ全カラムDLパターン | | 10003 | DeNAショッピングパターン | | 100011 | アマゾンパターン | | 100013 | おちゃのこネット（オーダーメイド対応）パターン | | 100014 | ショップサーブパターン | | 100019 | FutureShop2 パターン | | 100022 | Color Me Shop! Pro 2009-12 | | 100023 | `superdelivery` | | 100025 | マーキュリー備考欄ラッピング追加パターン | | 100026 | ワイズカートASP/ZERO | | 100034 | ヤマダモール（楽天互換形式 安定版）パターン | | 100035 | MakeShopパターン | | 100042 | ポンパレパターン | | 100043 | アマゾン海外パターン | | 100045 | LINE MALLパターン | | 200002 | YAHOOショッピング（ストアクリエイターPro）パターン | | 1000302 | Wow!manager全カラムDLパターン | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_uploadpattern/info ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "receive_order_upload_pattern_id": "2", "receive_order_upload_pattern_name": "Test01(楽天全カラムDLパターン)", "receive_order_upload_pattern_format_id": "50", "receive_order_upload_pattern_shop_id": "1", "receive_order_upload_pattern_deleted_flag": "0", "receive_order_upload_pattern_creation_date": "2016-12-19 18:04:03", "receive_order_upload_pattern_last_modified_date": "2016-12-19 18:04:03", "receive_order_upload_pattern_creator_id": "2", "receive_order_upload_pattern_creator_name": "ネクスト太郎", "receive_order_upload_pattern_last_modified_by_id": "2", "receive_order_upload_pattern_last_modified_by_name": "ネクスト太郎" }, { "receive_order_upload_pattern_id": "3", "receive_order_upload_pattern_name": "Test01(新楽天オークション)", "receive_order_upload_pattern_format_id": "43", "receive_order_upload_pattern_shop_id": "1", "receive_order_upload_pattern_deleted_flag": "0", "receive_order_upload_pattern_creation_date": "2016-12-19 18:04:03", "receive_order_upload_pattern_last_modified_date": "2016-12-19 18:04:03", "receive_order_upload_pattern_creator_id": "2", "receive_order_upload_pattern_creator_name": "ネクスト太郎", "receive_order_upload_pattern_last_modified_by_id": "2", "receive_order_upload_pattern_last_modified_by_name": "ネクスト太郎" } ], "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" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_receiveorder_uploadpattern_info/`](/api/operations/api_v1_receiveorder_uploadpattern_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 仕入伝票件数取得 URL: https://developer.next-engine.com/api/api_v1_supplyorder_base/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_supplyorder_base/count Tag: 仕入伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_supplyorder_base/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 仕入伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_id` | 数値型 | | | 仕入コード | `supply_order_supplier_id` | 文字列型 | | | 仕入伝票区分 | `supply_order_type_id` | 数値型 | | | 仕入伝票区分名 | `supply_order_type_name` | 文字列型 | | | 仕入日 | `supply_order_date` | 日時型 | | | 納品書番号 | `supply_order_delivery_id` | 文字列型 | | | 該当発注伝票番号 | `supply_order_correspond_order_id` | 数値型 | | | 仕入元伝票番号 | `supply_order_original_order_id` | 数値型 | | | 仕入金 | `supply_order_amount` | 数値型 | | | 仕入状態区分 | `supply_order_status_id` | 文字列型 | | | 仕入状態区分名 | `supply_order_status_name` | 文字列型 | | | 削除フラグ | `supply_order_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_creation_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&supply_order_last_modified_null_safe_date-gt=2018-01-23 13:53:52' https://api.next-engine.org/api_v1_supplyorder_base/count ``` レスポンス ```json { "result": "success" "count": "xxx", "access_token":"xxxxxxxxxx", "access_token_end_date":"2018-02-24 12:13:16", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2018-02-24 13:54:35" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_supplyorder_base_count/`](/api/operations/api_v1_supplyorder_base_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入伝票) - [仕入伝票検索](/api/api_v1_supplyorder_base/search/) — `POST /api_v1_supplyorder_base/search` --- # 仕入伝票検索 URL: https://developer.next-engine.com/api/api_v1_supplyorder_base/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_supplyorder_base/search Tag: 仕入伝票 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_supplyorder_base/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 仕入伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_id` | 数値型 | | | 仕入コード | `supply_order_supplier_id` | 文字列型 | | | 仕入伝票区分 | `supply_order_type_id` | 数値型 | | | 仕入伝票区分名 | `supply_order_type_name` | 文字列型 | | | 仕入日 | `supply_order_date` | 日時型 | | | 納品書番号 | `supply_order_delivery_id` | 文字列型 | | | 該当発注伝票番号 | `supply_order_correspond_order_id` | 数値型 | | | 仕入元伝票番号 | `supply_order_original_order_id` | 数値型 | | | 仕入金 | `supply_order_amount` | 数値型 | | | 仕入状態区分 | `supply_order_status_id` | 文字列型 | | | 仕入状態区分名 | `supply_order_status_name` | 文字列型 | | | 削除フラグ | `supply_order_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_creation_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&fields=supply_order_id,supply_order_supplier_id,supply_order_type_id,supply_order_type_name,supply_order_date,supply_order_delivery_id,supply_order_correspond_order_id,supply_order_original_order_id,supply_order_amount,supply_order_status_id,supply_order_status_name,supply_order_deleted_flag,supply_order_creation_date,supply_order_last_modified_date,supply_order_last_modified_null_safe_date,supply_order_creator_id,supply_order_creator_name,supply_order_last_modified_by_id,supply_order_last_modified_by_null_safe_id,supply_order_last_modified_by_name,supply_order_last_modified_by_null_safe_name&offset=0&limit=10&supply_order_last_modified_null_safe_date-gt=2018-01-23 13:53:52' https://api.next-engine.org/api_v1_supplyorder_base/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "supply_order_id": "1", "supply_order_supplier_id": "5555", "supply_order_type_id": "0", "supply_order_type_name": "通常仕入", "supply_order_date": "2018-02-23 13:51:57", "supply_order_delivery_id": "", "supply_order_correspond_order_id": "0", "supply_order_original_order_id": null, "supply_order_amount": "1050.00", "supply_order_status_id": "0", "supply_order_status_name": "条件未達成", "supply_order_deleted_flag": "0", "supply_order_creation_date": "2018-02-23 13:51:57", "supply_order_last_modified_date": "2018-02-23 13:51:57", "supply_order_last_modified_null_safe_date": "2018-02-23 13:51:57", "supply_order_creator_id": "10012", "supply_order_creator_name": "Le Hung", "supply_order_last_modified_by_id": "10012", "supply_order_last_modified_by_name": "Le Hung", "supply_order_last_modified_by_null_safe_name": "Le Hung" }, { "supply_order_id": "2", "supply_order_supplier_id": "5555", "supply_order_type_id": "0", "supply_order_type_name": "通常仕入", "supply_order_date": "2018-02-23 13:53:52", "supply_order_delivery_id": "", "supply_order_correspond_order_id": "0", "supply_order_original_order_id": null, "supply_order_amount": "350000.00", "supply_order_status_id": "0", "supply_order_status_name": "条件未達成", "supply_order_deleted_flag": "0", "supply_order_creation_date": "2018-02-23 13:53:52", "supply_order_last_modified_date": "2018-02-23 13:53:52", "supply_order_last_modified_null_safe_date": "2018-02-23 13:53:52", "supply_order_creator_id": "10012", "supply_order_creator_name": "Le Hung", "supply_order_last_modified_by_id": "10012", "supply_order_last_modified_by_name": "Le Hung", "supply_order_last_modified_by_null_safe_name": "Le Hung" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2018-02-24 12:13:16", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2018-02-26 12:13:16" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_supplyorder_base_search/`](/api/operations/api_v1_supplyorder_base_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入伝票) - [仕入伝票件数取得](/api/api_v1_supplyorder_base/count/) — `POST /api_v1_supplyorder_base/count` --- # 仕入明細件数取得 URL: https://developer.next-engine.com/api/api_v1_supplyorder_row/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_supplyorder_row/count Tag: 仕入明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_supplyorder_row/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 仕入明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_row_supply_order_id` | 数値型 | | | 仕入明細行 | `supply_order_row_no` | 数値型 | | | 商品コード | `supply_order_row_goods_id` | 文字列型 | | | 商品名 | `supply_order_row_goods_name` | 文字列型 | | | 商品オプション | `supply_order_row_goods_option` | 文字列型 | | | 余剰数 | `supply_order_row_surplus_quantity` | 数値型 | | | 仕入数 | `supply_order_row_quantity` | 数値型 | | | 仕入単価 | `supply_order_row_unit_price` | 数値型 | | | 小計金 | `supply_order_row_sub_total_price` | 数値型 | | | 発注伝票番号 | `supply_order_row_order_id` | 数値型 | | | 発注明細行 | `supply_order_row_order_row_no` | 数値型 | | | 受注伝票番号 | `supply_order_row_receive_order_id` | 数値型 | | | 受注明細行 | `supply_order_row_receive_order_row_no` | 数値型 | | | 仕入明細行区分 | `supply_order_row_status` | 文字列型 | 0:通常仕入, 95:不良品振替 | | 仕入完了状態 | `supply_order_row_completed_flag` | 文字列型 | 0:未完了,1:完了 | | 備考 | `supply_order_row_note` | 文字列型 | | | 削除フラグ | `supply_order_row_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_row_creation_date` | 日時型 | | | 最終更新日 | `supply_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_row_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | ### 仕入伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_id` | 数値型 | | | 仕入コード | `supply_order_supplier_id` | 文字列型 | | | 仕入伝票区分 | `supply_order_type_id` | 数値型 | | | 仕入伝票区分名 | `supply_order_type_name` | 文字列型 | | | 仕入日 | `supply_order_date` | 日時型 | | | 納品書番号 | `supply_order_delivery_id` | 文字列型 | | | 該当発注伝票番号 | `supply_order_correspond_order_id` | 数値型 | | | 仕入元伝票番号 | `supply_order_original_order_id` | 数値型 | | | 仕入金 | `supply_order_amount` | 数値型 | | | 仕入状態区分 | `supply_order_status_id` | 文字列型 | | | 仕入状態区分名 | `supply_order_status_name` | 文字列型 | | | 削除フラグ | `supply_order_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_creation_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&supply_order_id-eq=1' https://api.next-engine.org/api_v1_supplyorder_row/count ``` レスポンス ```json { "result": "success" "count": "3" "access_token":"xxxxxxxxxx", "access_token_end_date":"2018-02-24 12:13:16", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2018-02-26 12:13:16" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_supplyorder_row_count/`](/api/operations/api_v1_supplyorder_row_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入明細) - [仕入明細検索](/api/api_v1_supplyorder_row/search/) — `POST /api_v1_supplyorder_row/search` --- # 仕入明細検索 URL: https://developer.next-engine.com/api/api_v1_supplyorder_row/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_supplyorder_row/search Tag: 仕入明細 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_supplyorder_row/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 仕入明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_row_supply_order_id` | 数値型 | | | 仕入明細行 | `supply_order_row_no` | 数値型 | | | 商品コード | `supply_order_row_goods_id` | 文字列型 | | | 商品名 | `supply_order_row_goods_name` | 文字列型 | | | 商品オプション | `supply_order_row_goods_option` | 文字列型 | | | 余剰数 | `supply_order_row_surplus_quantity` | 数値型 | | | 仕入数 | `supply_order_row_quantity` | 数値型 | | | 仕入単価 | `supply_order_row_unit_price` | 数値型 | | | 小計金 | `supply_order_row_sub_total_price` | 数値型 | | | 発注伝票番号 | `supply_order_row_order_id` | 数値型 | | | 発注明細行 | `supply_order_row_order_row_no` | 数値型 | | | 受注伝票番号 | `supply_order_row_receive_order_id` | 数値型 | | | 受注明細行 | `supply_order_row_receive_order_row_no` | 数値型 | | | 仕入明細行区分 | `supply_order_row_status` | 文字列型 | 0:通常仕入, 95:不良品振替 | | 仕入完了状態 | `supply_order_row_completed_flag` | 文字列型 | 0:未完了,1:完了 | | 備考 | `supply_order_row_note` | 文字列型 | | | 削除フラグ | `supply_order_row_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_row_creation_date` | 日時型 | | | 最終更新日 | `supply_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_row_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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の場合作成者名 | ### 仕入伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 仕入伝票番号 | `supply_order_id` | 数値型 | | | 仕入コード | `supply_order_supplier_id` | 文字列型 | | | 仕入伝票区分 | `supply_order_type_id` | 数値型 | | | 仕入伝票区分名 | `supply_order_type_name` | 文字列型 | | | 仕入日 | `supply_order_date` | 日時型 | | | 納品書番号 | `supply_order_delivery_id` | 文字列型 | | | 該当発注伝票番号 | `supply_order_correspond_order_id` | 数値型 | | | 仕入元伝票番号 | `supply_order_original_order_id` | 数値型 | | | 仕入金 | `supply_order_amount` | 数値型 | | | 仕入状態区分 | `supply_order_status_id` | 文字列型 | | | 仕入状態区分名 | `supply_order_status_name` | 文字列型 | | | 削除フラグ | `supply_order_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `supply_order_creation_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_date` | 日時型 | | | 最終更新日 | `supply_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `supply_order_creator_id` | 数値型 | | | 作成担当者名 | `supply_order_creator_name` | 文字列型 | | | 最終更新者ID | `supply_order_last_modified_by_id` | 数値型 | | | 最終更新者ID | `supply_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `supply_order_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `supply_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H 'content-type: application/x-www-form-urlencoded' -d 'access_token=xxxxx&refresh_token=xxxxx&wait_flag=1&fields=supply_order_id,supply_order_row_no,supply_order_row_goods_id,supply_order_row_goods_name,supply_order_row_goods_option,supply_order_row_surplus_quantity,supply_order_row_quantity,supply_order_row_unit_price,supply_order_row_sub_total_price,supply_order_row_order_id,supply_order_row_order_row_no,supply_order_row_receive_order_id,supply_order_row_receive_order_row_no,supply_order_row_status,supply_order_row_completed_flag,supply_order_row_note,supply_order_row_deleted_flag,supply_order_row_creation_date,supply_order_row_last_modified_date,supply_order_row_last_modified_null_safe_date,supply_order_row_creator_id,supply_order_row_creator_name,supply_order_row_last_modified_by_id,supply_order_row_last_modified_by_null_safe_id,supply_order_row_last_modified_by_name,supply_order_row_last_modified_by_null_safe_name&offset=0&limit=10&supply_order_id-eq=1' https://api.next-engine.org/api_v1_supplyorder_row/search ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "supply_order_id": "1", "supply_order_row_no": "1", "supply_order_row_goods_id": "bn,nm", "supply_order_row_goods_name": "2", "supply_order_row_goods_option": "", "supply_order_row_surplus_quantity": "250", "supply_order_row_quantity": "250", "supply_order_row_unit_price": "1.00", "supply_order_row_sub_total_price": "250.00", "supply_order_row_order_id": "0", "supply_order_row_order_row_no": "1", "supply_order_row_receive_order_id": "0", "supply_order_row_receive_order_row_no": "0", "supply_order_row_status": "0", "supply_order_row_completed_flag": "0", "supply_order_row_note": "", "supply_order_row_deleted_flag": "0", "supply_order_row_creation_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_null_safe_date": "2018-02-23 13:51:57", "supply_order_row_creator_id": "10012", "supply_order_row_creator_name": "Le Hung", "supply_order_row_last_modified_by_id": "10012", "supply_order_row_last_modified_by_null_safe_id": "10012", "supply_order_row_last_modified_by_name": "Le Hung", "supply_order_row_last_modified_by_null_safe_name": "Le Hung" }, { "supply_order_id": "1", "supply_order_row_no": "2", "supply_order_row_goods_id": ",,inverter300-12v60hz_fuse", "supply_order_row_goods_name": "インバーター定格300W　12DCV　60Hz用予備ヒューズ", "supply_order_row_goods_option": "", "supply_order_row_surplus_quantity": "350", "supply_order_row_quantity": "350", "supply_order_row_unit_price": "1.00", "supply_order_row_sub_total_price": "350.00", "supply_order_row_order_id": "0", "supply_order_row_order_row_no": "2", "supply_order_row_receive_order_id": "0", "supply_order_row_receive_order_row_no": "0", "supply_order_row_status": "0", "supply_order_row_completed_flag": "0", "supply_order_row_note": "", "supply_order_row_deleted_flag": "0", "supply_order_row_creation_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_null_safe_date": "2018-02-23 13:51:57", "supply_order_row_creator_id": "10012", "supply_order_row_creator_name": "Le Hung", "supply_order_row_last_modified_by_id": "10012", "supply_order_row_last_modified_by_null_safe_id": "10012", "supply_order_row_last_modified_by_name": "Le Hung", "supply_order_row_last_modified_by_null_safe_name": "Le Hung" }, { "supply_order_id": "1", "supply_order_row_no": "3", "supply_order_row_goods_id": ",,,,,bnnnm", "supply_order_row_goods_name": "1", "supply_order_row_goods_option": "", "supply_order_row_surplus_quantity": "450", "supply_order_row_quantity": "450", "supply_order_row_unit_price": "1.00", "supply_order_row_sub_total_price": "450.00", "supply_order_row_order_id": "0", "supply_order_row_order_row_no": "3", "supply_order_row_receive_order_id": "0", "supply_order_row_receive_order_row_no": "0", "supply_order_row_status": "0", "supply_order_row_completed_flag": "0", "supply_order_row_note": "", "supply_order_row_deleted_flag": "0", "supply_order_row_creation_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_date": "2018-02-23 13:51:57", "supply_order_row_last_modified_null_safe_date": "2018-02-23 13:51:57", "supply_order_row_creator_id": "10012", "supply_order_row_creator_name": "Le Hung", "supply_order_row_last_modified_by_id": "10012", "supply_order_row_last_modified_by_null_safe_id": "10012", "supply_order_row_last_modified_by_name": "Le Hung", "supply_order_row_last_modified_by_null_safe_name": "Le Hung" } ], "access_token": "xxxxx", "access_token_end_date": "2018-02-24 12:13:16", "refresh_token": "xxxxx", "refresh_token_end_date": "2018-02-26 12:13:16" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_supplyorder_row_search/`](/api/operations/api_v1_supplyorder_row_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (仕入明細) - [仕入明細件数取得](/api/api_v1_supplyorder_row/count/) — `POST /api_v1_supplyorder_row/count` --- # オーソリ区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_authorizationtype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_authorizationtype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_authorizationtype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### オーソリ区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | オーソリ区分ID | `authorization_type_id` | 文字列型 | | | オーソリ区分名 | `authorization_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_authorizationtype/info" ``` レスポンス ```json { "result": "success", "count": "6", "data": [ { "authorization_type_id": "0", "authorization_type_name": null }, { "authorization_type_id": "99", "authorization_type_name": "その他" }, { "authorization_type_id": "1", "authorization_type_name": "楽天市場 カード決済代行あんしんサービス" }, { "authorization_type_id": "2", "authorization_type_name": "yahooネットラストかんたんストア決済" }, { "authorization_type_id": "3", "authorization_type_name": "DeNAショッピング決済サービス" }, { "authorization_type_id": "4", "authorization_type_name": "ベリトランス" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_authorizationtype_info/`](/api/operations/api_v1_system_authorizationtype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_authorizationtype/`](/guides/fields/system_authorizationtype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 受注キャンセル区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_canceltype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_canceltype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_canceltype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 受注キャンセル区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注キャンセル区分 | `cancel_type_id` | 文字列型 | | | 受注キャンセル名 | `cancel_type_name` | 文字列型 | | | 非表示フラグ | `cancel_type_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_canceltype/info" ``` レスポンス ```json { "result": "success", "count": "18", "data": [ { "cancel_type_id": "0", "cancel_type_name": "有効な受注です。" }, { "cancel_type_id": "1", "cancel_type_name": "顧客依頼によりキャンセル" }, { "cancel_type_id": "2", "cancel_type_name": "顧客依頼により明細内容をキャンセル" }, { "cancel_type_id": "3", "cancel_type_name": "他の伝票への統合の為キャンセル" }, { "cancel_type_id": "4", "cancel_type_name": "カード否決によりキャンセル" }, { "cancel_type_id": "5", "cancel_type_name": "都合によりキャンセル" }, { "cancel_type_id": "11", "cancel_type_name": "保留期間満了の為キャンセル" }, { "cancel_type_id": "12", "cancel_type_name": "伝票を確認後、有効にして下さい。" }, { "cancel_type_id": "20", "cancel_type_name": "未入金によりキャンセル" }, { "cancel_type_id": "7", "cancel_type_name": "既に何らか処理が完了しているはず" }, { "cancel_type_id": "6", "cancel_type_name": "不良返品によるキャンセル" }, { "cancel_type_id": "8", "cancel_type_name": "顧客都合返品によるキャンセル" }, { "cancel_type_id": "15", "cancel_type_name": "受取拒否によるキャンセル" }, { "cancel_type_id": "14", "cancel_type_name": "長期不在戻りによるキャンセル" }, { "cancel_type_id": "16", "cancel_type_name": "クレームによる戻りでキャンセル" }, { "cancel_type_id": "17", "cancel_type_name": "誤配の戻りによるキャンセル" }, { "cancel_type_id": "18", "cancel_type_name": "出荷遅延によるキャンセル" }, { "cancel_type_id": "19", "cancel_type_name": "住所不明によるキャンセル" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_canceltype_info/`](/api/operations/api_v1_system_canceltype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_canceltype/`](/guides/fields/system_canceltype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 確認チェック区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_confirmcheck/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_confirmcheck/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_confirmcheck/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 確認チェック区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 確認チェック区分 | `confirm_check_id` | 文字列型 | | | 確認チェック名 | `confirm_check_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_confirmcheck/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "confirm_check_id": "0", "confirm_check_name": "確認必要なし（非表示）" }, { "confirm_check_id": "1", "confirm_check_name": "確認必要（表示）" }, { "confirm_check_id": "2", "confirm_check_name": "確認済（表示）" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_confirmcheck_info/`](/api/operations/api_v1_system_confirmcheck_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # クレジット承認区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_creditapprovaltype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_creditapprovaltype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_creditapprovaltype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### クレジット承認区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | クレジット承認区分 | `credit_approval_type_id` | 文字列型 | | | クレジット承認名 | `credit_approval_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_creditapprovaltype/info" ``` レスポンス ```json { "result": "success", "count": "6", "data": [ { "credit_approval_type_id": "0", "credit_approval_type_name": "必要なし" }, { "credit_approval_type_id": "10", "credit_approval_type_name": "未承認" }, { "credit_approval_type_id": "20", "credit_approval_type_name": "承認中" }, { "credit_approval_type_id": "30", "credit_approval_type_name": "承認済" }, { "credit_approval_type_id": "70", "credit_approval_type_name": "請求済" }, { "credit_approval_type_id": "90", "credit_approval_type_name": "承認NG" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "YYYY-MM-DD HH:MM:SS", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "YYYY-MM-DD HH:MM:SS" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_creditapprovaltype_info/`](/api/operations/api_v1_system_creditapprovaltype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_creditapprovaltype/`](/guides/fields/system_creditapprovaltype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # クレジットオーソリセンター区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_creditauthorizationcenter/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_creditauthorizationcenter/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_creditauthorizationcenter/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### クレジットオーソリセンター区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | クレジットオーソリセンター区分 | `credit_authorization_center_id` | 文字列型 | | | クレジットオーソリセンター名 | `credit_authorization_center_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_creditauthorizationcenter/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "credit_authorization_center_id": "1", "credit_authorization_center_name": "三菱UFJﾆｺｽｵｰｿﾘｰｾﾝﾀｰ" }, { "credit_authorization_center_id": "2", "credit_authorization_center_name": "JCBｵｰｿﾘｰｾﾝﾀｰ" }, { "credit_authorization_center_id": "3", "credit_authorization_center_name": "Dinnersｵｰｿﾘｰｾﾝﾀｰ" } ], "access_token": "xxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_creditauthorizationcenter_info/`](/api/operations/api_v1_system_creditauthorizationcenter_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # クレジット種類区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_credittype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_credittype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_credittype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### クレジット種類区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | クレジット種類区分 | `credit_type_id` | 文字列型 | | | クレジット名 | `credit_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'uid=xxxxxxxxxxxxxx&state=xxxxxxxxxxxxxx' "https://api.next-engine.org/api_v1_system_credittype/info" ``` レスポンス ```json { "result": "success", "count": "10", "data": [ { "credit_type_id": "0", "credit_type_name": "なし" }, { "credit_type_id": "1", "credit_type_name": "AMEX" }, { "credit_type_id": "2", "credit_type_name": "JCB" }, { "credit_type_id": "3", "credit_type_name": "MasterCard" }, { "credit_type_id": "4", "credit_type_name": "NICOS" }, { "credit_type_id": "5", "credit_type_name": "VISA" }, { "credit_type_id": "6", "credit_type_name": "YahooCredit" }, { "credit_type_id": "7", "credit_type_name": "Diners" }, { "credit_type_id": "8", "credit_type_name": "UFJ(MILLION)" }, { "credit_type_id": "9", "credit_type_name": "DC" } ], "access_token": "xxxxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_credittype_info/`](/api/operations/api_v1_system_credittype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_credittype/`](/guides/fields/system_credittype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 通貨単位区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_currencyunit/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_currencyunit/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_currencyunit/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 通貨単位区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 通貨単位区分ID | `currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `currency_unit_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_currencyunit/info" ``` レスポンス ```json { "result": "success", "count": "17", "data": [ { "currency_unit_id": "1", "currency_unit_name": "円" }, { "currency_unit_id": "16", "currency_unit_name": "韓国ウォン" }, { "currency_unit_id": "15", "currency_unit_name": "インドネシア・ルピア" }, { "currency_unit_id": "14", "currency_unit_name": "インド・ルピー" }, { "currency_unit_id": "13", "currency_unit_name": "タイ・バーツ" }, { "currency_unit_id": "12", "currency_unit_name": "中国・人民元" }, { "currency_unit_id": "11", "currency_unit_name": "シンガポール・ドル" }, { "currency_unit_id": "10", "currency_unit_name": "マレーシア・リンギット" }, { "currency_unit_id": "9", "currency_unit_name": "香港ドル" }, { "currency_unit_id": "8", "currency_unit_name": "ニュージーランド・ドル" }, { "currency_unit_id": "7", "currency_unit_name": "オーストラリア・ドル" }, { "currency_unit_id": "6", "currency_unit_name": "スイス･フラン" }, { "currency_unit_id": "5", "currency_unit_name": "英ポンド" }, { "currency_unit_id": "4", "currency_unit_name": "カナダ・ドル" }, { "currency_unit_id": "3", "currency_unit_name": "ユーロ" }, { "currency_unit_id": "2", "currency_unit_name": "米ドル" }, { "currency_unit_id": "17", "currency_unit_name": "フィリピン・ペソ" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_currencyunit_info/`](/api/operations/api_v1_system_currencyunit_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_currencyunit/`](/guides/fields/system_currencyunit/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 顧客区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_customertype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_customertype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_customertype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 顧客区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 顧客区分 | `customer_type_id` | 文字列型 | | | 顧客名 | `customer_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_customertype/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "customer_type_id": "0", "customer_type_name": "一般顧客" }, { "customer_type_id": "9", "customer_type_name": "卸" }, { "customer_type_id": "99", "customer_type_name": "ブラック" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_customertype_info/`](/api/operations/api_v1_system_customertype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_customertype/`](/guides/fields/system_customertype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 発送方法区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_delivery/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_delivery/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_delivery/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 発送方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発送方法区分 | `delivery_id` | 文字列型 | | | 発送方法名 | `delivery_name` | 文字列型 | | | 非表示フラグ | `delivery_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_delivery/info" ``` レスポンス ```json { "result": "success", "count": "41", "data": [ { "delivery_id": "10", "delivery_name": "佐川急便(e飛伝PRO)" }, { "delivery_id": "12", "delivery_name": "佐川急便(e飛伝)" }, { "delivery_id": "13", "delivery_name": "佐川急便(e飛伝2)" }, { "delivery_id": "11", "delivery_name": "佐川メール便(e飛伝PRO)" }, { "delivery_id": "14", "delivery_name": "佐川メール便(e飛伝)" }, { "delivery_id": "15", "delivery_name": "佐川メール便(e飛伝2)" }, { "delivery_id": "16", "delivery_name": "楽天コンビニ受取(佐川急便)" }, { "delivery_id": "20", "delivery_name": "ヤマト(発払い)B2v6" }, { "delivery_id": "21", "delivery_name": "ヤマト(コレクト)B2v6" }, { "delivery_id": "22", "delivery_name": "ヤマト(DM便)B2v6" }, { "delivery_id": "23", "delivery_name": "ヤマト(メール速達)B2v6" }, { "delivery_id": "24", "delivery_name": "ヤマト(発払い)B2v5" }, { "delivery_id": "25", "delivery_name": "ヤマト(コレクト)B2v5" }, { "delivery_id": "26", "delivery_name": "ヤマト(DM便)B2v5" }, { "delivery_id": "27", "delivery_name": "ヤマト(メール速達)B2v5" }, { "delivery_id": "28", "delivery_name": "ヤマト(ネコポス)" }, { "delivery_id": "30", "delivery_name": "ゆうパック" }, { "delivery_id": "31", "delivery_name": "レターパック500" }, { "delivery_id": "32", "delivery_name": "レターパック350" }, { "delivery_id": "33", "delivery_name": "ゆうメール" }, { "delivery_id": "34", "delivery_name": "ポスパケット" }, { "delivery_id": "35", "delivery_name": "ゆうパケット" }, { "delivery_id": "36", "delivery_name": "楽天コンビニ受取(ゆうパック)" }, { "delivery_id": "40", "delivery_name": "定形外郵便(代引)" }, { "delivery_id": "41", "delivery_name": "定形外郵便" }, { "delivery_id": "50", "delivery_name": "日本通運e発行" }, { "delivery_id": "55", "delivery_name": "福山通運istar2" }, { "delivery_id": "60", "delivery_name": "西濃運輸カンガルm2" }, { "delivery_id": "70", "delivery_name": "Air Mail" }, { "delivery_id": "71", "delivery_name": "エコ配" }, { "delivery_id": "72", "delivery_name": "伝助" }, { "delivery_id": "80", "delivery_name": "EMS" }, { "delivery_id": "90", "delivery_name": "個別対応用_発送区分予約行1" }, { "delivery_id": "91", "delivery_name": "個別対応用_発送区分予約行2" }, { "delivery_id": "92", "delivery_name": "個別対応用_発送区分予約行3" }, { "delivery_id": "93", "delivery_name": "個別対応用_発送区分予約行4" }, { "delivery_id": "94", "delivery_name": "個別対応用_発送区分予約行5" }, { "delivery_id": "95", "delivery_name": "店頭渡し" }, { "delivery_id": "96", "delivery_name": "メーカー直送" }, { "delivery_id": "98", "delivery_name": "楽天国際配送" }, { "delivery_id": "99", "delivery_name": "海外発送" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_delivery_info/`](/api/operations/api_v1_system_delivery_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_delivery/`](/guides/fields/system_delivery/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [納期情報取得](/api/api_v1_system_deliverydate/info/) — `POST /api_v1_system_deliverydate/info` --- # 納期情報取得 URL: https://developer.next-engine.com/api/api_v1_system_deliverydate/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_deliverydate/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_deliverydate/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 納期 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 納期ID | `delivery_date_id` | 文字列型 | | | 納期名 | `delivery_date_name` | 文字列型 | | | 納期日数 | `delivery_date_days` | 文字列型 | | | 備考 | `delivery_date_note` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx' https://api.next-engine.org/api_v1_system_deliverydate/info ``` レスポンス ```json {    "result":"success",    "count":"1",    "data":[       { "delivery_date_id":"date", "delivery_date_name":"日付指定（自動更新）", "delivery_date_days":"", "delivery_date_note":"指定の日付に応じて、1〜31の納期を自動で適用" }, { "delivery_date_id":"1", "delivery_date_name":"1営業日以内に発送", "delivery_date_days":"1", "delivery_date_note":"指定日付まで残り1日もしくは過ぎた場合" }, { "delivery_date_id":"2", "delivery_date_name":"2営業日以内に発送", "delivery_date_days":"2", "delivery_date_note":"指定日付まで残り2日" }, ], "access_token":"xxxxxxxxxxx", "access_token_end_date":"2017-04-13 18:24:53", "refresh_token":"xxxxxxxxxxx", "refresh_token_end_date":"2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_deliverydate_info/`](/api/operations/api_v1_system_deliverydate_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 入金区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_deposittype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_deposittype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_deposittype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 入金区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 入金区分 | `deposit_type_id` | 文字列型 | | | 入金名 | `deposit_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_deposittype/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "deposit_type_id": "0", "deposit_type_name": "未入金" }, { "deposit_type_id": "1", "deposit_type_name": "一部入金" }, { "deposit_type_id": "2", "deposit_type_name": "入金済み" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_deposittype_info/`](/api/operations/api_v1_system_deposittype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_deposittype/`](/guides/fields/system_deposittype/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 輸送区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_forwardingmethod/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_forwardingmethod/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_forwardingmethod/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 輸送区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 輸送区分 | `forwarding_method_id` | 文字列型 | | | 輸送名 | `forwarding_method_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_forwardingmethod/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "forwarding_method_id": "0", "forwarding_method_name": "常温" }, { "forwarding_method_id": "1", "forwarding_method_name": "冷蔵" }, { "forwarding_method_id": "2", "forwarding_method_name": "冷凍" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_forwardingmethod_info/`](/api/operations/api_v1_system_forwardingmethod_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 端数処理区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_fraction/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_fraction/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_fraction/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 端数処理区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 端数処理区分 | `fraction_id` | 文字列型 | | | 端数処理名 | `fraction_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_fraction/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "fraction_id": "0", "fraction_name": "切り捨て" }, { "fraction_id": "1", "fraction_name": "四捨五入" }, { "fraction_id": "2", "fraction_name": "切り上げ" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_fraction_info/`](/api/operations/api_v1_system_fraction_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 商品ステータス区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_goodsstatus/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_goodsstatus/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_goodsstatus/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 商品ステータス区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_goodsstatus/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "goods_status_id": "0", "goods_status_name": "新商品" }, { "goods_status_id": "10", "goods_status_name": "現物有り" }, { "goods_status_id": "20", "goods_status_name": "掲載済み" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_goodsstatus_info/`](/api/operations/api_v1_system_goodsstatus_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 商品区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_goodstype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_goodstype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_goodstype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 商品区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品名 | `goods_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_goodstype/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "goods_type_id": "10", "goods_type_name": "予約" }, { "goods_type_id": "20", "goods_type_name": "受注発注" }, { "goods_type_id": "0", "goods_type_name": "通常" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_goodstype_info/`](/api/operations/api_v1_system_goodstype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 画像分類タグ件数取得 URL: https://developer.next-engine.com/api/api_v1_system_imagetag/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_imagetag/count Tag: 画像分類タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_imagetag/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 画像分類タグID | `image_tag_id` | 数値型 | | | モール/カートID | `image_tag_mall_id` | 数値型 | | | モール/カートID(サブ) | `image_tag_mall_sub_id` | 数値型 | | | 画像分類タグ | `image_tag_text` | 文字列型 | Ex:汎用-画像1,汎用-画像2,・・・ | | 自動登録用タグ番号 | `image_tag_auto_register_no` | 数値型 | 通常は並び順と同じ。モール/カートID(サブ)がある場合のみ異なる値が設定される。汎用-画像1,2,BASE-画像1,2の場合BASE-画像1の並び順は1で自動登録用タグ番号は3。 | | 並び順 | `image_tag_display_order` | 数値型 | | | 削除フラグ | `image_tag_deleted_flag` | 文字列型 | | | 作成日 | `image_tag_creation_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `image_tag_creator_id` | 数値型 | | | 作成担当者名 | `image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org/api_v1_system_imagetag/count ``` レスポンス ```json { "result": "success", "count": "40", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_imagetag_count/`](/api/operations/api_v1_system_imagetag_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (画像分類タグ) - [画像分類タグ検索](/api/api_v1_system_imagetag/search/) — `POST /api_v1_system_imagetag/search` --- # 画像分類タグ検索 URL: https://developer.next-engine.com/api/api_v1_system_imagetag/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_imagetag/search Tag: 画像分類タグ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_imagetag/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 画像分類タグ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 画像分類タグID | `image_tag_id` | 数値型 | | | モール/カートID | `image_tag_mall_id` | 数値型 | | | モール/カートID(サブ) | `image_tag_mall_sub_id` | 数値型 | | | 画像分類タグ | `image_tag_text` | 文字列型 | Ex:汎用-画像1,汎用-画像2,・・・ | | 自動登録用タグ番号 | `image_tag_auto_register_no` | 数値型 | 通常は並び順と同じ。モール/カートID(サブ)がある場合のみ異なる値が設定される。汎用-画像1,2,BASE-画像1,2の場合BASE-画像1の並び順は1で自動登録用タグ番号は3。 | | 並び順 | `image_tag_display_order` | 数値型 | | | 削除フラグ | `image_tag_deleted_flag` | 文字列型 | | | 作成日 | `image_tag_creation_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_date` | 日時型 | | | 最終更新日 | `image_tag_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `image_tag_creator_id` | 数値型 | | | 作成担当者名 | `image_tag_creator_name` | 文字列型 | | | 最終更新者ID | `image_tag_last_modified_by_id` | 数値型 | | | 最終更新者ID | `image_tag_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `image_tag_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `image_tag_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=image_tag_id%2Cimage_tag_mall_id%2Cimage_tag_mall_sub_id%2Cimage_tag_text%2Cimage_tag_auto_register_no%2Cimage_tag_display_order%2Cimage_tag_deleted_flag%2Cimage_tag_creation_date%2Cimage_tag_last_modified_date%2Cimage_tag_last_modified_null_safe_date%2Cimage_tag_creator_id%2Cimage_tag_creator_name%2Cimage_tag_last_modified_by_id%2Cimage_tag_last_modified_by_null_safe_id%2Cimage_tag_last_modified_by_name%2Cimage_tag_last_modified_by_null_safe_name&image_tag_text-like=%25%E7%94%BB%E5%83%8F1&offset=0&limit=2' https://api.next-engine.org/api_v1_system_imagetag/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "image_tag_id": "1", "image_tag_mall_id": "0", "image_tag_mall_sub_id": "0", "image_tag_text": "基本-画像1", "image_tag_auto_register_no": "1", "image_tag_display_order": "1", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" }, { "image_tag_id": "21", "image_tag_mall_id": "15", "image_tag_mall_sub_id": "0", "image_tag_text": "画像1", "image_tag_auto_register_no": "1", "image_tag_display_order": "1", "image_tag_deleted_flag": "0", "image_tag_creation_date": "2014-10-17 17:08:45", "image_tag_last_modified_date": "2014-10-17 17:08:45", "image_tag_last_modified_null_safe_date": "2014-10-17 17:08:45", "image_tag_creator_id": "0", "image_tag_creator_name": "System", "image_tag_last_modified_by_id": "0", "image_tag_last_modified_by_null_safe_id": "0", "image_tag_last_modified_by_name": "System", "image_tag_last_modified_by_null_safe_name": "System" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_imagetag_search/`](/api/operations/api_v1_system_imagetag_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (画像分類タグ) - [画像分類タグ件数取得](/api/api_v1_system_imagetag/count/) — `POST /api_v1_system_imagetag/count` --- # 重要チェック区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_importantcheck/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_importantcheck/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_importantcheck/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 重要チェック区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 重要チェック区分 | `important_check_id` | 文字列型 | | | 重要チェック名 | `important_check_name` | 文字列型 | | サンプル ### サンプル リクエスト ``` 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_importantcheck/info" ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "important_check_id": "0", "important_check_name": "" }, { "important_check_id": "1", "important_check_name": "重要" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_importantcheck_info/`](/api/operations/api_v1_system_importantcheck_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 取込種類区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_importtype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_importtype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_importtype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 取込種類区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 取込種類区分 | `import_type_id` | 文字列型 | | | 取込種類名 | `import_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_importtype/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "import_type_id": "0", "import_type_name": "メール" }, { "import_type_id": "1", "import_type_name": "ＣＳＶ" }, { "import_type_id": "2", "import_type_name": "手入力" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_importtype_info/`](/api/operations/api_v1_system_importtype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 入出荷区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_iotype/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_iotype/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_iotype/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 入出荷区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 入出荷区分 | `io_type_id` | 文字列型 | | | 入出荷名 | `io_type_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_iotype/info" ``` レスポンス ```json { "result": "success", "count": "16", "data": [ { "io_type_id": "0", "io_type_name": "出荷" }, { "io_type_id": "74", "io_type_name": "予約在庫出庫" }, { "io_type_id": "73", "io_type_name": "予約在庫入庫" }, { "io_type_id": "72", "io_type_name": "不良品出庫" }, { "io_type_id": "71", "io_type_name": "不良品入庫" }, { "io_type_id": "70", "io_type_name": "不良品への振替" }, { "io_type_id": "60", "io_type_name": "欠品" }, { "io_type_id": "50", "io_type_name": "他勘定入庫" }, { "io_type_id": "40", "io_type_name": "他勘定出庫" }, { "io_type_id": "30", "io_type_name": "仕入返品" }, { "io_type_id": "22", "io_type_name": "仕入修正" }, { "io_type_id": "20", "io_type_name": "仕入" }, { "io_type_id": "12", "io_type_name": "出荷確定戻し" }, { "io_type_id": "11", "io_type_name": "売上返品戻し" }, { "io_type_id": "10", "io_type_name": "売上返品" }, { "io_type_id": "99", "io_type_name": "棚卸" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_iotype_info/`](/api/operations/api_v1_system_iotype_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 項目名情報取得 URL: https://developer.next-engine.com/api/api_v1_system_itemname/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_itemname/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_itemname/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 項目名 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 項目ID | `item_id` | 文字列型 | | | 項目名 | `item_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_itemname/info" ``` レスポンス ```json { "result": "success", "count": "30", "data": [ { "item_id": "org1", "item_name": "項目１" }, { "item_id": "org10", "item_name": "項目１０" }, { "item_id": "org11", "item_name": "項目１１" }, { "item_id": "org12", "item_name": "項目１２" }, { "item_id": "org13", "item_name": "項目１３" }, { "item_id": "org14", "item_name": "項目１４" }, { "item_id": "org15", "item_name": "項目１５" }, { "item_id": "org16", "item_name": "項目１６" }, { "item_id": "org17", "item_name": "項目１７" }, { "item_id": "org18", "item_name": "項目１８" }, { "item_id": "org19", "item_name": "項目１９" }, { "item_id": "org2", "item_name": "項目２" }, { "item_id": "org20", "item_name": "項目２０" }, { "item_id": "org3", "item_name": "項目３" }, { "item_id": "org4", "item_name": "項目４" }, { "item_id": "org5", "item_name": "項目５" }, { "item_id": "org6", "item_name": "項目６" }, { "item_id": "org7", "item_name": "項目７" }, { "item_id": "org8", "item_name": "項目８" }, { "item_id": "org9", "item_name": "項目９" }, { "item_id": "org_select1", "item_name": "選択肢１" }, { "item_id": "org_select10", "item_name": "選択肢１０" }, { "item_id": "org_select2", "item_name": "選択肢２" }, { "item_id": "org_select3", "item_name": "選択肢３" }, { "item_id": "org_select4", "item_name": "選択肢４" }, { "item_id": "org_select5", "item_name": "選択肢５" }, { "item_id": "org_select6", "item_name": "選択肢６" }, { "item_id": "org_select7", "item_name": "選択肢７" }, { "item_id": "org_select8", "item_name": "選択肢８" }, { "item_id": "org_select9", "item_name": "選択肢９" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_itemname_info/`](/api/operations/api_v1_system_itemname_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # モール件数取得 URL: https://developer.next-engine.com/api/api_v1_system_mall/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_mall/count Tag: モール Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_mall/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### モール/カート | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モール/カートID | `mall_id` | 数値型 | | | モール/カート名 | `mall_name` | 文字列型 | | | モール/カートカナ | `mall_kana` | 文字列型 | | | 備考 | `mall_note` | 文字列型 | | | 国ID | `mall_country_id` | 文字列型 | | | 削除フラグ | `mall_deleted_flag` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx&mall_name-like=xxxxxx' https://api.next-engine.org/api_v1_system_mall/count ``` レスポンス ```json { "result": "success", "count": "1", "access_token": "xxxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_mall_count/`](/api/operations/api_v1_system_mall_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_mall/`](/guides/fields/system_mall/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (モール) - [モール検索](/api/api_v1_system_mall/search/) — `POST /api_v1_system_mall/search` --- # モール検索 URL: https://developer.next-engine.com/api/api_v1_system_mall/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_mall/search Tag: モール Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_mall/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### モール/カート | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モール/カートID | `mall_id` | 数値型 | | | モール/カート名 | `mall_name` | 文字列型 | | | モール/カートカナ | `mall_kana` | 文字列型 | | | 備考 | `mall_note` | 文字列型 | | | 国ID | `mall_country_id` | 文字列型 | | | 削除フラグ | `mall_deleted_flag` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=mall_id%2Cmall_name%2Cmall_kana%2Cmall_note%2Cmall_country_id%2Cmall_deleted_flag&mall_name-like=Yahoo!%E3%82%B7%E3%83%A7%E3%83%83%E3%83%94%E3%83%B3%E3%82%B0&offset=0&limit=2' https://api.next-engine.org/api_v1_system_mall/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "mall_id": "2", "mall_name": "Yahoo!ショッピング", "mall_kana": "ヤフーショッピング", "mall_note": null, "mall_country_id": "1", "mall_deleted_flag": "0" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxxxxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_mall_search/`](/api/operations/api_v1_system_mall_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_mall/`](/guides/fields/system_mall/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (モール) - [モール件数取得](/api/api_v1_system_mall/count/) — `POST /api_v1_system_mall/count` --- # モールカテゴリ件数取得 URL: https://developer.next-engine.com/api/api_v1_system_mallcategory/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_mallcategory/count Tag: モールカテゴリ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_mallcategory/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### モールカテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モールカテゴリID | `mall_category_id` | 数値型 | | | モール/カートID | `mall_category_mall_id` | 数値型 | | | モールカテゴリコード | `mall_category_code` | 文字列型 | | | 親モールカテゴリID | `mall_category_parent_mall_category_id` | 数値型 | | | カテゴリ名 | `mall_category_name` | 文字列型 | Ex:パソコン | | カテゴリ名(フル) | `mall_category_full_name` | 文字列型 | Ex: オークション > コンピュータ > パソコン | | 削除フラグ | `mall_category_deleted_flag` | 文字列型 | | | 作成日 | `mall_category_creation_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `mall_category_creator_id` | 数値型 | | | 作成担当者名 | `mall_category_creator_name` | 文字列型 | | | 最終更新者ID | `mall_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `mall_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `mall_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `mall_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxx&refresh_token=xxxxx' https://api.next-engine.org/api_v1_system_mallcategory/count ``` レスポンス ```json { "result": "success", "count": "157975", "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_mallcategory_count/`](/api/operations/api_v1_system_mallcategory_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (モールカテゴリ) - [モールカテゴリ検索](/api/api_v1_system_mallcategory/search/) — `POST /api_v1_system_mallcategory/search` --- # モールカテゴリ検索 URL: https://developer.next-engine.com/api/api_v1_system_mallcategory/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_mallcategory/search Tag: モールカテゴリ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_mallcategory/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### モールカテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モールカテゴリID | `mall_category_id` | 数値型 | | | モール/カートID | `mall_category_mall_id` | 数値型 | | | モールカテゴリコード | `mall_category_code` | 文字列型 | | | 親モールカテゴリID | `mall_category_parent_mall_category_id` | 数値型 | | | カテゴリ名 | `mall_category_name` | 文字列型 | Ex:パソコン | | カテゴリ名(フル) | `mall_category_full_name` | 文字列型 | Ex: オークション > コンピュータ > パソコン | | 削除フラグ | `mall_category_deleted_flag` | 文字列型 | | | 作成日 | `mall_category_creation_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_date` | 日時型 | | | 最終更新日 | `mall_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `mall_category_creator_id` | 数値型 | | | 作成担当者名 | `mall_category_creator_name` | 文字列型 | | | 最終更新者ID | `mall_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `mall_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `mall_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `mall_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&mall_category_id-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_system_imagetag/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "mall_category_id": "1", "mall_category_mall_id": "15", "mall_category_code": null, "mall_category_parent_mall_category_id": null, "mall_category_name": "オークション", "mall_category_full_name": "オークション", "mall_category_deleted_flag": "0", "mall_category_creation_date": "2014-11-05 14:27:55", "mall_category_last_modified_date": "2015-01-19 11:43:52", "mall_category_last_modified_null_safe_date": "2015-01-19 11:43:52", "mall_category_creator_id": "9999", "mall_category_creator_name": "管理者", "mall_category_last_modified_by_id": "9999", "mall_category_last_modified_by_null_safe_id": "9999", "mall_category_last_modified_by_name": "管理者", "mall_category_last_modified_by_null_safe_name": "管理者" }, { "mall_category_id": "2", "mall_category_mall_id": "15", "mall_category_code": null, "mall_category_parent_mall_category_id": "1", "mall_category_name": "コンピュータ", "mall_category_full_name": "オークション > コンピュータ", "mall_category_deleted_flag": "0", "mall_category_creation_date": "2014-11-05 14:27:55", "mall_category_last_modified_date": "2015-01-19 11:43:52", "mall_category_last_modified_null_safe_date": "2015-01-19 11:43:52", "mall_category_creator_id": "9999", "mall_category_creator_name": "管理者", "mall_category_last_modified_by_id": "9999", "mall_category_last_modified_by_null_safe_id": "9999", "mall_category_last_modified_by_name": "管理者", "mall_category_last_modified_by_null_safe_name": "管理者" } ], "access_token": "xxxxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-20 11:19:26" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_mallcategory_search/`](/api/operations/api_v1_system_mallcategory_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (モールカテゴリ) - [モールカテゴリ件数取得](/api/api_v1_system_mallcategory/count/) — `POST /api_v1_system_mallcategory/count` --- # 取扱区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_merchandise/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_merchandise/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_merchandise/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 取扱区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 取扱区分 | `merchandise_id` | 文字列型 | | | 取扱名 | `merchandise_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_merchandise/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "merchandise_id": "0", "merchandise_name": "取扱中" }, { "merchandise_id": "1", "merchandise_name": "取扱中止" }, { "merchandise_id": "2", "merchandise_name": "ﾒｰｶｰ取扱中止" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_merchandise_info/`](/api/operations/api_v1_system_merchandise_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 発注区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_order/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_order/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_order/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 発注区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注区分 | `order_id` | 文字列型 | | | 発注名 | `order_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_order/info" ``` レスポンス ```json { "result": "success", "count": "3", "data": [ { "order_id": "0", "order_name": "PDF" }, { "order_id": "10", "order_name": "XLS" }, { "order_id": "20", "order_name": "PDFとXLS" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_order_info/`](/api/operations/api_v1_system_order_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 発注条件区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_ordercondition/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_ordercondition/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_ordercondition/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 発注条件区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発注条件区分 | `order_condition_id` | 文字列型 | | | 発注条件名 | `order_condition_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_ordercondition/info" ``` レスポンス ```json { "result": "success", "count": "4", "data": [ { "order_condition_id": "0", "order_condition_name": "無し" }, { "order_condition_id": "1", "order_condition_name": "数量条件のみ" }, { "order_condition_id": "2", "order_condition_name": "金額条件のみ" }, { "order_condition_id": "5", "order_condition_name": "両方の条件が必要" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_ordercondition_info/`](/api/operations/api_v1_system_ordercondition_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 受注状態区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_orderstatus/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_orderstatus/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_orderstatus/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 受注状態区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注状態区分 | `order_status_id` | 文字列型 | | | 受注状態名 | `order_status_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_orderstatus/info" ``` レスポンス ```json { "result": "success", "count": "7", "data": [ { "order_status_id": "0", "order_status_name": "取込情報不足" }, { "order_status_id": "1", "order_status_name": "受注メール取込済" }, { "order_status_id": "2", "order_status_name": "起票済(CSV/手入力)" }, { "order_status_id": "20", "order_status_name": "納品書印刷待ち" }, { "order_status_id": "30", "order_status_name": "納品書印刷中" }, { "order_status_id": "40", "order_status_name": "納品書印刷済" }, { "order_status_id": "50", "order_status_name": "出荷確定済（完了）" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_orderstatus_info/`](/api/operations/api_v1_system_orderstatus_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_orderstatus/`](/guides/fields/system_orderstatus/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # ページステータス区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_pagestatus/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_pagestatus/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_pagestatus/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### ページステータス区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | ページステータス区分名 | `page_status_id` | 文字列型 | | | ページステータス名 | `page_status_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_pagestatus/info" ``` レスポンス ```json { "result": "success", "count": "4", "data": [ { "page_status_id": "1", "page_status_name": "新規登録" }, { "page_status_id": "2", "page_status_name": "編集中" }, { "page_status_id": "3", "page_status_name": "アップロード予定" }, { "page_status_id": "4", "page_status_name": "掲載済み" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_pagestatus_info/`](/api/operations/api_v1_system_pagestatus_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 支払区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_paymentmethod/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_paymentmethod/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_paymentmethod/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 支払区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 支払区分 | `payment_method_id` | 文字列型 | | | 支払名 | `payment_method_name` | 文字列型 | | | 非表示フラグ | `payment_method_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_paymentmethod/info" ``` レスポンス ```json { "result": "success", "count": "47", "data": [ { "payment_method_id": "0", "payment_method_name": "クレジットカード" }, { "payment_method_id": "1", "payment_method_name": "代金引換" }, { "payment_method_id": "15", "payment_method_name": "銀行振込前払い" }, { "payment_method_id": "16", "payment_method_name": "銀行振込後払い" }, { "payment_method_id": "20", "payment_method_name": "郵便振替" }, { "payment_method_id": "21", "payment_method_name": "現金書留" }, { "payment_method_id": "51", "payment_method_name": "auかんたん決済" }, { "payment_method_id": "30", "payment_method_name": "まとめてau支払い" }, { "payment_method_id": "31", "payment_method_name": "モバイルSuica" }, { "payment_method_id": "32", "payment_method_name": "コンビニ決済" }, { "payment_method_id": "33", "payment_method_name": "ペイジー決済" }, { "payment_method_id": "34", "payment_method_name": "NP後払い" }, { "payment_method_id": "35", "payment_method_name": "ローソン前払" }, { "payment_method_id": "36", "payment_method_name": "セブンイレブン前払" }, { "payment_method_id": "40", "payment_method_name": "楽天バンク決済" }, { "payment_method_id": "41", "payment_method_name": "S!まとめて支払い" }, { "payment_method_id": "42", "payment_method_name": "ドコモケータイ払い" }, { "payment_method_id": "43", "payment_method_name": "iD決済" }, { "payment_method_id": "44", "payment_method_name": "Yahoo!かんたん決済" }, { "payment_method_id": "45", "payment_method_name": "ウェブマネー決済" }, { "payment_method_id": "46", "payment_method_name": "楽天銀行" }, { "payment_method_id": "47", "payment_method_name": "Edy決済 " }, { "payment_method_id": "48", "payment_method_name": "Amazonペイメント" }, { "payment_method_id": "49", "payment_method_name": "ジャパンネット銀行" }, { "payment_method_id": "50", "payment_method_name": "後払い.com" }, { "payment_method_id": "52", "payment_method_name": "ペイジェント決済" }, { "payment_method_id": "53", "payment_method_name": "クレジットカード(pg)" }, { "payment_method_id": "54", "payment_method_name": "コンビニ決済(pg)" }, { "payment_method_id": "55", "payment_method_name": "銀行ネット決済(pg)" }, { "payment_method_id": "56", "payment_method_name": "ATM決済(pg)" }, { "payment_method_id": "57", "payment_method_name": "携帯キャリア決済(pg)" }, { "payment_method_id": "58", "payment_method_name": "ペーパーレス決済" }, { "payment_method_id": "59", "payment_method_name": "Qoo10" }, { "payment_method_id": "60", "payment_method_name": "Paypal" }, { "payment_method_id": "61", "payment_method_name": "＠払い" }, { "payment_method_id": "63", "payment_method_name": "ソフトバンクまとめて支払い" }, { "payment_method_id": "64", "payment_method_name": "アトディーネ" }, { "payment_method_id": "65", "payment_method_name": "Yahoo!マネー／預金払い" }, { "payment_method_id": "66", "payment_method_name": "クロネコ代金後払い" }, { "payment_method_id": "80", "payment_method_name": "前払決済" }, { "payment_method_id": "85", "payment_method_name": "ポイント全額支払い" }, { "payment_method_id": "90", "payment_method_name": "サンプル・貸し出し" }, { "payment_method_id": "91", "payment_method_name": "国際取引決済" }, { "payment_method_id": "95", "payment_method_name": "掛売" }, { "payment_method_id": "96", "payment_method_name": "その他" }, { "payment_method_id": "70", "payment_method_name": "その他２" }, { "payment_method_id": "99", "payment_method_name": "支払済" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_paymentmethod_info/`](/api/operations/api_v1_system_paymentmethod_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_paymentmethod/`](/guides/fields/system_paymentmethod/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 支払方法区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_payout/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_payout/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_payout/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 支払方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 支払方法区分 | `pay_out_id` | 文字列型 | | | 支払方法名 | `pay_out_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_payout/info" ``` レスポンス ```json { "result": "success", "count": "4", "data": [ { "pay_out_id": "0", "pay_out_name": "現金" }, { "pay_out_id": "10", "pay_out_name": "掛け" }, { "pay_out_id": "20", "pay_out_name": "銀行振込" }, { "pay_out_id": "30", "pay_out_name": "郵便振込" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_payout_info/`](/api/operations/api_v1_system_payout_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # アップロードキュー件数取得 URL: https://developer.next-engine.com/api/api_v1_system_que/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_que/count Tag: アップロードキュー Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_que/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### アップロードキュー | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | アップロードキューID | `que_id` | 数値型 | | | 機能名 | `que_method_name` | 文字列型 | SYOHIN_KIHON_CSV:商品マスタCSVアップロード,MALL_SYOHIN_CSV_TO_MASTER:商品情報一括登録 | | 店舗ID | `que_shop_id` | 文字列型 | | | アップロード名 | `que_upload_name` | 文字列型 | SYOHIN_KIHON_QUE:商品マスタ予約アップロード,TENPO_SYOHIN:商品情報一括登録（モール商品履歴表示用）,SYOHIN_KIHON:商品情報一括登録（商品マスタ履歴表示用）,MALL_SYOHIN_CSV_TO_MASTER_SYOHIN_KIHON:商品情報一括登録（商品マスタ取込用）,PAGE_SYOHIN:商品情報一括登録（ページ管理履歴表示用）,NE_API:ネクストエンジンAPI | | クライアントファイル名 | `que_client_file_name` | 文字列型 | ユーザーがアップロードした時のファイル名。 | | ファイル名 | `que_file_name` | 文字列型 | 商品マスタCSV、モール商品CSV等 | | ステータス | `que_status_id` | 数値型 | 2:全て処理成功、1:処理中、0:処理待ち、-1:処理失敗 | | メッセージ | `que_message` | 文字列型 | 処理中の場合、進捗状況、処理失敗の場合は、エラーになった理由（メイン機能のアップロード履歴と同じ）。 | | 削除フラグ | `que_deleted_flag` | 文字列型 | | | 作成日 | `que_creation_date` | 日時型 | | | 最終更新日 | `que_last_modified_date` | 日時型 | | | 最終更新日 | `que_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `que_creator_id` | 数値型 | | | 作成担当者名 | `que_creator_name` | 文字列型 | | | 最終更新者ID | `que_last_modified_by_id` | 数値型 | | | 最終更新者ID | `que_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `que_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `que_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxx&refresh_token=xxxxxxxxxx' https://api.next-engine.org/api_v1_system_que/count ``` レスポンス ```json { "result": "success", "count": "172", "access_token": "xxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_que_count/`](/api/operations/api_v1_system_que_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (アップロードキュー) - [アップロードキュー検索](/api/api_v1_system_que/search/) — `POST /api_v1_system_que/search` --- # アップロードキュー検索 URL: https://developer.next-engine.com/api/api_v1_system_que/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_que/search Tag: アップロードキュー Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_que/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### アップロードキュー | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | アップロードキューID | `que_id` | 数値型 | | | 機能名 | `que_method_name` | 文字列型 | SYOHIN_KIHON_CSV:商品マスタCSVアップロード,MALL_SYOHIN_CSV_TO_MASTER:商品情報一括登録 | | 店舗ID | `que_shop_id` | 文字列型 | | | アップロード名 | `que_upload_name` | 文字列型 | SYOHIN_KIHON_QUE:商品マスタ予約アップロード,TENPO_SYOHIN:商品情報一括登録（モール商品履歴表示用）,SYOHIN_KIHON:商品情報一括登録（商品マスタ履歴表示用）,MALL_SYOHIN_CSV_TO_MASTER_SYOHIN_KIHON:商品情報一括登録（商品マスタ取込用）,PAGE_SYOHIN:商品情報一括登録（ページ管理履歴表示用）,NE_API:ネクストエンジンAPI | | クライアントファイル名 | `que_client_file_name` | 文字列型 | ユーザーがアップロードした時のファイル名。 | | ファイル名 | `que_file_name` | 文字列型 | 商品マスタCSV、モール商品CSV等 | | ステータス | `que_status_id` | 数値型 | 2:全て処理成功、1:処理中、0:処理待ち、-1:処理失敗 | | メッセージ | `que_message` | 文字列型 | 処理中の場合、進捗状況、処理失敗の場合は、エラーになった理由（メイン機能のアップロード履歴と同じ）。 | | 削除フラグ | `que_deleted_flag` | 文字列型 | | | 作成日 | `que_creation_date` | 日時型 | | | 最終更新日 | `que_last_modified_date` | 日時型 | | | 最終更新日 | `que_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `que_creator_id` | 数値型 | | | 作成担当者名 | `que_creator_name` | 文字列型 | | | 最終更新者ID | `que_last_modified_by_id` | 数値型 | | | 最終更新者ID | `que_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `que_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `que_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=que_id%2Cque_method_name%2Cque_shop_id%2Cque_upload_name%2Cque_client_file_name%2Cque_file_name%2Cque_status_id%2Cque_message%2Cque_deleted_flag%2Cque_creation_date%2Cque_last_modified_date%2Cque_last_modified_null_safe_date%2Cque_creator_id%2Cque_creator_name%2Cque_last_modified_by_id%2Cque_last_modified_by_name%2Cque_last_modified_by_null_safe_id%2Cque_last_modified_by_null_safe_name&offset=1&limit=2' https://api.next-engine.org/api_v1_system_que/search ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "que_id": "1", "que_method_name": "SYOHIN_KIHON_CSV", "que_shop_id": "", "que_upload_name": "NE_API", "que_client_file_name": "xxxxxxx", "que_file_name": "商品マスタCSV", "que_status_id": "2", "que_message": "正常に[1]件、取り込みました。", "que_deleted_flag": "0", "que_creation_date": "2017-01-19 11:27:55", "que_last_modified_date": "2017-01-19 11:29:02", "que_last_modified_null_safe_date": "2017-01-19 11:29:02", "que_creator_id": "10004", "que_creator_name": "xxxxxx", "que_last_modified_by_id": "0", "que_last_modified_by_name": "System", "que_last_modified_by_null_safe_id": "0", "que_last_modified_by_null_safe_name": "System" }, { "que_id": "2", "que_method_name": "SYOHIN_KIHON_CSV", "que_shop_id": "", "que_upload_name": "NE_API", "que_client_file_name": "xxxxxx", "que_file_name": "商品マスタCSV", "que_status_id": "2", "que_message": "正常に[1]件、取り込みました。", "que_deleted_flag": "0", "que_creation_date": "2017-01-19 11:29:39", "que_last_modified_date": "2017-01-19 11:30:36", "que_last_modified_null_safe_date": "2017-01-19 11:30:36", "que_creator_id": "10002", "que_creator_name": "xxxxxxx", "que_last_modified_by_id": "0", "que_last_modified_by_name": "System", "que_last_modified_by_null_safe_id": "0", "que_last_modified_by_null_safe_name": "System" } ], "access_token": "xxxxxxxxxx", "access_token_end_date": "2017-04-15 13:03:47", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-17 13:03:47" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_que_search/`](/api/operations/api_v1_system_que_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (アップロードキュー) - [アップロードキュー件数取得](/api/api_v1_system_que/count/) — `POST /api_v1_system_que/count` --- # 返品事由区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_returnedreason/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_returnedreason/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_returnedreason/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 返品事由区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 返品事由区分 | `returned_reason_id` | 文字列型 | | | 返品事由名 | `returned_reason_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_returnedreason/info" ``` レスポンス ```json { "result": "success", "count": "8", "data": [ { "returned_reason_id": "0", "returned_reason_name": "受注キャンセル" }, { "returned_reason_id": "10", "returned_reason_name": "商品不良" }, { "returned_reason_id": "20", "returned_reason_name": "受取拒否" }, { "returned_reason_id": "30", "returned_reason_name": "長期不在" }, { "returned_reason_id": "40", "returned_reason_name": "クレーム" }, { "returned_reason_id": "50", "returned_reason_name": "誤配" }, { "returned_reason_id": "60", "returned_reason_name": "出荷遅延" }, { "returned_reason_id": "70", "returned_reason_name": "住所不明" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_returnedreason_info/`](/api/operations/api_v1_system_returnedreason_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 商品選択肢区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_select/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_select/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_select/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 商品選択肢区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品選択肢区分 | `select_id` | 文字列型 | | | 商品選択肢値 | `select_value` | 文字列型 | | | 商品選択肢名 | `select_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_select/info" ``` レスポンス ```json { "result": "success", "count": "110", "data": [ { "select_id": "1", "select_value": "0", "select_name": "0" }, { "select_id": "1", "select_value": "1", "select_name": "1" }, { "select_id": "1", "select_value": "2", "select_name": "2" }, { "select_id": "1", "select_value": "3", "select_name": "3" }, { "select_id": "1", "select_value": "4", "select_name": "4" }, { "select_id": "1", "select_value": "5", "select_name": "5" }, { "select_id": "1", "select_value": "6", "select_name": "6" }, { "select_id": "1", "select_value": "7", "select_name": "7" }, { "select_id": "1", "select_value": "8", "select_name": "8" }, { "select_id": "1", "select_value": "9", "select_name": "9" }, { "select_id": "1", "select_value": "10", "select_name": "10" }, { "select_id": "2", "select_value": "0", "select_name": "0" }, { "select_id": "2", "select_value": "1", "select_name": "1" }, { "select_id": "2", "select_value": "2", "select_name": "2" }, { "select_id": "2", "select_value": "3", "select_name": "3" }, { "select_id": "2", "select_value": "4", "select_name": "4" }, { "select_id": "2", "select_value": "5", "select_name": "5" }, { "select_id": "2", "select_value": "6", "select_name": "6" }, { "select_id": "2", "select_value": "7", "select_name": "7" }, { "select_id": "2", "select_value": "8", "select_name": "8" }, { "select_id": "2", "select_value": "9", "select_name": "9" }, { "select_id": "2", "select_value": "10", "select_name": "10" }, { "select_id": "3", "select_value": "0", "select_name": "0" }, { "select_id": "3", "select_value": "1", "select_name": "1" }, { "select_id": "3", "select_value": "2", "select_name": "2" }, { "select_id": "3", "select_value": "3", "select_name": "3" }, { "select_id": "3", "select_value": "4", "select_name": "4" }, { "select_id": "3", "select_value": "5", "select_name": "5" }, { "select_id": "3", "select_value": "6", "select_name": "6" }, { "select_id": "3", "select_value": "7", "select_name": "7" }, { "select_id": "3", "select_value": "8", "select_name": "8" }, { "select_id": "3", "select_value": "9", "select_name": "9" }, { "select_id": "3", "select_value": "10", "select_name": "10" }, { "select_id": "4", "select_value": "0", "select_name": "0" }, { "select_id": "4", "select_value": "1", "select_name": "1" }, { "select_id": "4", "select_value": "2", "select_name": "2" }, { "select_id": "4", "select_value": "3", "select_name": "3" }, { "select_id": "4", "select_value": "4", "select_name": "4" }, { "select_id": "4", "select_value": "5", "select_name": "5" }, { "select_id": "4", "select_value": "6", "select_name": "6" }, { "select_id": "4", "select_value": "7", "select_name": "7" }, { "select_id": "4", "select_value": "8", "select_name": "8" }, { "select_id": "4", "select_value": "9", "select_name": "9" }, { "select_id": "4", "select_value": "10", "select_name": "10" }, { "select_id": "5", "select_value": "0", "select_name": "0" }, { "select_id": "5", "select_value": "1", "select_name": "1" }, { "select_id": "5", "select_value": "2", "select_name": "2" }, { "select_id": "5", "select_value": "3", "select_name": "3" }, { "select_id": "5", "select_value": "4", "select_name": "4" }, { "select_id": "5", "select_value": "5", "select_name": "5" }, { "select_id": "5", "select_value": "6", "select_name": "6" }, { "select_id": "5", "select_value": "7", "select_name": "7" }, { "select_id": "5", "select_value": "8", "select_name": "8" }, { "select_id": "5", "select_value": "9", "select_name": "9" }, { "select_id": "5", "select_value": "10", "select_name": "10" }, { "select_id": "6", "select_value": "0", "select_name": "0" }, { "select_id": "6", "select_value": "1", "select_name": "1" }, { "select_id": "6", "select_value": "2", "select_name": "2" }, { "select_id": "6", "select_value": "3", "select_name": "3" }, { "select_id": "6", "select_value": "4", "select_name": "4" }, { "select_id": "6", "select_value": "5", "select_name": "5" }, { "select_id": "6", "select_value": "6", "select_name": "6" }, { "select_id": "6", "select_value": "7", "select_name": "7" }, { "select_id": "6", "select_value": "8", "select_name": "8" }, { "select_id": "6", "select_value": "9", "select_name": "9" }, { "select_id": "6", "select_value": "10", "select_name": "10" }, { "select_id": "7", "select_value": "0", "select_name": "0" }, { "select_id": "7", "select_value": "1", "select_name": "1" }, { "select_id": "7", "select_value": "2", "select_name": "2" }, { "select_id": "7", "select_value": "3", "select_name": "3" }, { "select_id": "7", "select_value": "4", "select_name": "4" }, { "select_id": "7", "select_value": "5", "select_name": "5" }, { "select_id": "7", "select_value": "6", "select_name": "6" }, { "select_id": "7", "select_value": "7", "select_name": "7" }, { "select_id": "7", "select_value": "8", "select_name": "8" }, { "select_id": "7", "select_value": "9", "select_name": "9" }, { "select_id": "7", "select_value": "10", "select_name": "10" }, { "select_id": "8", "select_value": "0", "select_name": "0" }, { "select_id": "8", "select_value": "1", "select_name": "1" }, { "select_id": "8", "select_value": "2", "select_name": "2" }, { "select_id": "8", "select_value": "3", "select_name": "3" }, { "select_id": "8", "select_value": "4", "select_name": "4" }, { "select_id": "8", "select_value": "5", "select_name": "5" }, { "select_id": "8", "select_value": "6", "select_name": "6" }, { "select_id": "8", "select_value": "7", "select_name": "7" }, { "select_id": "8", "select_value": "8", "select_name": "8" }, { "select_id": "8", "select_value": "9", "select_name": "9" }, { "select_id": "8", "select_value": "10", "select_name": "10" }, { "select_id": "9", "select_value": "0", "select_name": "0" }, { "select_id": "9", "select_value": "1", "select_name": "1" }, { "select_id": "9", "select_value": "2", "select_name": "2" }, { "select_id": "9", "select_value": "3", "select_name": "3" }, { "select_id": "9", "select_value": "4", "select_name": "4" }, { "select_id": "9", "select_value": "5", "select_name": "5" }, { "select_id": "9", "select_value": "6", "select_name": "6" }, { "select_id": "9", "select_value": "7", "select_name": "7" }, { "select_id": "9", "select_value": "8", "select_name": "8" }, { "select_id": "9", "select_value": "9", "select_name": "9" }, { "select_id": "9", "select_value": "10", "select_name": "10" }, { "select_id": "10", "select_value": "0", "select_name": "0" }, { "select_id": "10", "select_value": "1", "select_name": "1" }, { "select_id": "10", "select_value": "2", "select_name": "2" }, { "select_id": "10", "select_value": "3", "select_name": "3" }, { "select_id": "10", "select_value": "4", "select_name": "4" }, { "select_id": "10", "select_value": "5", "select_name": "5" }, { "select_id": "10", "select_value": "6", "select_name": "6" }, { "select_id": "10", "select_value": "7", "select_name": "7" }, { "select_id": "10", "select_value": "8", "select_name": "8" }, { "select_id": "10", "select_value": "9", "select_name": "9" }, { "select_id": "10", "select_value": "10", "select_name": "10" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_select_info/`](/api/operations/api_v1_system_select_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 社会保険区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_socialinsurance/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_socialinsurance/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_socialinsurance/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 社会保険区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 社会保険区分 | `social_insurance_id` | 文字列型 | | | 社会保険名 | `social_insurance_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_socialinsurance/info" ``` レスポンス ```json { "result": "success", "count": "5", "data": [ { "social_insurance_id": "0", "social_insurance_name": "労働者災害保障保険" }, { "social_insurance_id": "10", "social_insurance_name": "雇用保険" }, { "social_insurance_id": "20", "social_insurance_name": "健康保険" }, { "social_insurance_id": "30", "social_insurance_name": "厚生年金保険" }, { "social_insurance_id": "40", "social_insurance_name": "国民健康保険" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_socialinsurance_info/`](/api/operations/api_v1_system_socialinsurance_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 税区分情報取得 URL: https://developer.next-engine.com/api/api_v1_system_tax/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_system_tax/info Tag: 区分情報 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_system_tax/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 税区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 税区分 | `tax_id` | 文字列型 | | | 税名 | `tax_name` | 文字列型 | | サンプル ### サンプル リクエスト ``` 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_tax/info" ``` レスポンス ```json { "result": "success", "count": "2", "data": [ { "tax_id": "0", "tax_name": "税込" }, { "tax_id": "1", "tax_name": "税抜" } ], "access_token": "xxxxxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_system_tax_info/`](/api/operations/api_v1_system_tax_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/system_tax/`](/guides/fields/system_tax/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (区分情報) - [受注一括登録パターン情報取得](/api/api_v1_receiveorder_uploadpattern/info/) — `POST /api_v1_receiveorder_uploadpattern/info` - [オーソリ区分情報取得](/api/api_v1_system_authorizationtype/info/) — `POST /api_v1_system_authorizationtype/info` - [受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info/) — `POST /api_v1_system_canceltype/info` - [確認チェック区分情報取得](/api/api_v1_system_confirmcheck/info/) — `POST /api_v1_system_confirmcheck/info` - [クレジット承認区分情報取得](/api/api_v1_system_creditapprovaltype/info/) — `POST /api_v1_system_creditapprovaltype/info` - [クレジットオーソリセンター区分情報取得](/api/api_v1_system_creditauthorizationcenter/info/) — `POST /api_v1_system_creditauthorizationcenter/info` - [クレジット種類区分情報取得](/api/api_v1_system_credittype/info/) — `POST /api_v1_system_credittype/info` - [通貨単位区分情報取得](/api/api_v1_system_currencyunit/info/) — `POST /api_v1_system_currencyunit/info` - [顧客区分情報取得](/api/api_v1_system_customertype/info/) — `POST /api_v1_system_customertype/info` - [発送方法区分情報取得](/api/api_v1_system_delivery/info/) — `POST /api_v1_system_delivery/info` --- # 拠点マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_warehouse_base/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_warehouse_base/count Tag: 拠点マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_warehouse_base/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 拠点 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 拠点名 | `warehouse_name` | 文字列型 | | | 作成日 | `warehouse_creation_date` | 日時型 | 拠点の作成日 | | 最終更新日 | `warehouse_last_modified_date` | 日時型 | 拠点マスタの最終更新日 | | 作成担当者ID | `warehouse_creator_id` | 数値型 | 拠点の作成担当者ID | | 作成担当者名 | `warehouse_creator_name` | 文字列型 | 拠点の作成担当者名 | | 最終更新者ID | `warehouse_last_modified_by_id` | 数値型 | 拠点マスタの最終更新者ID | | 最終更新者名 | `warehouse_last_modified_by_name` | 文字列型 | 拠点マスタの最終更新者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' https://api.next-engine.org/api_v1_warehouse_base/count ``` レスポンス ```json { "result": "success", "count": "2", "access_token": "xxx", "access_token_end_date": "2023-04-18 12:18:59", "refresh_token": "xxx", "refresh_token_end_date": "2023-04-20 12:18:59" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_warehouse_base_count/`](/api/operations/api_v1_warehouse_base_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (拠点マスタ) - [拠点マスタ検索](/api/api_v1_warehouse_base/search/) — `POST /api_v1_warehouse_base/search` --- # 拠点マスタ検索 URL: https://developer.next-engine.com/api/api_v1_warehouse_base/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_warehouse_base/search Tag: 拠点マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_warehouse_base/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 拠点 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 拠点名 | `warehouse_name` | 文字列型 | | | 作成日 | `warehouse_creation_date` | 日時型 | 拠点の作成日 | | 最終更新日 | `warehouse_last_modified_date` | 日時型 | 拠点マスタの最終更新日 | | 作成担当者ID | `warehouse_creator_id` | 数値型 | 拠点の作成担当者ID | | 作成担当者名 | `warehouse_creator_name` | 文字列型 | 拠点の作成担当者名 | | 最終更新者ID | `warehouse_last_modified_by_id` | 数値型 | 拠点マスタの最終更新者ID | | 最終更新者名 | `warehouse_last_modified_by_name` | 文字列型 | 拠点マスタの最終更新者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=warehouse_id,warehouse_name&warehouse_id-eq=1&offset=0&limit=100' https://api.next-engine.org/api_v1_warehouse_base/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "warehouse_id": "1", "warehouse_name": "拠点A" } ], "access_token": "xxx", "access_token_end_date": "2023-04-18 17:24:28", "refresh_token": "xxx", "refresh_token_end_date": "2023-04-20 17:24:28" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_warehouse_base_search/`](/api/operations/api_v1_warehouse_base_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (拠点マスタ) - [拠点マスタ件数取得](/api/api_v1_warehouse_base/count/) — `POST /api_v1_warehouse_base/count` --- # 拠点在庫マスタ件数取得 URL: https://developer.next-engine.com/api/api_v1_warehouse_stock/count/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_warehouse_stock/count Tag: 拠点在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_warehouse_stock/count` ## リファレンス内容 ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | ### 拠点在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_stock_warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 商品コード | `warehouse_stock_goods_id` | 文字列型 | | | 在庫数 | `warehouse_stock_quantity` | 数値型 | | | 引当数 | `warehouse_stock_allocation_quantity` | 数値型 | | | フリー在庫数 | `warehouse_stock_free_quantity` | 数値型 | | | 作成日 | `warehouse_stock_creation_date` | 日時型 | | | 最終更新日 | `warehouse_stock_last_modified_date` | 日時型 | | | 最終更新日 | `warehouse_stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `warehouse_stock_creator_id` | 数値型 | | | 作成担当者名 | `warehouse_stock_creator_name` | 文字列型 | | | 最終更新者ID | `warehouse_stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `warehouse_stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `warehouse_stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `warehouse_stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' https://api.next-engine.org/api_v1_warehouse_stock/count ``` レスポンス ```json { "result": "success", "count": "4", "access_token": "xxx", "access_token_end_date": "2023-04-20 11:41:34", "refresh_token": "xxx", "refresh_token_end_date": "2023-04-22 11:41:34" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_warehouse_stock_count/`](/api/operations/api_v1_warehouse_stock_count/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (拠点在庫マスタ) - [拠点在庫マスタ検索](/api/api_v1_warehouse_stock/search/) — `POST /api_v1_warehouse_stock/search` - [拠点在庫マスタアップロード](/api/api_v1_warehouse_stock/upload/) — `POST /api_v1_warehouse_stock/upload` --- # 拠点在庫マスタ検索 URL: https://developer.next-engine.com/api/api_v1_warehouse_stock/search/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_warehouse_stock/search Tag: 拠点在庫マスタ Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_warehouse_stock/search` ## リファレンス内容 ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します ### 拠点在庫マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 拠点ID | `warehouse_stock_warehouse_id` | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 | | 商品コード | `warehouse_stock_goods_id` | 文字列型 | | | 在庫数 | `warehouse_stock_quantity` | 数値型 | | | 引当数 | `warehouse_stock_allocation_quantity` | 数値型 | | | フリー在庫数 | `warehouse_stock_free_quantity` | 数値型 | | | 作成日 | `warehouse_stock_creation_date` | 日時型 | | | 最終更新日 | `warehouse_stock_last_modified_date` | 日時型 | | | 最終更新日 | `warehouse_stock_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `warehouse_stock_creator_id` | 数値型 | | | 作成担当者名 | `warehouse_stock_creator_name` | 文字列型 | | | 最終更新者ID | `warehouse_stock_last_modified_by_id` | 数値型 | | | 最終更新者ID | `warehouse_stock_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `warehouse_stock_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `warehouse_stock_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=warehouse_stock_warehouse_id,warehouse_stock_goods_id,warehouse_stock_quantity&warehouse_stock_warehouse_id-eq=1&offset=0&limit=100' https://api.next-engine.org/api_v1_warehouse_stock/search ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "warehouse_stock_warehouse_id": "1", "warehouse_stock_goods_id": "code1", "warehouse_stock_quantity": "10", "warehouse_stock_allocation_quantity": "2", "warehouse_stock_free_quantity": "8" } ], "access_token": "xxx", "access_token_end_date": "2023-04-20 11:41:34", "refresh_token": "xxx", "refresh_token_end_date": "2023-04-22 11:41:34" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_warehouse_stock_search/`](/api/operations/api_v1_warehouse_stock_search/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (拠点在庫マスタ) - [拠点在庫マスタ件数取得](/api/api_v1_warehouse_stock/count/) — `POST /api_v1_warehouse_stock/count` - [拠点在庫マスタアップロード](/api/api_v1_warehouse_stock/upload/) — `POST /api_v1_warehouse_stock/upload` --- # 拠点在庫マスタアップロード URL: https://developer.next-engine.com/api/api_v1_warehouse_stock/upload/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_warehouse_stock/upload Tag: 拠点在庫マスタ Required parameters: access_token, data_type, data Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_warehouse_stock/upload` ## リファレンス内容 ### 拠点在庫マスタ予約一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は商品管理の一括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | csv:拠点在庫マスタCSV,gz:拠点在庫マスタCSVをGZIPで圧縮 | | `data` | 拠点在庫マスタCSVのファイル内容（3000件まで） | 必須 | メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8） | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&data_type=csv&data=kyoten_mei,syohin_code,kasan_su,nyusyukko_riyu 拠点A,test-0001,3,在庫数調整のため 拠点B,test-0002,4,在庫数調整のため' https://api.next-engine.org/api_v1_warehouse_stock/upload ``` レスポンス ```json { "result": "success", "que_id": "5", "access_token": "xxx", "access_token_end_date": "2023-05-01 14:19:22", "refresh_token": "xxx", "refresh_token_end_date": "2023-05-03 14:19:22" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/api_v1_warehouse_stock_upload/`](/api/operations/api_v1_warehouse_stock_upload/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (拠点在庫マスタ) - [拠点在庫マスタ件数取得](/api/api_v1_warehouse_stock/count/) — `POST /api_v1_warehouse_stock/count` - [拠点在庫マスタ検索](/api/api_v1_warehouse_stock/search/) — `POST /api_v1_warehouse_stock/search` --- # NEログインuid・state取得 URL: https://developer.next-engine.com/api/users/sign_in/ ## リクエストURL ホスト `https://base.next-engine.org` エンドポイント `/users/sign_in/` ## リファレンス内容 ### uid・state取得について 本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です 入力パラメータはGET、出力パラメータは入力パラメータで指定したredirect_uriへのリダイレクト(GET)になります。 アプリを起動したユーザーのログイン状態により以下の違いがあります - 未ログインの場合は、ユーザーにログイン画面が表示される - ログイン済みの場合は、ユーザーの入力が必要ない 上記の後に、入力パラメータで指定したredirect_uriにリダイレクトされます ユーザーがログイン画面でログインしなかった場合は制御がアプリ側に戻りません ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | 不可 | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する | | `redirect_uri` | ネクストエンジンへのログイン後、リダイレクトするuriを指定する | 可能(ネクストエンジンのアプリを作る->APIのRedirect URIになる) | ネクストエンジンのアプリを作る->APIのRedirect URIのホスト以外を指定することは出来ない | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | uid | アプリを起動したユーザーのuid | | | `state` | アプリを起動したユーザーのstate | stateには有効期限があります。有効期限が切れた場合は再度本APIを呼ぶ必要があります | | 入力パラメータに渡したパラメータ | | 上記パラメータ以外に、入力パラメータに渡したパラメータがそのまま返却されます | ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/api/operations/users_sign_in/`](/api/operations/users_sign_in/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` --- # 更新履歴 URL: https://developer.next-engine.com/changelog/ ネクストエンジン API の変更・追加履歴です。 ## 2026 年 ### 2026/5/14 受注伝票の同梱に関する2つのエンドポイントを追加しました。 - [「受注伝票一括同梱」](/api/api_v1_receiveorder_base/bundle) - [「受注伝票 同梱候補グループ取得」](/api/api_v1_receiveorder_base/bundle_candidate_groups) ### 2026/5/12 [「受注伝票検索」](/api/api_v1_receiveorder_base/search)のAPIに以下のフィールドを追加しました。 - 置き配フラグ（`receive_order_unattended_delivery_flg`） - 置き配場所名称（`receive_order_unattended_delivery_location_name`） これらのフィールドは参照のみ対応しており、更新APIからの変更はできません。 ## 2025 年 ### 2025/8/14 商品コード紐づけ件数取得・検索のAPIを追加しました。 - [「商品コード紐づけ件数取得」](/api/api_v1_master_goodsmapping/count) - [「商品コード紐づけ検索」](/api/api_v1_master_goodsmapping/search) ## 2024 年 ### 2024/8/27 [「店舗作成」](/api/api_v1_master_shop/create)と[「店舗更新」](/api/api_v1_master_shop/update)のAPIに入力パラメータshop_enabled_invoiceを追加しました。 このフラグを有効にすると、店舗にインボイス形式を適用するかを制御できます。 ## 2023 年 ### 2023/12/1 [「受注伝票更新」](/api/api_v1_receiveorder_base/update)と[「受注伝票一括更新」](/api/api_v1_receiveorder_base/bulkupdate)のAPIに入力パラメータreceive_order_recalculate_flagを追加しました。 このフラグを有効にすると、受注伝票の金額系項目を再計算するかを制御できます。 ### 2023/9/21 受注税金内訳取得のAPIを追加しました。 - [「受注税金内訳取得」](/api/api_v1_receiveorder_tax_account/search) ### 2023/9/21 [「受注伝票更新」](/api/api_v1_receiveorder_base/update)と[「受注伝票一括更新」](/api/api_v1_receiveorder_base/bulkupdate)のAPIの受注伝票フィールドに、以下の項目を追加しました。 - 請求金額（0%） - 請求金額（8%） - 請求金額（10%） - 請求額に対する税額（8%） - 請求額に対する税額（10%） - 手数料（0%） - 手数料（8%） - 手数料（10%） - 他費用（0%） - 他費用（8%） - 他費用（10%） - クーポン割引額（0%） - クーポン割引額（8%） - クーポン割引額（10%） - クーポン割引額（按分） - ポイント（0%） - ポイント（8%） - ポイント（10%） - ポイント（按分） - ポイント（支払い） ### 2023/8/21 [「企業情報取得」](/api/api_v1_login_company/info)のAPIに以下のフィールドを追加しました。 - 値引きの優先適用先 - 適格請求書発行事業者の登録番号 ### 2023/5/24 拠点在庫アップロードのAPIを追加しました。 - [「拠点在庫マスタアップロード」](/api/api_v1_warehouse_stock/upload) ### 2023/4/24 [「受注明細件数取得」](/api/api_v1_receiveorder_row/count)と[「受注明細検索」](/api/api_v1_receiveorder_row/search)のAPIに以下のフィールドを追加しました。 - 拠点ID - 拠点名 - 作成日 - 最終更新日 - 作成担当者ID - 作成担当者名 - 最終更新者ID - 最終更新者名 ### 2023/4/23 拠点に関連するAPIを追加しました。 - [「拠点マスタ件数取得」](/api/api_v1_warehouse_base/count) - [「拠点マスタ検索」](/api/api_v1_warehouse_base/search) - [「拠点在庫マスタ件数取得」](/api/api_v1_warehouse_stock/count) - [「拠点在庫マスタ検索」](/api/api_v1_warehouse_stock/search) ## 2022 年 ### 2022/11/28 [「商品マスタ検索」](/api/api_v1_master_goods/search)のAPIに以下のフィールドを追加しました。 - パッケージ込みの高さ(cm) - パッケージ込みの幅(cm) - パッケージ込みの奥行き(cm) - パッケージ込みの重さ(g) - 販売開始日 - 販売終了日 - 消費税 - ブランド名 - 原産地 - 原材料 - 保存方法 - 保証書の有無 - のし対応 - 当日・翌日配送 ### 2022/11/15 （旧）商品ページ管理は2023/02/28で提供を終了します。 [移行後](https://manual.next-engine.net/main/page/pg_kanren/page-kanri/page-kanri_settei/50387/)は[商品ページ関連のエンドポイント](/api/api_v1_master_goods_page/search)をお使いください。 - [「（旧）商品ページ（基本）件数取得」](/api/api_v1_master_pagebase/count) - [「（旧）商品ページ（基本）検索」](/api/api_v1_master_pagebase/search) - [「（旧）商品ページ（基本-項目選択肢又はオプション）件数取得」](/api/api_v1_master_pagebasevariationoroption/count) - [「（旧）商品ページ（基本-項目選択肢又はオプション）検索」](/api/api_v1_master_pagebasevariationoroption/search) ### 2022/9/29 セット商品に関連するAPIを追加しました。 - [「セット商品マスタ件数取得」](/api/api_v1_master_setgoods/count) - [「セット商品マスタ検索」](/api/api_v1_master_setgoods/search) - [「セット商品マスタアップロード」](/api/api_v1_master_setgoods/upload) - [「セット在庫マスタ件数取得」](/api/api_v1_master_setstock/count) - [「セット在庫マスタ検索」](/api/api_v1_master_setstock/search) ## 2021 年 ### 2021/9/29 商品ページに関連するAPIを追加しました - 「[商品ページ件数取得](/api/api_v1_master_goods_page/count)」 - 「[商品ページ検索](/api/api_v1_master_goods_page/search)」 - 「[商品ページ(バリエーション)件数取得](/api/api_v1_master_goods_page_variation/count)」 - 「[商品ページ(バリエーション)検索](/api/api_v1_master_goods_page_variation/search)」 - 「[商品ページ(オプション)件数取得](/api/api_v1_master_goods_page_option/count)」 - 「[商品ページ(オプション)検索](/api/api_v1_master_goods_page_option/search)」 - 「[商品ページ(カテゴリ)件数取得](/api/api_v1_master_goods_page_shopcategory/count)」 - 「[商品ページ(カテゴリ)検索](/api/api_v1_master_goods_page_shopcategory/search)」 ### 2021/8/30 https接続時のSSLポリシーについて追記しました。 ### 2021/5/12 [パラメータ比較演算子](/api/param/operator_compare)に新しい演算子-nlikeornullが追加されました ## 2020 年 ### 2020/7/8 - [納品書印刷済み一括更新API](/api/api_v1_receiveorder_base/bulkupdatereceipted)が追加されました - 「[発注伝票件数取得](/api/api_v1_placeorder_base/count)」、「[発注伝票検索](/api/api_v1_placeorder_base/search)」、「[発注明細件数取得](/api/api_v1_placeorder_row/count)」、「[発注明細検索](/api/api_v1_placeorder_row/search)」が追加されました ## 2019 年 ### 2019/9/4 更新内容は以下の通りです。 「[受注明細エンドポイント](/api/api_v1_receiveorder_row/count)」「[商品マスタエンドポイント](/api/api_v1_master_goods/count)」のAPIに消費税率（%）のフィールドが追加されました。 ### 2019/6/19 - [受注伝票一括更新API](/api/api_v1_receiveorder_base/update)と[受注伝票更新API](/api/api_v1_receiveorder_base/bulkupdate)の入力パラメータにreceive_order_row_cancel_update_flagが追加されました。 このフラグを有効にすると伝票をキャンセルから有効にしたときに明細も有効にするかを制御できます。 - 受注メール取込済の伝票に対して受注分類タグの更新が可能になりました。 ### 2019/3/28 SDK-PHPを更新しました（ver1.3）。 更新内容は以下の通りです。 ネクストエンジンAPIサーバーへのリクエスト時にTCP Keep Aliveを設定 公開リポジトリ（[https://github.com/hamee-dev/sdk-php](https://github.com/hamee-dev/sdk-php)）をご確認下さい。 ### 2019/3/27 SDK-PHPを更新しました（ver1.2）。 更新内容は以下の通りです。 composerでインストール出来るように対応 公開リポジトリ（[https://github.com/hamee-dev/sdk-php](https://github.com/hamee-dev/sdk-php)）をご確認下さい。 ### 2019/2/20 [SDK-Java](/api/sdk)を更新しました（ver1.1.1）。 更新内容は以下の通りです。 - 一部エンドポイントに正しくアクセスできない不具合を修正。（その他、セキュリティに関するアップデートを含みます） 公開リポジトリ（[https://github.com/hamee-dev/sdk-java](https://github.com/hamee-dev/sdk-java)）をご確認下さい。 ### 2019/2/13 [単独機能](/tutorial/single-function-sample)に関するページが追加されました。 [拡張機能](/tutorial/extension-function-sample)に関するページが更新されました。 更新内容は以下の通りです。 - マニュアルURL・開き方・設定画面有無を単独機能アプリにも設定可能になりました。 - 単独機能アプリにサブメニューが設定可能になり、起動時に選択できるようにりました。 - 単独機能アプリに機能分類が設定可能になり、設定したときにメイン機能のメニューに表示されるようになりました。 ### 2019/1/29 以下の変更をしました。 - [リファレンス](api/start)レイアウトの変更 - [FAQ](faq)ページリニューアル ## 2018 年 ### 2018/8/22 - [チュートリアル＞拡張機能](/tutorial/extension-function-sample)の情報が追加されました - [受注伝票一括更新API](/api/api_v1_receiveorder_base/bulkupdate)が追加されました - [受注分類タグ検索API](/api/api_v1_receiveorder_groupingtag/search)が追加されました - 「[実行結果お知らせ追加API](/api/api_v1_notice_execution/add)」、「[実行結果お知らせ検索API](/api/api_v1_notice_execution/search)」、「[実行結果お知らせ件数取得API](/api/api_v1_notice_execution/count)」が追加されました - [受注伝票検索](/api/api_v1_receiveorder_base/search)/[件数取得](/api/api_v1_receiveorder_base/count)のAPIに「拡張機能実行ID」の入力パラメータが追加されました - 「[受注キャンセル区分情報取得](/api/api_v1_system_canceltype/info)」「[発送方法区分情報取得](/api/api_v1_system_delivery/info)」「[支払区分情報取得](/api/api_v1_system_paymentmethod/info)」のAPIに非表示フラグのフィールドが追加されました ### 2018/7/5 以下のAPIリファレンスの情報を更新しました。 ・[NEログインuid・state取得](/api/users/sign_in) 　パラメータclient_secretが不要になりました。 ・[NEログインaccess_token取得](/api/api_neauth) 　パラメータclient_id, client_secretを追加しました。 　※ 2018/11/1以降, client_id, client_secretは必須となります。 ・[APIの更新に対応したSDK(ver1.1)](/sdk)を追加しました。 ## 2017 年 ### 2017/12/7 [仕入伝票件数取得](/api/api_v1_supplyorder_base/count)、[仕入伝票検索](/api/api_v1_supplyorder_base/search)、[仕入明細件数取得](/api/api_v1_supplyorder_row/count)、[仕入明細検索](/api/api_v1_supplyorder_row/search)のAPIを追加しました。 ### 2017/9/8 [ネクストエンジンAPIの認証について](/api/auth)を更新しました。更新内容は次のとおりです。 アプリ起動時にuidとstateの他にidがGETパラメータで渡るようになった件について記載しました。 ### 2017/8/7 [ネクストエンジンアプリ基盤（FuelPHP版）](https://github.com/hamee-dev/app-template-fuel/pull/2)を更新しました。更新内容は次のとおりです。 - マルチプロセスで動作時に古いアクセストークンで更新してしまう不具合を解消 usersテーブルに「access_token_end_date」（ アクセストークン有効期限日時）というカラムを追加しています。 マイグレーションファイルがあるので、マイグレーションを実行する必要があります。 `$ php oil r migrate --packages=base` ### 2017/6/16 [ネクストエンジンアプリ基盤](https://github.com/hamee-dev/app-template-fuel)を更新しました。更新内容は次のとおりです。 - タスクにFatal errorのハンドラーを追加する。 ### 2017/5/25 APIリファレンスの情報を更新しました。 - 店舗マスタに[受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress)のエンドポイントを追加しました。 - [メッセージ一覧](/api/param/message)に受注情報取り込み用メールアドレス取得で使用されるメッセージ[018001]~[018004]を追加しました。 ### 2017/5/25 [利用企業一覧](/api/api_app/company)で「ネクストエンジン企業ID（company_ne_id）」が取得できるようになりました。 ### 2017/5/17 フォーラムに非公開の投稿機能を追加しました。 非公開の投稿とは、ネクストエンジンアプリ開発者がネクストエンジンの運営者に対して直接質問を投稿できる機能です。 例えば個人情報や認証情報などフォーラムでオープンには取り扱えないものを含むことを質問できます。 詳しい使い方は[ご利用ガイドライン](/forum/guideline)をご覧ください。 ### 2017/3/30 ログインユーザー情報取得（/api_v1_login_user/info）のレスポンスのフィールドを変更しました。 変更点： - ニュース確認日（pic_news_check_date） をレスポンスから削除しました。 ### 2017/3/23 メイン機能のお知らせ機能改修に伴い、ログインユーザー情報取得（/api_v1_login_user/info）のレスポンスのフィールドを変更します。 変更点： - ニュース確認日（pic_news_check_date） をレスポンスから削除します。 お手数ですが、ネクストエンジンアプリで該当のフィールドを使用している場合はこの値を使用しないように修正をお願い致します。 実施予定日： 2017/03/30 ### 2017/1/26 [SDK(PHP)](/sdk#php)にストレージAPIの処理とサンプルプログラムを追加しました。 ### 2017/1/26 ストレージAPIを公開に伴い以下の情報を更新しました。 - [リクエストURL一覧](/api)にストレージの項目を追加しました。 - 機能別入出力パラメータ一覧に[ファイルアップロード](/api/param/storage_upload)・[ファイルダウンロード](/api/param/storage_download)・[ファイル一覧取得](/api/param/storage_search)を追加しました。 - 分類別フィールド一覧に[ストレージ](/api/fields/storage_storage)を追加しました。 - [メッセージ一覧](/api/param/message)に、ストレージAPIのメッセージを追加しました。 ### 2017/1/4 以下のフィールド名に対する項目名が誤っていたため、項目名を正しいものに修正しました。 [商品カテゴリ](/api/fields/master_goods_category)の「goods_category_id」の項目名「商品画像分類タグ」→「商品カテゴリID」 [受注明細](/api/fields/receiveorder_row)の「receive_order_row_copy_from_row_no」の項目名「複数配送親伝票番号」→「複写元明細行番号」 ## 2016 年 ### 2016/12/9 [商品マスタ](api/fields/master_goods)の発送方法区分の備考に説明を追加しました。 ### 2016/12/2 サイドメニューにDeveloper Network を追加しました。 ### 2016/9/26 [リクエストURL一覧](/api)に[商品別卸先マスタ](/api/fields/master_goods_wholesale)を追加しました。 ### 2016/9/13 [メッセージ一覧](/api/param/message)に、メイン機能毎に発生するメンテナンスのメッセージコードを追加しました。 ### 2016/5/5 [受注伝票更新API](/api/param/update_receive_order#note)の更新仕様に、受注メール取込済の伝票が更新できるフィールドを追加しました。 ### 2016/4/7 [リクエストURL一覧](/api)に[納期](/api/fields/system_delivery_date)を追加しました。 ### 2016/4/6 [メッセージ一覧](/api/param/message)に[件数取得API](/api/param/count)・[検索API](/api/param/search)で実行時間が長すぎる場合のメッセージ[004004]を追加しました。 ### 2016/1/6 [受注伝票](/api/fields/receiveorder_base)、[受注明細](/api/fields/receiveorder_row)に分割元、複写元の情報を追加しました。2016/01/05以降に分割・複写された受注のみ設定されています ## 2015 年 ### 2015/12/16 [受注伝票](/api/fields/receiveorder_base)の検索時、[受注伝票オプション](/api/fields/receiveorder_option)のフィールドも指定すると、2012/05/21より前に作成された受注伝票が検索出来ない不具合を修正しました ### 2015/11/24 [受注伝票オプション](/api/fields/receiveorder_option)に、受注時店舗原資クーポン、受注時モール原資クーポンを追加しました。本日以降に取り込まれた楽天の受注のみ設定されます ### 2015/11/5 [受注伝票分割](/api/param/divide_receive_order)で、入力パラメータdataのreceive_order_row_noタグに2桁の数値を指定できない不具合を修正しました。 ### 2015/10/28 [支払発送変換](/api/fields/receiveorder_payment_delivery_convert)の件数取得・検索を追加しました。 ### 2015/10/26 [受注伝票更新API](/api/param/update_receive_order)に納品書発行日、クレジット支払い回数、出荷予定日を指定可能にしました。 ### 2015/10/2 [PHPのSDK](/sdk#php)を更新しました（アプリ-各サーバ間の通信失敗時の例外内容を、具体的にしました）。 ### 2015/10/1 受注明細検索で商品マスタを指定できるようにしました。また商品マスタ検索で商品画像を指定できるようにしました。 ### 2015/10/1 [商品マスタ](/api/fields/master_goods)にヒット商品お知らせ個数、納期ID、納期指定日の項目を追加しました。 ### 2015/9/16 [受注伝票更新API](/api/param/update_receive_order)に納品書特記事項を指定可能にしました。 ### 2015/8/12 各APIの出力パラメータに、access_token・refresh_tokenの有効期限切れ日時を追加しました。 ### 2015/7/28 [受注伝票更新API](/api/param/update_receive_order)に受注確認内容を指定可能にしました。 ### 2015/6/30 [受注伝票オプション](/api/fields/receiveorder_option)の件数取得・検索を追加しました。 ### 2015/6/30 [受注伝票更新API](/api/param/update_receive_order)に[受注伝票オプション](/api/param/update_receive_order#note_option)を指定可能にしました。 ### 2015/6/18 [受注確認内容更新](/api/param/update_confirm)を追加しました。 ### 2015/3/19 [受注伝票分割](/api/param/divide_receive_order)を追加しました。 ### 2015/3/17 [ネクストエンジンAPIの使い方](http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd)を追加しました。 ### 2015/3/2 [卸先マスタ](/api/fields/master_wholesale)を追加しました。 ### 2015/2/23 [受注確認内容](/api/fields/receiveorder_confirm)を追加しました。 ### 2015/2/17 [サンプル（FuelPHP）](http://api.next-e.jp/sample-fuelphp/)のドキュメントを公開しました。 ### 2015/2/6 [refresh_tokenの説明](/api/refresh_token)を追加しました。 ### 2015/2/5 本マニュアルのサイト内検索を追加しました。 ### 2015/2/5 メイン機能の商品情報にカテゴリが保持出来るようになりました。それに伴い商品カテゴリ、モールカテゴリの件数取得・検索を追加しました。 ### 2015/2/5 メイン機能の商品情報に画像が保持出来るようになりました。それに伴い商品画像、商品画像分類タグ、画像分類タグの件数取得・検索を追加しました。。 ### 2015/2/5 メイン機能の[商品マスタ](/api/fields/master_goods)に商品ページに関する情報が保持出来るようになりました。それに伴い商品説明（HTML）、商品説明（テキスト）、スペック（HTML）、スペック（テキスト）、注意事項（HTML）、注意事項（テキスト）、商品状態区分、商品状態説明をフィールドに追加しました。 ### 2015/2/3 モールの[件数取得/検索](/api)に、例外的にmall_id-inのパラメータが指定出来ない(無視する)旨を追記しました。 ### 2015/1/15 [受注伝票更新API](/api/param/update_receive_order)に、受注状態が出荷確定済でも更新するフラグを入力パラメータに追加しました。 ### 2015/1/6 検索時の[比較演算子](/api/param/operator_compare)の-in,-ninは、最大1000個までの制限を追加しました ## 2014 年 ### 2014/11/13 [企業](/api/fields/login_company)のフィールドに「現在の税率」を追加しました ### 2014/11/10 アプリの[利用企業一覧](/api/param/app_company)を取得するAPIを追加しました それに伴いPHP,JAVA SDKにネクストエンジンログインなしでAPIを実行するapiExecuteNoRequiredLoginを追加しました ### 2014/11/10 アプリの[利用企業一覧](/api/param/app_company)を取得するAPIを追加しました ### 2014/11/7 メイン機能が過負荷の場合、可能な限りエラーにせず実行するフラグ[待機フラグ](/api/param/common#wait_flag)を追加しました ### 2014/9/18 メイン機能の以下の項目が店舗設定から企業設定に移動します。その為[店舗作成](/api/param/create_shop)で指定出来なくしました(企業情報更新APIは未提供です)。 対象項目：「ヤマト請求先顧客コード」、「西濃荷送人コード」、「福山荷送人コード」。 ### 2014/9/17 [PHPのSDK](/sdk#php)を更新しました（インスタンス生成時、redirect_uriを省略(又はNULL)するとエラーになってしまう不具合修正）。 ### 2014/8/27 [店舗接続確認](/api/param/checkconnect_shop)、[店舗作成](/api/param/create_shop)、[店舗更新](/api/param/update_shop)を追加しました。 受注編集、マスタ編集のアクセス情報のチェックに不具合があった為、修正しました。 ### 2014/8/20 「配送情報出力対象」の受注伝票に対して同じ「配送情報出力対象」にした場合エラーではなく正常終了するように修正しました。その為、以下を修正しました。 [メッセージ一覧](/api/param/message)から[納品書印刷済みAPI](/api/param/receipted_receive_order)のメッセージ[008012]を削除しました。 [メッセージ一覧](/api/param/message)から[配送情報出力済みAPI](/api/param/labelprinted_receive_order)のメッセージ[010011]を削除しました。 ### 2014/8/19 [納品書印刷済みAPI](/api/param/receipted_receive_order)に、ラベル発行フラグを更新する入力パラメータを追加しました。 [メッセージ一覧](/api/param/message)に納品書印刷済みでラベル発行フラグを更新した場合のメッセージ[008012][008013]を追加しました。 ### 2014/7/31 [メッセージ一覧](/api/param/message)のエラー内容ごとに復帰の見込みがあるか追記しました。 ### 2014/7/31 一度認証したユーザーは、以後認証なしでネクストエンジンAPIを使い続けられることが出来る「refresh_token」を公開しました。今まで通りの認証方式でそのままご利用出来ますが、「refresh_token」も合わせて利用することを推奨致します。詳細は[こちら](/api/refresh_token)を参照下さい ### 2014/7/28 [メッセージ一覧](/api/param/message)に納品書印刷済みで納品書印刷指示日が指定されている場合のメッセージ[008011]を追加しました。 ### 2014/7/22 「2014/07/18～2014/07/22」の「23:00～12:00」の時間帯にAPIを利用すると003001のエラーになってしまっていた不具合を修正致しました。 ### 2014/6/16 受注伝票の[配送情報出力済み](/api/param/labelprinted_receive_order)、入力パラメータに「ラベル発行フラグ」を追加しました。 受注伝票の[配送情報出力済み](/api/param/labelprinted_receive_order)、ラベル発行フラグの出力済みにできる条件を修正しました。 [メッセージ一覧](/api/param/message)に配送情報出力済みのメッセージ[010010]を追加しました。 ### 2014/6/4 受注伝票の[受注伝票更新](/api/param/update_receive_order)を追加しました。 [メッセージ一覧](/api/param/message)に受注伝票更新のメッセージを追加しました。 ### 2014/5/27 [メッセージ一覧](/api/param/message)にネクストエンジンサーバーがメンテナンス中の場合のメッセージ[002007]を追加しました。 ### 2014/5/26 [メッセージ一覧](/api/param/message)のメッセージ「受注取込中か棚卸中のため、更新出来ません。」を「受注取込中のため、更新出来ません。」と「棚卸中のため、更新出来ません。」の2つのメッセージに分けました。 対象は受注伝票の[納品書印刷済み](/api/param/receipted_receive_order)、[出荷確定処理](/api/param/shiped_receive_order)、[配送情報出力済み](/api/param/labelprinted_receive_order)です。 ### 2014/5/22 受注伝票の[納品書印刷済み](/api/param/receipted_receive_order)、[出荷確定処理](/api/param/shiped_receive_order)、[配送情報出力済み](/api/param/labelprinted_receive_order)へ、処理の条件について追加しました。 ### 2014/5/15 受注伝票の[納品書印刷済み](/api/param/receipted_receive_order)、[出荷確定処理](/api/param/shiped_receive_order)、[配送情報出力済み](/api/param/labelprinted_receive_order)を追加しました。 ### 2014/5/8 [受注一括登録機能](/api/param/upload_receive_order)を追加しました。それに伴い[受注一括登録パターン](/api/fields/receiveorder_receive_order_upload_pattern),[店舗マスタ](/api/fields/master_shop),[オーソリ区分](/api/fields/system_authorizationtype),[通貨単位区分](/api/fields/system_currencyunit),[モール](/api/fields/system_mall)の検索・情報取得を追加しました。 ### 2014/4/1 [PHPのSDK](/sdk#php)を更新しました（access_token取得後もGETパラメータにuid及びstateの設定が必要になってしまっている不具合修正）。 ### 2014/3/26 [PHPのSDK](/sdk#php)を更新しました（cURLに失敗した際のエラー処理の不具合修正）。 ### 2014/3/5 バッチ処理についてのページを追加しました。 ### 2014/1/8 [商品マスタ](/api/fields/master_goods)のフィールドに項目１１～２０を追加しました。 ## 2013 年 ### 2013/12/27 受注明細の検索で、商品名を指定すると商品コードが取得されてしまう不具合を修正しました。 ### 2013/12/24 [PHPのSDK](/sdk#php)に、対応PHPVersionを記述しました。 ### 2013/12/24 [PHPのSDK](/sdk#php)を更新しました（通信をgzipで圧縮する）。 ### 2013/12/24 [在庫入出庫履歴](/api/fields/master_stockiohistory)のフィールドにIDを追加しました。 ### 2013/12/18 PHPのサンプルソースに、商品マスタ予約一括登録機能の使用例を追加しました。 ### 2013/12/16 各最終更新日・最終更新者がNULLの場合、作成日・作成者の情報を返すパラメータを追加しました。 ### 2013/12/16 [受注明細](/api/fields/receiveorder_row)に受注伝票と受注明細の内、より新しい方の最終更新日を返すパラメータを追加しました。 ### 2013/12/10 [商品マスタ予約一括登録機能](/api/param/upload_goods)を追加しました。それに伴い在庫マスタの更新機能を削除しました。在庫数の加減算は商品マスタ予約一括登録機能から実行可能です。 ### 2013/12/5 [メッセージ一覧](/api/param/message)にメイン機能サーバーがメンテナンス中の場合のメッセージ[003004]を追加しました。 ### 2013/10/31 新規作成 --- # client_id / client_secret URL: https://developer.next-engine.com/faq/01-client-id-secret/ ネクストエンジン API の「client_id / client_secret」に関するよくある質問です。 ## client_id、client_secretとはなんですか？ ネクストエンジンAPIのアプリごとに発行されるIDとパスワードのようなものです。 アプリ毎に異なる値が割り振られ、ネクストエンジンがアプリの識別に利用します。 認証情報のため、第3者へ漏らさないよう取扱にはご注意ください。 ## 本番環境用のclient_id、client_secretはいつから利用可能になりますか？ アプリが「販売中」になったタイミングでご利用可能になります。 ご利用不可の状態だと、client_id、client_secretが 赤字に、利用可能な状態だと黒字になっていますのでご注意ください。 ## client_id、client_secretはどこから確認すればよいでしょうか？ ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブの中に本番環境と開発環境の設定が表示されます。 同じ画面内に本番環境設定とテスト環境設定があります [本番環境設定]の下に表示されている[テスト環境設定]の「client_id」、「client_secret」をご利用ください ## テスト環境にAPI接続するためのclient_id、client_secretはどの様に発行して頂けるのでしょうか アプリを作成いただき、操作欄「編集」->「API」タブよりご覧いただけます。 テスト環境はリダイレクトURLを設定していただきますと、 クライアントIDおよびクライアントシークレットが自動で生成されます。 本番環境に関しましては、審査が必要となってまいります。 --- # access_token / refresh_token URL: https://developer.next-engine.com/faq/02-access-token/ ネクストエンジン API の「access_token / refresh_token」に関するよくある質問です。 ## エラーが発生した場合access_tokenとrefresh_tokenは返ってきますか？ 返却される[メッセージコード](api/param/message)によります。 resultがerrorの場合でも, 基本的には有効なaccess_token, refresh_tokenを返します。 ただし, リクエストされたaccess_token, refresh_tokenが不正の場合(エラーコード: 002002, 002004), 一部のシステムエラー(エラーコード: 999999)の場合は有効なaccess_token, refresh_tokenを返しません。 ## ログイン画面を開かずに、access_tokenを取得する方法はありませんか？ 申し訳ございませんが、ネクストエンジンAPIはWebアプリケーションを想定した仕組みのため、初回は必ずログイン画面にてネクストエンジンIDとパスワードでの認証が必要になります。 ## access tokenが有効期限切れ、refresh tokenが期限内という状態でリクエストした場合どうなりますか？ 初回のリクエストのみエラーにはならず、新しいaccess tokenとrefresh tokenが発行されます。 この時に発行されるaccess tokenとrefresh tokenを保持しておけば、以降のリクエストは正常レスポンスが返却されます。 ただ、この時のaccess tokenとrefresh tokenを保持せず、今までのaccess tokenとrefresh tokenでリクエストするとエラーレスポンス(002002: access_token[xxxxx]が不正です。)が返却されます。 ## access_tokenの更新タイミングについて教えてください。 認証の度に更新されるのではなく、access_token有効期限が切れている場合にいタイミングで更新されます。 例えばaccess_tokenの有効期限が10:00までだった場合、以下のようになります。 　a. 09:50 アクセストークンAでリクエスト 　b. 10:01 アクセストークンAでリクエスト ← ここで更新されたトークン情報(アクセストークンB)が返却されます。 　c. 10:02 アクセストークンBでリクエスト ← bで返却された新しいトークン情報を利用して、リクエストを行ってください。 レスポンスの度にDBなどの永続化されたデータに保存、リクエストの際はそのデータを毎回参照し、アプリの画面など別のプロセスでトークンの更新があっても問題ないように実装いただくようにしてください。 ## access_token, reflesh_tokenは任意のタイミングで更新できますか？ いいえ。任意のタイミングでの更新はできません。有効期限切れ後の初回リクエスト(いずれかのエンドポイントにリクエスト)時に更新されます。 ## access_tokenとrefresh_tokenの構成要素を教えてください。 ともにランダムな文字列128桁になります。 ## アクセストークン値は発行からどのくらい継続されますか？ 発行から24時間継続されます。24時間を過ぎるとトークン値が更新され、発行時のトークン値が利用できなくなります。 トークン値更新後の最初のリクエストにてアクセストークンとリフレッシュトークンを渡していただければ、新しいアクセストークンとリフレッシュを取得できます。 なお、リフレッシュトークンは72時間継続されます。 --- # アプリ開発 URL: https://developer.next-engine.com/faq/03-app-development/ ネクストエンジン API の「アプリ開発」に関するよくある質問です。 ## アプリケーションの動作環境にはSSL認証されたサーバーが必要でしょうか？ はい。ネクストエンジンアプリの連携にはSSL認証された（httpsではじまる）URLでアクセス可能なサーバーが必要です。 ## アプリ環境にIP制限があるので、接続元(ネクストエンジンサーバ)のIPを知りたいです。 ネクストエンジンAPIの認証の流れは クライアント → ネクストエンジンサーバ → クライアント → アプリなので、 (リダイレクト処理されるので)ネクストエンジンサーバーからアプリに直接アクセスすることはありません。 接続元IP(ネクストエンジンサーバのIPアドレス)の考慮は必要ありません。 ## 開発したアプリを公開する場合は環境を用意していただけるのでしょうか？ ネクストエンジンは、アプリが稼働するサーバを開発者に提供致しません。 アプリをWeb上で公開するためのサーバは、動作環境（開発/検証/本番）に関わらず、開発者が用意する必要がございます。 ## テスト環境用のデータはどうすれば用意できるでしょうか？ 開発中アプリはテストメイン機能と紐付いています。 詳しくはこちらをご覧ください。 [https://manual.next-engine.net/pf/pf017/](https://manual.next-engine.net/pf/pf017/) ## テスト環境と本番環境の切り替えはどのようにすればよいでしょうか？ 以下ページを参照ください。 [https://manual.next-engine.net/pf/pf022/](https://manual.next-engine.net/pf/pf022/) client_id, client_secretはアプリテスト環境とアプリ本番環境それぞれ別にありますので、 アプリ側で接続先を設定（切り替えて）していただく必要があります。 本番環境用、テスト環境用のclient_id, client_secretの確認はネクストエンジンTOP＞アプリを作る＞該当アプリの「詳細」ボタン「API」タブで確認できます。 ## 作成したネクストエンジンアプリは、ローカル環境（PC）で動作検証できますか？ はい。ローカルでの動作検証は可能です。 ローカル環境でのAPIご利用までの流れをご説明している記事がございますので、 こちらをご参考にしていただければ幸いです。 ネクストエンジンAPIの使い方 [http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd](http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd) ## 他の言語でのSDKの提供はありますか？ ありません。 現在、提供されているSDKは[こちら](api/sdk)を御覧ください。 他の言語のSDKを開発された方がいらっしゃいましたら、ぜひコミュニティに貢献しましょう！弊社公認としてリファレンスに掲載させていただきます。 ## アプリを開発するにはネクストエンジンを契約する必要がありますか？ アプリ開発用のテスト環境(テストメイン機能)をご用意しております。 テスト環境のご利用料金は無料です。ぜひご利用ください。 ## ネクストエンジンAPIはバッチ（コマンドライン）での利用は可能ですか？ はい。実現は可能です。 ただし、Webアプリケーションを想定した仕組みのため、いくつか工夫が必要です。 【前提】 ・APIの利用には「アクセストークン」が必要 ・アクセストークンを更新するには「リフレッシュトークン」が必要 ・アクセストークンは24h、リフレッシュトークンは72hの有効期限がある ・有効期限が切れた場合はAPIの呼び出しに失敗する。ただし、リフレッシュトークンが有効期限内で 　あればアクセストークンの更新（トークンの再発行と有効期限の延長）が可能 APIリファレンスに詳細な情報がございますので合わせてご確認ください。 【対応方法】 ・「アクセストークン」の取得には以下の2つのパターンがあります。 　a. ネクストエンジンIDとパスワードでの認証 　b. リフレッシュトークンを利用したアクセストークンの更新 １．少なくとも初回は必ずaの対応が必要なため、弊社から提供しておりますSDKなどをご利用いただき、 　　aの方法でアクセストークンとリフレッシュトークンを取得していただく 　　（アプリの「Redirect URI」にはlocalhostなど、お使いの環境から見えるURLを設定してください） ２．取得したアクセストークンとリフレッシュトークンを利用しAPIを呼び出す ３．有効期限が切れた場合はbの方法でアクセストークンを更新していただく ４．2に戻る aの方法はブラウザとWebサーバーなど弊社サーバーから値を渡すための環境が必要ですが、 bの方法はバッチなどのプログラムが動かせる環境があれば実現可能かと思います。 【注意点】 ・リフレッシュトークンの有効期限が切れた場合はaの方法でアクセストークンを再取得する必要があります。 　そのため前回起動から72h以内にはbの方法でアクセストークンの再取得が必要です。 ・プラットフォームの画面からaに利用したネクストエンジンIDのユーザーのアプリの利用権限を変更した場合、 　アクセストークンが更新されるためAPIが呼び出せなくなります。 ・アクセストークンはネクストエンジンIDごとに値が異なるため、どなたかユーザーと紐づくことになりますので 　API経由で更新したメイン機能の履歴がそのユーザーのものになる場合がございます。 ## 各エンドポイントにおける、使用不可文字を教えてください。 [ネクストエンジン(メイン機能)のマニュアル](https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8688/)をご参照ください。 ## 同一トークンによる並列リクエストをしたいのですが、懸念事項はありますでしょうか？ 同一トークンによる並列リクエストはしないでください。 認証情報の有効期限がきれた場合、並列リクエストを行っているとエラーレスポンスが返却される可能性があります。 また、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください。 [開発時の注意事項](/api/secure) ## アプリ本番環境への繋ぐ方法とそのタイミングを知りたいです。 ネクストエンジンTOP＞アプリを作るにおいて、アプリ審査後、「販売開始」ボタンを押下すると、アプリ本番環境のclient_id、client_secretが利用できる状態になります。 上記のclient_id、client_secretを利用し、ネクストエンジンAPIを利用すると、本番メイン機能へのアクセスが可能になります。 予め、環境別にclient_id、client_secretを切り替えられるようにしておくとスムーズなリリースが可能になります。 ## 「特定の企業に公開」アプリを開発する場合、アプリ利用企業とアプリ開発企業が異なる場合のアプリの作成方法を教えてください。 a.「アプリ開発企業にアプリ利用企業のユーザをゲスト招待する方法」と b.「アプリ利用企業にアプリ開発企業のユーザをゲスト招待する方法」があります。 【aの場合】 この場合はアプリ開発企業ユーザが、初回アプリ作成から販売開始まで行うことができます。 【bの場合】 ゲスト招待したアプリ開発企業のユーザにテストメイン機能、テストアプリの利用権限を付与し、アプリ開発を行うことになります。 ただし、この場合は初回アプリ作成をアプリ利用企業のユーザが作成する必要があります。(アプリを作成し、そのアプリの権限をゲストユーザに付与する) 利用企業、接続先メイン機能選択はアプリ利用企業ユーザのみ選択できます。 どちらの場合もアプリ販売開始後に、アプリ利用企業の権限設定(ネクストエンジンTOP＞設定＞アプリ＞利用ユーザ設定)を変更をすると、利用することができます。 ## エクセルVBAからネクストエンジンAPIを使って、在庫数変更などの処理を行いたいのですが、物理的に可能なのでしょうか？ VBAはSDKが用意されていないだけであり、他言語同様APIを問題なく使っていただけます。 ただしVBAのバージョン差による挙動やどのバージョンを使えば動作するかなどのサポートは一切ございませんのでご注意くださいませ。 ## 過去時点の在庫数を取得することは可能ですか？ API 在庫入出庫履歴検索にて取得が可能です。 指定時間がある場合は指定日時以前の条件で取得した結果で一番新しいデータの更新後在庫数がその時点の在庫数になります 参考 [入出庫履歴検索 (`/api_v1_master_stockiohistory/search`)](/api/api_v1_master_stockiohistory/search/) [検索条件の比較演算子](/guides/param/operator_compare/) ## 各種検索APIのデータ取得順序について教えて下さい。 下記の通りです。 1） 受注明細検索API [https://api.next-engine.org/api_v1_receiveorder_row/search](https://api.next-engine.org/api_v1_receiveorder_row/search) 昇順：receive_order_row_receive_order_id （優先度１） 昇順：receive_order_row_no (優先度２) 2） 受注オプション検索API [https://api.next-engine.org/api_v1_receiveorder_option/search](https://api.next-engine.org/api_v1_receiveorder_option/search) 昇順：receive_order_id 3）在庫検索API [https://api.next-engine.org/api_v1_master_stock/search](https://api.next-engine.org/api_v1_master_stock/search) 昇順：stock_goods_id 4）商品マスターAPI [https://api.next-engine.org/api_v1_master_goods/search](https://api.next-engine.org/api_v1_master_goods/search) 昇順：goods_id 5）アップロードキュー検索 [https://api.next-engine.org/api_v1_system_que/search](https://api.next-engine.org/api_v1_system_que/search) 昇順：que_id" ## どの商品がどの店舗と在庫連携しているか確認するAPIはありますか？ 在庫連携を確認できるAPIはございません。 ## 各店舗と在庫連携するためのモール商品一括登録をAPIにて行うことはできますか？ モール商品一括登録用はAPIにて登録いただくことができません。 ## 仕入伝票の検索はAPIを利用することができますが、伝票の作成や操作はできますか？ 仕入伝票に関する操作は、検索のみ可能です。また、現在追加の予定はございません。 ## 公開アプリを「アプリで探す」にて検索する際「カテゴリで探す」より検索できるカテゴリはどのように付与すればよいでしょうか。 カテゴリ付与は、発売後にアプリの内容を鑑みてネクストエンジンの担当者が付与しております。開発者側にて付与することはできません。 ## 在庫振り分けを使用して店舗ごとに連携する在庫数を変えている場合に、ネクストエンジンAPIを使用して店舗ごとの在庫数を取得することはできますか？ ネクストエンジンAPIでは振り分けられた在庫数を取得することはできません。 ## ネクストエンジンで使用不可な文字列を含めた状態で、受注伝票受注伝票更新APIを実行してみたところ、問題なく更新が行えました。API側では使用不可文字列の制限は特に行ってないということでしょうか。 API側でも以下のページにある使用不可な文字列のご利用については推奨しておりませんので、利用を避けるようにお願いいたします。　 　[https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8...](https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8688/) --- # 審査・利用料金 URL: https://developer.next-engine.com/faq/04-review-pricing/ ネクストエンジン API の「審査・利用料金」に関するよくある質問です。 ## アプリの審査期間はどのくらいですか？ 1週間程度になります。 ## ネクストエンジンAPIの利用には料金がかかりますか？ 販売形態が「すべての企業に公開」の場合は無料となります。 販売形態が「特定の企業に公開」の場合は利用量に伴って、料金が発生します。こちらの[「特定の企業に公開」アプリ料金表](api/start)をご参照ください。 (どちらもテストアプリでのネクストエンジンAPIの利用は無料です) ## 「特定の企業に公開」のアプリを２つ作った場合、利用料金はどうなりますか？ ご利用料金はアプリごとに算出されるので、 アプリが2つあれば2つ分のご利用料金を頂戴することとなります。 料金表に関しては[こちら](api/start)をご参照ください。 ## 認証系エンドポイントに関しては、ネクストエンジンAPIの呼び出し回数としてカウントされるでしょうか？ 認証系エンドポイントの内、以下のエンドポイントに対するリクエストはカウントされません。(利用料金に含まれない) 　　・NEログインuid・state取得(/users/sign_in/) 　　・NEログインaccess_token取得(/api_neauth) 　　・アプリ利用企業一覧（/api_app/company） ## 現状のリクエスト回数と通信データ量を把握する方法はありますか？ ネクストエンジンTOP＞アプリを作る＞該当アプリ(「特定の企業に公開」アプリ)＞操作＞リクエスト履歴から日毎、月毎に閲覧可能(直近1年間のみ)です。 ## リクエスト回数が月間10001回以上、通信データ量が月間6GB以上の場合は「要相談」となっていますが、どこに問い合わせればよいでしょうか？ サポートまでお問い合わせください。 [こちら](https://base.next-engine.org/apps/996/detail/)の「アプリに関するお問い合わせ先」をご参照ください。 ## 呼び出し回数のカウント方法が知りたいです。 APIコール１回あたり１カウントです。 ## APIの呼び出し回数が現状でどれほど計上されているかがわかりますでしょうか。 アプリ開発者の方が現在の今月分リクエスト回数を確認する方法はございません。 ## テスト環境でのAPI呼び出しは課金されますか？ テスト環境では課金されません. 審査通過後、本番環境での運用になった場合から課金されることになります. ## ネクストエンジンのAPIを利用するにあたって、データ通信料がどれくらいになるか見積もりを取りたいと考えております。APIで取得していますデータ量の計算方法ってございますでしょうか。 APIレスポンスのデータ量でおおよその目安にはなりますが、正確な通信料を見積もることはできません。申し訳ございませんが、参考程度でお願いいたします。 ## サーバー負荷による更新エラーなどでアクセストークンが更新されないケースはありますでしょうか？エラーコードは002002以外になるのでしょうか。 以下のメッセージ一覧には、リクエストが失敗する原因と対応するエラーコードが記載されておりますので、ご覧ください。 　　　[メッセージ一覧](/guides/param/message/) 　　　「NEログインaccess_token取得」エンドポイントをご利用の場合は、以下の分類のメッセージが返ってくる可能性がございます。 　　　・共通 　　　・AccessToken取得 　　　・API共通処理(ネクストエンジン) 　　　・API共通処理(メイン機能) 　　　・例外 --- # エラー URL: https://developer.next-engine.com/faq/05-errors/ ネクストエンジン API の「エラー」に関するよくある質問です。 ## アプリを開いたら 「このウェブページにはリダイレクトループが含まれています」と表示されます。原因はなんでしょうか？ access_tokenの有効期限が切れている場合があるため、 まずはご自身がログインされているか確認してください。 ## ネクストエンジンサーバやメイン機能がメンテナンス中に、ネクストエンジンAPIを利用するとエラーが返ってきますか？ はい。エラーが返却されます。 メンテナンス状況によって、メッセージコード「002007」「003004」「003005」等が返却されます。 [メッセージコード](api/param/message)をご参照ください。 ## 504 GATEWAY_TIMEOUT エラーの原因はなにが考えられますか？ 504 GATEWAY_TIMEOUTの原因は複数考えられるため断定はできませんが、アプリからネクストエンジンAPIへの接続がタイムアウトにより切れた可能性があります。 タイムアウトの要因も単純に処理に時間がかかりタイムアウトとなった、お客様がアプリを動作させているサーバー環境のタイムアウトの設定がAPIサーバーのタイムアウトの設定よりも短かったなどが考えられます。 APIサーバーやネクストエンジンメイン機能が高負荷により一時的にレスポンスが遅くなっている場合もありますので、時間をおいてアクセスしていただくと解決することもあるかと思います。 継続してタイムアウトが発生する場合はお手数ですが再度お問い合わせをお願いいたします。 ## uid、state取得エンドポイントをリクエストすると、「アプリの連携に失敗しました -指定したアプリがみつかりませんでした-」というエラー画面が表示されます。対処方法を教えてください。 該当ユーザにアプリの利用権限がついていない可能性があります。 ネクストエンジンTOP＞設定＞アプリ＞利用ユーザー設定にて、ネクストエンジンAPIを利用するユーザの利用許可をしていただいた上で、再度ご確認ください。 権限はテスト環境、本番環境毎に設定できます。アプリ環境をご確認の上、利用権限設定を行ってください。 ## GETリクエストをuid・state取得エンドポイントに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？ "アクセスしたユーザーがネクストエンジンにログインしているかどうかで結果が異なりますが、ログインしていない場合はHTMLログインページが返ってくるのが正常な動きです。" --- # 受注 URL: https://developer.next-engine.com/faq/06-receive-orders/ ネクストエンジン API の「受注」に関するよくある質問です。 ## ネクストエンジンAPIで受注明細を更新し、更新したデータをネクストエンジンAPIで取得しようとした場合、即時更新した内容がネクストエンジンAPIで取得できますか？ はい。即時反映したものが取得できます。 ※ 但し、非同期で更新される機能があります。 ・受注一括登録 ・商品マスタ予約一括登録 ## 受注状態区分エンドポイントで取得できる区分のID及び名称は固定値でしょうか？ はい。受注状態区分のIDと名称は固定値になります。 管理画面などでのカスタマイズは不可となります。 ## 「受注一括登録フォーマットパターン」と「受注一括登録パターン」について教えてください。 ネクストエンジンAPIでは「受注一括登録フォーマットパターン」と「受注一括登録パターン」を区別して扱っております。 受注伝票アップロードエンドポイントの「receive_order_upload_pattern_id」に入力する値は登録対象の「受注一括登録パターンID」になります。 各「受注一括登録フォーマットパターンID」を条件にして、受注一括登録パターン情報取得エンドポイントから、「受注一括登録パターンID」を取得することができます。 [受注一括登録パターン情報取得](api/api_v1_receiveorder_uploadpattern/info) ## 受注伝票における、受注状態の変更方法を教えてください。 ネクストエンジン(メイン機能)では確認処理や入金登録処理、出荷処理などを行った場合に受注状態区分が変わります。(手動で変更することはできません) ネクストエンジンAPIでは受注伝票納品書印刷済みエンドポイント、受注伝票出荷確定処理エンドポイントなどで受注状態区分が自動で変わります。 ## 受注伝票の操作履歴はAPIで取得できますか？ 受注伝票の操作履歴はAPIで取得することができません。 ## 受注伝票登録時に受注状態を指定することは可能ですか？ 指定することはできません。該当の受注に適した受注状態が登録されます。 ## APIを利用した受注伝票の作成は可能ですか？ 可能です。以下のAPIをご参照ください。 [受注伝票アップロード (`/api_v1_receiveorder_base/upload`)](/api/api_v1_receiveorder_base/upload/) ## 印刷待ち・印刷済みの受注状態の伝票をまとめて出荷完了に移動させることは可能ですか？ まとめて変更することはできません。1伝票ずつ更新する必要があります。 更新の際は、出荷確定処理API(/api_v1_receiveorder_base/shipped)をご利用ください。 【参考ページ】 [受注伝票出荷確定処理 (`/api_v1_receiveorder_base/shipped`)](/api/api_v1_receiveorder_base/shipped/) ## 1,000件以上の受注伝票をAPIでデータ更新したいです。ネクストエンジン側で連続したリクエストに対するアクセス制限は設けていますか？ 連続したリクエストに対しての制限は特に設けておりませんが、以下の点にご注意ください。 　　　・高負荷な処理(バッチ処理、大量検索・大量更新)や、アプリ側の1連の処理を途切れさせたくない場合にはwait_flagの値を1で設定してください。 　　　　ユーザーに即時レスポンスを返すべき処理ではご利用いただかないことを強く推奨致します。 　　　　また必ずAPIが成功する事を保証するパラメータではない為、再開可能なようにアプリを設計して下さい。 　　　　wait_flagについてはこちらをご参照ください。 　　　　[パラメータ共通事項](/guides/param/common/) 　　　・特定企業にのみ公開アプリの場合はAPI呼び出し回数によって料金が変わるのでご注意ください。 　　　　料金についてはこちらをご参照ください。 　　　　[https://manual.next-engine.net/pf/pf015/](https://manual.next-engine.net/pf/pf015/) ## 受注伝票の「伝票番号(receive_order_option_receive_order_id)」は、順番に増えていく番号という認識であっていますか？最大値はありますか？ 順番に増えていく番号という認識であっています。最大値は10桁ほどです。 ## APIを通して確認待ちステータスの注文を次のステップ(印刷日待など)に変更したい場合、受注状態区分を印刷日待にアップデートしてから転送する認識で問題ないでしょうか。 確認チェック区分 receive_order_confirm_check_id=2（確認済み）で更新してください。 参照時と更新時の仕様が違うため、ご注意くださいませ。 参照時： 　0:確認不要 　1:確認必要 　2:確認済み 更新時： 　0：確認待ちのチェックを外す　 　1：確認待ちのチェックをつける ## APIを通して受注状態区分のアップデートは可能でしょうか。 例）印刷完了→確認待ち、確認待ち→発送完了 下記のように一部の受注状態区分に関して更新が可能です。 受注伝票納品書印刷済み(エンドポイント /api_v1_receiveorder_base/receipted)　印刷済み状態へ 受注伝票出荷確定処理(エンドポイント /api_v1_receiveorder_base/shipped)　出荷済み状態へ 確認待ち→発送完了につきましては、受注伝票更新(エンドポイント /api_v1_receiveorder_base/update)の確認チェック区分の更新にて状態が遷移できます。 注意事項としまして、前の状態へ遡るような、APIの提供はございません。 ## 最終更新日receive_order_row_last_modified_date、最終更新日receive_order_row_last_modified_null_safe_date、受注伝票・受注明細の最終更新日receive_order_row_last_modified_newest_dateの３種類があると思うのですが、どのように使い分ければ良いのかが分かりません。 それぞれの違いについて説明させていただきます。 新規データ作成後、更新がなかった場合、①ではNULLもしくは明細の作成日、②では明細の作成日が返却されます。それ以外の違いはございません。 ③を使っていただくと、受注伝票と受注明細の最終更新日を比較し、後に更新された日時を取得していただけます。 補足になりますが、①と②に関して、今回のような指定された日時以降のデータを取得したい場合は、②を利用するようにして下さい。 ①最終更新日 receive_order_row_last_modified_date ②最終更新日 receive_order_row_last_modified_null_safe_date ③受注伝票・受注明細の最終更新日 receive_order_row_last_modified_newest_date ## 受注ステータスが｢確認待ち｣かつ｢家具｣タグが付与された受注一覧を取得したい場合、受注伝票検索APIより｢受注状態区分｣が｢確認待ち｣かつ｢受注分類タグ｣に｢家具｣を含む受注を取得する形でよろしいでしょうか。 あっています。 検索条件を複数指定した場合、全ての条件がかつ(AND)となります 参考：[受注伝票検索 (`/api_v1_receiveorder_base/search`)](/api/api_v1_receiveorder_base/search/) ## APIにて過去受注の検索を行う場合、どの程度過去まで遡って検索することができるのでしょうか。 経過年数による制限は特に設けておりませんので、 受注伝票が存在する限り、遡って検索することができます。 ## 受注伝票情報を検索する時、受注状態が変更された受注のみ検索して持ってくることは可能でしょうか。 受注状態が変更された受注のみを抽出することは出来ません。最終更新日を利用して伝票のいずれかの項目が変更されたかどうかを取得することは可能です。 ## クレジットカードの名義人と有効期限は取得できるのでしょうか。また、取得できる場合フィールド名はあるのでしょうか。 申し訳ございません。クレジットカードの名義人と有効期限は取得できない仕様となっております。 ## receive_order_last_modified_dateが更新できる条件を教えていただけますでしょうか。また、メイン機能でreceive_order_last_modified_dateを更新する方法を教えてもらえますでしょうか。 receive_order_last_modified_dateは受注伝票になんらかの変更が発生した場合に自動的に更新され任意の値で更新することが出来ない仕様となります。 API経由であれば、一括アップロードを使用し受注伝票を更新すると現在の日時で更新されます。 メイン機能であれば、例えば出荷確定処理や納品書ダウンロード、受注伝票詳細画面などで変更が行われた場合現在の日時で更新されます。 --- # 発注 URL: https://developer.next-engine.com/faq/07-place-orders/ ネクストエンジン API の「発注」に関するよくある質問です。 ## 発注伝票を取得・更新するためのエンドポイントはありますか？ いいえ。現在、発注伝票系のエンドポイントは提供しておりません。 ## APIから、仕入先マスタに新しく仕入先を登録することは可能でしょうか。 仕入れ先登録のためのAPIはただいまご用意がございません。 --- # 商品 URL: https://developer.next-engine.com/faq/08-goods/ ネクストエンジン API の「商品」に関するよくある質問です。 ## 在庫更新エンドポイントはありますか？商品在庫数の更新方法を教えてください。 在庫更新は[商品マスタアップロード (`/api_v1_master_goods/upload`)](/api/api_v1_master_goods/upload/)にて行うことができます。 商品在庫数は、実数ではなく加算数または減算数を設定します。 実数で更新したい場合は、一度現在の在庫数を取得し更新したい在庫数の差分で更新することになります。 ex. 現在の在庫数が「6」、更新したい在庫の実数が「4」、在庫数は「-2」で設定する 更新するCSVフィールド名は下記の通りです。 在庫数: zaiko_su 予約在庫数: yoyaku_zaiko_su 商品マスタアップロードエンドポイントで利用するdata(CSV)の仕様は[ネクストエンジン(メイン機能)のルール](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/)と同様になりますので、こちらをご参照ください。 ## 商品ページ（β版）のAPI対応の予定はありますか？ 商品ページ（β版）が正式版となりましたら、APIについても対応する予定です。 現時点でβ版終了日は未定となっております。 ## 在庫マスタ検索(/api_v1_master_stock/search)エンドポイントにおいて、where句パラメータのIN句に記述できるデータの上限数はいくつになりますでしょうか？ 上限は1000個になります。 ## 商品マスタアップロード(/api_v1_master_goods/upload)エンドポイントにおいて、パラメータのCSV部分に改行区切りでセットできるレコード数に上限はありますでしょうか？ 上限はございませんが、量が多くなる場合は、data_typeをgzにして、圧縮ファイルをアップロードするようにしてください。 データ量によってはアップロードエラーになる場合があります。 ## 商品マスタアップロードエンドポイントに関して、メイン機能へのアップロードに失敗したがsuccessで返却される仕様について教えてください。 商品データアップロードエンドポイントのレスポンス内容はメイン機能の更新結果ではなく、ファイルアップロードが成功したか否かの結果になります。 メイン機能の更新処理の結果については、アップロードキュー検索API(エンドポイント /api_v1_system_que/search)を参照してください。 ## 返品処理について教えてください。 商品マスタアップロードエンドポイント(/api_v1_master_goods/upload)を利用する事により返品処理を行う事ができます。 在庫数の加算/減算値(zaiko_su)で返品数を設定し、入出庫履歴の事由(nyusyukko_riyu)に返品理由を設定します。 エンドポイントについてはこちらをご覧ください。 [商品マスタアップロード (`/api_v1_master_goods/upload`)](/api/api_v1_master_goods/upload/) アップロード用のcsvファイルについてはこちらをご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) ## APIを利用して商品マスタに商品画像の登録はできますか？ 商品画像のアップロード機能は提供していません。 ## 「受注分類タグ」によりステータスを「確認待ち」に自動遷移させることは可能でしょうか。 「受注分類タグ」による自動遷移はできかねます。「商品分類タグ」をご使用ください。 ## 在庫数を変更する際に、加算・減算ではなく実数による上書きは可能でしょうか。 在庫数の更新は加算または減算のみ可能です。実数で更新したい場合は、一度現在の在庫数を取得し、更新したい在庫数の差分で更新をしてください。 ## 一般的にはAPIで更新後、手動で「対象」にチェックを入れてページ作成、アップロードを行うのでしょうか？ ご認識のとおりでございます。 ## APIでは、商品マスタは商品コードから参照できますが、セット商品マスタはセット商品コードから参照できないのでしょうか。 APIでセット商品を取得する方法はございません。 --- # その他 URL: https://developer.next-engine.com/faq/09-others/ ネクストエンジン API の「その他」に関するよくある質問です。 ## メイン機能において、汎用店舗で在庫連携するにはどうすればよいですか？ ネクストエンジンマニュアルに在庫連携APIの仕様書がありますので こちらをご参照いただければと思います。 [http://manual.ec-doc.net/startup/hanyo/](http://manual.ec-doc.net/startup/hanyo/) 「設定に関する資料はこちらからダウンロードしてください」からダウンロードお願いします。 また、本Developer Networkのコミュニティでは、ネクストエンジンAPI関連以外は受け付けておりません。お問い合わせ等は[サポート](https://base.next-engine.org/apps/996/detail/)までご連絡ください。 --- # FAQ URL: https://developer.next-engine.com/faq/ よくある質問をカテゴリ別にまとめました。各カテゴリのページから個別の質問にジャンプできます。 ## カテゴリ - [client_id / client_secret](/faq/01-client-id-secret/) — 4 件 - [access_token / refresh_token](/faq/02-access-token/) — 7 件 - [アプリ開発](/faq/03-app-development/) — 22 件 - [審査・利用料金](/faq/04-review-pricing/) — 11 件 - [エラー](/faq/05-errors/) — 5 件 - [受注](/faq/06-receive-orders/) — 18 件 - [発注](/faq/07-place-orders/) — 2 件 - [商品](/faq/08-goods/) — 11 件 - [その他](/faq/09-others/) — 1 件 --- # エンドポイント一覧 URL: https://developer.next-engine.com/guides/api-index/ | 名前 | ホスト | エンドポイント | | --- | --- | --- | | NEログインuid・state取得 | https://base.next-engine.org | /users/sign_in | | アプリ利用企業一覧 | https://api.next-engine.org | /api_app/company | | NEログインaccess_token取得 | https://api.next-engine.org | /api_neauth | | 受注伝票件数取得 | https://api.next-engine.org | /api_v1_receiveorder_base/count | | 受注伝票検索 | https://api.next-engine.org | /api_v1_receiveorder_base/search | | 受注伝票更新 | https://api.next-engine.org | /api_v1_receiveorder_base/update | | 受注伝票一括更新 | https://api.next-engine.org | /api_v1_receiveorder_base/bulkupdate | | 受注伝票アップロード | https://api.next-engine.org | /api_v1_receiveorder_base/upload | | 受注伝票納品書印刷済み | https://api.next-engine.org | /api_v1_receiveorder_base/receipted | | 受注伝票納品書印刷済み一括更新 | https://api.next-engine.org | /api_v1_receiveorder_base/bulkupdatereceipted | | 受注伝票出荷確定処理 | https://api.next-engine.org | /api_v1_receiveorder_base/shipped | | 受注伝票配送情報出力済み | https://api.next-engine.org | /api_v1_receiveorder_base/labelprinted | | 受注伝票分割 | https://api.next-engine.org | /api_v1_receiveorder_base/divide | | 受注伝票一括同梱 | https://api.next-engine.org | /api_v1_receiveorder_base/bundle | | 受注伝票同梱候補グループ取得 | https://api.next-engine.org | /api_v1_receiveorder_base/bundle_candidate_groups | | 受注税金内訳 | https://api.next-engine.org | /api_v1_receiveorder_tax_account/search | | 受注伝票オプション件数取得 | https://api.next-engine.org | /api_v1_receiveorder_option/count | | 受注伝票オプション検索 | https://api.next-engine.org | /api_v1_receiveorder_option/search | | 受注明細件数取得 | https://api.next-engine.org | /api_v1_receiveorder_row/count | | 受注明細検索 | https://api.next-engine.org | /api_v1_receiveorder_row/search | | 発送方法別区分件数取得 | https://api.next-engine.org | /api_v1_receiveorder_forwardingagent/count | | 発送方法別区分検索 | https://api.next-engine.org | /api_v1_receiveorder_forwardingagent/search | | 受注確認内容件数取得 | https://api.next-engine.org | /api_v1_receiveorder_confirm/count | | 受注確認内容検索 | https://api.next-engine.org | /api_v1_receiveorder_confirm/search | | 受注確認内容更新 | https://api.next-engine.org | /api_v1_receiveorder_confirm/update | | 受注一括登録パターン情報取得 | https://api.next-engine.org | /api_v1_receiveorder_uploadpattern/info | | 受注分類タグ検索 | https://api.next-engine.org | /api_v1_receiveorder_groupingtag/search | | 支払発送変換件数取得 | https://api.next-engine.org | /api_v1_receiveorder_paymentdeliveryconvert/count | | 支払発送変換検索 | https://api.next-engine.org | /api_v1_receiveorder_paymentdeliveryconvert/search | | 拠点マスタ件数取得 | https://api.next-engine.org | /api_v1_warehouse_base/count | | 拠点マスタ検索 | https://api.next-engine.org | /api_v1_warehouse_base/search | | 商品マスタ件数取得 | https://api.next-engine.org | /api_v1_master_goods/count | | 商品マスタ検索 | https://api.next-engine.org | /api_v1_master_goods/search | | 商品マスタアップロード | https://api.next-engine.org | /api_v1_master_goods/upload | | セット商品マスタ件数取得 | https://api.next-engine.org | /api_v1_master_setgoods/count | | セット商品マスタ検索 | https://api.next-engine.org | /api_v1_master_setgoods/search | | セット商品マスタアップロード | https://api.next-engine.org | /api_v1_master_setgoods/upload | | 商品タグ件数取得 | https://api.next-engine.org | /api_v1_master_goodstag/count | | 商品タグ検索 | https://api.next-engine.org | /api_v1_master_goodstag/search | | メールタグ件数取得 | https://api.next-engine.org | /api_v1_master_mailtag/count | | メールタグ検索 | https://api.next-engine.org | /api_v1_master_mailtag/search | | 在庫マスタ件数取得 | https://api.next-engine.org | /api_v1_master_stock/count | | 在庫マスタ検索 | https://api.next-engine.org | /api_v1_master_stock/search | | 拠点在庫マスタ件数取得 | https://api.next-engine.org | /api_v1_warehouse_stock/count | | 拠点在庫マスタ検索 | https://api.next-engine.org | /api_v1_warehouse_stock/search | | 拠点在庫マスタアップロード | https://api.next-engine.org | /api_v1_warehouse_stock/upload | | セット在庫マスタ件数取得 | https://api.next-engine.org | /api_v1_master_setstock/count | | セット在庫マスタ検索 | https://api.next-engine.org | /api_v1_master_setstock/search | | 区分け在庫マスタ件数取得 | https://api.next-engine.org | /api_v1_master_keepstock/count | | 区分け在庫マスタ検索 | https://api.next-engine.org | /api_v1_master_keepstock/search | | 仕入先マスタ件数取得 | https://api.next-engine.org | /api_v1_master_supplier/count | | 仕入先マスタ検索 | https://api.next-engine.org | /api_v1_master_supplier/search | | 仕入伝票件数取得 | https://api.next-engine.org | /api_v1_supplyorder_base/count | | 仕入伝票検索 | https://api.next-engine.org | /api_v1_supplyorder_base/search | | 仕入明細件数取得 | https://api.next-engine.org | /api_v1_supplyorder_row/count | | 仕入明細検索 | https://api.next-engine.org | /api_v1_supplyorder_row/search | | 発注伝票件数取得 | https://api.next-engine.org | /api_v1_placeorder_base/count | | 発注伝票検索 | https://api.next-engine.org | /api_v1_placeorder_base/search | | 発注明細件数取得 | https://api.next-engine.org | /api_v1_placeorder_row/count | | 発注明細検索 | https://api.next-engine.org | /api_v1_placeorder_row/search | | 卸先マスタ件数取得 | https://api.next-engine.org | /api_v1_master_wholesale/count | | 卸先マスタ検索 | https://api.next-engine.org | /api_v1_master_wholesale/search | | 在庫入出庫履歴件数取得 | https://api.next-engine.org | /api_v1_master_stockiohistory/count | | 在庫入出庫履歴検索 | https://api.next-engine.org | /api_v1_master_stockiohistory/search | | 商品ページ 件数取得 | https://api.next-engine.org | /api_v1_master_goods_page/count | | 商品ページ 検索 | https://api.next-engine.org | /api_v1_master_goods_page/search | | 商品ページ(バリエーション)件数取得 | https://api.next-engine.org | /api_v1_master_goods_page_variation/count | | 商品ページ(バリエーション)検索 | https://api.next-engine.org | /api_v1_master_goods_page_variation/search | | 商品ページ(オプション)件数取得 | https://api.next-engine.org | /api_v1_master_goods_page_option/count | | 商品ページ(オプション)検索 | https://api.next-engine.org | /api_v1_master_goods_page_option/search | | 商品ページ(カテゴリ)件数取得 | https://api.next-engine.org | /api_v1_master_goods_page_shopcategory/count | | 商品ページ(カテゴリ)検索 | https://api.next-engine.org | /api_v1_master_goods_page_shopcategory/search | | 店舗マスタ件数取得 | https://api.next-engine.org | /api_v1_master_shop/count | | 店舗マスタ検索 | https://api.next-engine.org | /api_v1_master_shop/search | | 店舗マスタ店舗接続確認 | https://api.next-engine.org | /api_v1_master_shop/checkconnect | | 店舗マスタ店舗作成 | https://api.next-engine.org | /api_v1_master_shop/create | | 店舗マスタ店舗更新 | https://api.next-engine.org | /api_v1_master_shop/update | | 店舗マスタ受注情報取り込み用メールアドレス取得 | https://api.next-engine.org | /api_v1_master_shop/mailaddress | | 商品画像件数取得 | https://api.next-engine.org | /api_v1_master_goodsimage/count | | 商品画像検索 | https://api.next-engine.org | /api_v1_master_goodsimage/search | | 商品画像分類タグ件数取得 | https://api.next-engine.org | /api_v1_master_goodsimagetag/count | | 商品画像分類タグ検索 | https://api.next-engine.org | /api_v1_master_goodsimagetag/search | | 商品カテゴリ件数取得 | https://api.next-engine.org | /api_v1_master_goodscategory/count | | 商品カテゴリ検索 | https://api.next-engine.org | /api_v1_master_goodscategory/search | | 商品コード紐づけ件数取得 | https://api.next-engine.org | /api_v1_master_goodsmapping/count | | 商品コード紐づけ検索 | https://api.next-engine.org | /api_v1_master_goodsmapping/search | | 商品別卸先マスタ件数取得 | https://api.next-engine.org | /api_v1_master_goodswholesale/count | | 商品別卸先マスタ検索 | https://api.next-engine.org | /api_v1_master_goodswholesale/search | | ログインユーザー情報取得 | https://api.next-engine.org | /api_v1_login_user/info | | 企業情報取得 | https://api.next-engine.org | /api_v1_login_company/info | | クレジット種類区分情報取得 | https://api.next-engine.org | /api_v1_system_credittype/info | | クレジットオーソリセンター区分情報取得 | https://api.next-engine.org | /api_v1_system_creditauthorizationcenter/info | | クレジット承認区分情報取得 | https://api.next-engine.org | /api_v1_system_creditapprovaltype/info | | 発注区分情報取得 | https://api.next-engine.org | /api_v1_system_order/info | | 発注条件区分情報取得 | https://api.next-engine.org | /api_v1_system_ordercondition/info | | 発送方法区分情報取得 | https://api.next-engine.org | /api_v1_system_delivery/info | | 端数処理区分情報取得 | https://api.next-engine.org | /api_v1_system_fraction/info | | 返品事由区分情報取得 | https://api.next-engine.org | /api_v1_system_returnedreason/info | | 受注キャンセル区分情報取得 | https://api.next-engine.org | /api_v1_system_canceltype/info | | 受注状態区分情報取得 | https://api.next-engine.org | /api_v1_system_orderstatus/info | | 重要チェック区分情報取得 | https://api.next-engine.org | /api_v1_system_importantcheck/info | | 確認チェック区分情報取得 | https://api.next-engine.org | /api_v1_system_confirmcheck/info | | 顧客区分情報取得 | https://api.next-engine.org | /api_v1_system_customertype/info | | 入金区分情報取得 | https://api.next-engine.org | /api_v1_system_deposittype/info | | 入出荷区分情報取得 | https://api.next-engine.org | /api_v1_system_iotype/info | | 商品選択肢区分情報取得 | https://api.next-engine.org | /api_v1_system_select/info | | 支払区分情報取得 | https://api.next-engine.org | /api_v1_system_paymentmethod/info | | 支払方法区分情報取得 | https://api.next-engine.org | /api_v1_system_payout/info | | 社会保険区分情報取得 | https://api.next-engine.org | /api_v1_system_socialinsurance/info | | 商品区分情報取得 | https://api.next-engine.org | /api_v1_system_goodstype/info | | 商品ステータス区分情報取得 | https://api.next-engine.org | /api_v1_system_goodsstatus/info | | 取扱区分情報取得 | https://api.next-engine.org | /api_v1_system_merchandise/info | | 取込種類区分情報取得 | https://api.next-engine.org | /api_v1_system_importtype/info | | 輸送区分情報取得 | https://api.next-engine.org | /api_v1_system_forwardingmethod/info | | 税区分情報取得 | https://api.next-engine.org | /api_v1_system_tax/info | | 項目名情報取得 | https://api.next-engine.org | /api_v1_system_itemname/info | | ページステータス区分情報取得 | https://api.next-engine.org | /api_v1_system_pagestatus/info | | アップロードキュー件数取得 | https://api.next-engine.org | /api_v1_system_que/count | | アップロードキュー検索 | https://api.next-engine.org | /api_v1_system_que/search | | オーソリ区分情報取得 | https://api.next-engine.org | /api_v1_system_authorizationtype/info | | 通貨単位区分情報取得 | https://api.next-engine.org | /api_v1_system_currencyunit/info | | モール件数取得 | https://api.next-engine.org | /api_v1_system_mall/count | | モール検索 | https://api.next-engine.org | /api_v1_system_mall/search | | 画像分類タグ件数取得 | https://api.next-engine.org | /api_v1_system_imagetag/count | | 画像分類タグ検索 | https://api.next-engine.org | /api_v1_system_imagetag/search | | モールカテゴリ件数取得 | https://api.next-engine.org | /api_v1_system_mallcategory/count | | モールカテゴリ検索 | https://api.next-engine.org | /api_v1_system_mallcategory/search | | 納期情報取得 | https://api.next-engine.org | /api_v1_system_deliverydate/info | | 実行結果お知らせ追加 | https://api.next-engine.org | /api_v1_notice_execution/add | | 実行結果お知らせ件数取得 | https://api.next-engine.org | /api_v1_notice_execution/count | | 実行結果お知らせ検索 | https://api.next-engine.org | /api_v1_notice_execution/search | --- # 認証フロー URL: https://developer.next-engine.com/guides/auth/ #### 以下にAPIを利用するために必要な事前認証の処理フローを３つの場面に分けて説明します。 | 用語 | 説明 | | --- | --- | | ユーザー | アプリケーションを利用するユーザ | | アプリケーションサーバ | 貴社が提供するアプリケーションが稼働するサーバ | | ネクストエンジンサーバー | 弊社が提供するネクストエンジンアプリを管理するサーバ | | APIサーバー | 弊社が提供するネクストエンジンと連携するAPIサーバ | | uid | アプリを起動したユーザーを識別するためのID | | `state` | アプリを起動したユーザーのstate。stateには有効期限があります（５分）。有効期限が切れた場合は再取得する必要があります。 | | `client_id` | アプリを識別するためのID。ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | | `client_secret` | アプリを識別するためのID。ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるシークレットクライアント | | `access_token` | ネクストエンジンAPIを利用する為のトークン。有効期限は1日です。有効期限が切れた場合は再取得する必要があります。 refresh_tokenの期限が有効であれば、API実行時に自動で更新されます。 | | `refresh_token` | ネクストエンジンAPIを利用する為のトークン。有効期限は3日です。有効期限が切れた場合は再取得する必要があります。access_tokenが更新された場合、同時に更新されます。 | ![アプリメニューから起動する場合の認証フロー (uid・state 経由で access_token を取得)](/images/93c6675a46a3.png) ネクストエンジンにログイン後、ネクストエンジンのアプリメニューから起動した場合の処理の流れです。 | 番号 | 概要 | 備考 | | --- | --- | --- | | 1 | アプリを起動 | アプリ登録時に設定した「Redirect URI」にURLパラメータuid, stateを付与した状態でリダイレクトします。 | | 2 | access_tokenの取得 | uid, state, client_id, client_secretを元にAPIサーバーにaccess_token, refresh_tokenの発行を依頼します。 | | 3 | データアクセス | APIを用いてデータの取得・更新などを実行します。 access_tokenの有効期限が切れていてrefresh_tokenの有効期限内の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します。 | ![アプリケーションサーバに直接アクセスする場合の認証フロー (NE ログイン uid・state 取得から始まる)](/images/b6086a82a124.png) アプリケーションサーバに直接アクセスした場合の処理の流れです。 | 番号 | 概要 | 備考 | | --- | --- | --- | | 1 | NEログインuid,state取得 | client_idを元にネクストエンジンサーバーにuid及びstateの発行を依頼します。未ログイン状態の場合はログイン画面が返却されます。ログイン後、設定されているリダイレクトURLに遷移します。 | | 2 | access_tokenの取得 | uid, state, client_id, client_secretを元にAPIサーバーにaccess_token, refresh_tokenの発行を依頼します。 | | 3 | データアクセス | APIを用いてデータの取得・更新などを実行します。 access_tokenの有効期限が切れていてrefresh_tokenの有効期限内の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します。 | ![バッチ処理など WEB アプリ以外で API を利用する場合の認証フロー (事前取得した token を保持して利用)](/images/7d8c1e579d73.png) WEBアプリ以外でAPIを利用する場合（例：バッチ処理） | 番号 | 概要 | 備考 | | --- | --- | --- | | 1 | アクセストークン取得 | APIを利用するためにaccess_token,refresh_tokenを事前に取得します。取得方法は上記と同じです。 | | 2 | アクセストークンの保持 | 取得したaccess_token,refresh_tokenを保持しておきます。実装はアプリケーション側で用意してください。 | | 3 | バッチ処理の実行 | APIを用いてデータの取得・更新などを実行します。 access_tokenの有効期限が切れていてrefresh_tokenの有効期限内の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します。 定期的にAPIへアクセスすることでaccess_tokenとrefresh_tokenの有効期限切れを防ぐ仕組みを作ることをお勧めします。 | ## ネクストエンジンAPIにおけるrefresh_tokenについて 各エンドポイントにリクエストする際、access_tokenに加えrefresh_tokenも併用することで、初回ユーザー認証のみでAPIを利用し続ける事が出来るようになるパラメータです。 ### refresh_tokenの必要性 #### access_tokenのみの場合 access_tokenのみでネクストエンジンAPIを利用する事が出来ますが、access_tokenの有効期限が切れた際、ユーザーの認証(リダイレクト)が必要になり、アプリ側では処理の途中で有効期限が切れた際の考慮が必要になります。 (例えば受注更新->出荷確定を行うアプリの場合、受注更新後にaccess_tokenの有効期限が切れた場合は、ネクストエンジンサーバーへのリダイレクト後に出荷確定処理から戻れるように考慮する必要があります) #### refresh_token併用時 access_tokenに加えrefresh_tokenも併用してネクストエンジンAPIを利用するとaccess_tokenの有効期限が切れた際、refresh_tokenの有効期限内であればその時実行したAPIが【正常終了】し、 新しいaccess_token及びrefresh_tokenが返却されます。 次回から新しいaccess_token及びrefresh_tokenを使う事で、初回ユーザー認証のみでAPIを利用する事が出来るようになります。 また処理の途中でaccess_tokenの有効期限が切れてもアプリの一連の処理が正常終了する為、一連の処理の途中で有効期限が切れてしまった際の考慮が不要になります。 そのためセキュリティ上の懸念(※)がある場合を除きrefresh_tokenを用いてネクストエンジンAPIを利用することを推奨致します。 **※ 悪意のある攻撃者にユーザーのaccess_token、refresh_tokenが漏洩すると、ユーザーのデータが漏洩し続けてしまう可能性がありますaccess_token、refresh_tokenは漏洩しないように、細心のご注意をお願い致します。** ### 利用方法 #### SDKを利用する方 自動的に認証され利用されます。 各エンドポイントにリクエスト後、access_token,refresh_tokenに変更があった場合はアプリ側でユーザ毎に保持する必要があります。（ネクストエンジンAPIからのレスポンス毎に保存するようにしてください） 以降はSDKのインスタンスを生成する時に、アプリ側で保存したaccess_tokenとrefresh_tokenを指定して下さい。 #### SDKを利用されない方 [認証フロー](/api/auth)を参考に[access_tokenの取得](/api/api_neauth)まで実施し、access_token及びrefresh_tokenを取得し目的のAPIを利用します。 各API利用後、access_token,refresh_tokenに変更があった場合は、アプリ側でユーザー(uid)毎にアプリ側で保持する必要があります。（APIを実行後、毎回保存しても問題ありません） 以降はAPIを利用する時に、アプリ側で保存したaccess_tokenとrefresh_tokenを指定して下さい。 ### 補足説明 - access_tokenの有効期限は1日、refresh_tokenの有効期限は3日です。有効期限は、「最初にaccess_tokenを発行した日時、又は最後にaccess_tokenの有効期限が切れてaccess_tokenが更新された日時からの日数」です - バッチ等認証なしで定期的にAPIを利用する場合、2日より前に定期的にAPIを実施し有効期限が切れないように利用することを推奨します（refresh_tokenの有効期限も切れた際は、access_tokenの有効期限切れと同じ002004のエラーになります。新しいaccess_tokenが発行されたにもかかわらず、古いaccess_tokenで実行した場合は、002002のエラーになります） - 同一ユーザーに対してマルチスレッドでAPIを利用する事は推奨しません（access_token,refresh_tokenが更新されたタイミングで、同一ユーザーに対する全スレッドのaccess_token,refresh_tokenも更新された値に変更する必要があり、アプリ側のaccess_token,refresh_tokenの管理が困難になる為） - access_token・refresh_tokenの更新は、リクエストが[エラーになった場合](/api/param/message)も更新されます。access_token・refresh_tokenをアプリで保持する際はエラー時も保持するようにして下さい --- # 企業-フィールド URL: https://developer.next-engine.com/guides/fields/login_company/ ### 企業 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 企業名 | `company_name` | 文字列型 | | | 企業名カナ | `company_kana` | 文字列型 | | | 郵便番号 | `company_zip_code` | 文字列型 | | | 住所1 | `company_address1` | 文字列型 | | | 住所2 | `company_address2` | 文字列型 | | | 部署名 | `company_post_name` | 文字列型 | | | 担当者名 | `company_pic_name` | 文字列型 | | | メールアドレス | `company_mail_address` | 文字列型 | | | 電話番号 | `company_phone` | 文字列型 | | | FAX | `company_fax` | 文字列型 | | | 企業URL | `company_url` | 文字列型 | | | 締日 | `company_closing_day` | 文字列型 | | | 最終締日 | `company_last_closing_date` | 日時型 | | | 端数処理桁数 | `company_fraction_number_digit` | 数値型 | | | 端数処理区分 | `company_fraction_id` | 文字列型 | | | 端数処理名 | `company_fraction_name` | 文字列型 | | | 税抜き・税込み区分 | `company_tax_id` | 文字列型 | | | 税抜き・税込み名 | `company_tax_name` | 文字列型 | | | 一時利用停止フラグ | `company_temporarily_suspend_flag` | 文字列型 | | | 有効日 | `company_available_date` | 日時型 | | | 無効日 | `company_unavailable_date` | 日時型 | | | 通知先メールアドレス | `company_notice_mail_address` | 文字列型 | | | 仕入れタイプ | `company_buying_type` | 文字列型 | | | バッチタイプ | `company_batch_type` | 文字列型 | | | クーポンコード | `company_coupon_code` | 文字列型 | | | 企業区分 | `company_type_id` | 文字列型 | | | IPアドレス | `company_ip_address` | 文字列型 | | | 明細ソート | `company_row_order` | 数値型 | | | メイン機能企業ID | `company_id` | 文字列型 | アプリを起動した企業の「メイン機能単位」で一意になるID。１つの企業が複数のメイン機能を所有することがあります。 | | ネクストエンジン企業ID | `company_ne_id` | 文字列型 | アプリを起動した企業の一意になるID。 | | メイン機能ホスト | `company_host` | 文字列型 | | | 現在の税率 | `company_now_tax_percent` | 数値型 | 10%の場合、10 | | 値引きの優先適用先 | `company_primary_tax_rate_for_discount` | 数値型 | NULL:按分10:10%8:8%0:0% | | 適格請求書発行事業者の登録番号 | `company_invoice_registration_number` | 文字列型 | | | ヒット商品お知らせ期間 | `company_hit_syohin_alert_hour` | 数値型 | 0の場合、お知らせしない | | ヒット商品お知らせ個数 | `company_hit_syohin_alert_quantity` | 数値型 | 全商品に対して有効です。商品マスタに商品ごとの設定がある場合は、そちらが優先されます。 | | 作成日 | `company_creation_date` | 日時型 | | | 最終更新日 | `company_last_modified_date` | 日時型 | | | 作成担当者ID | `company_creator_id` | 数値型 | | | 作成担当者名 | `company_creator_name` | 文字列型 | | | 最終更新者ID | `company_last_modified_by_id` | 数値型 | | | 最終更新者名 | `company_last_modified_by_name` | 文字列型 | | | 最終更新日(NULL安全) | `company_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 最終更新者ID(NULL安全) | `company_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名(NULL安全) | `company_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | | アプリヘッダ | `company_app_header` | 文字列型 | | --- # ログインユーザー-フィールド URL: https://developer.next-engine.com/guides/fields/login_pic/ ### ログインユーザー | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | メイン機能担当者ID | `pic_id` | 数値型 | アプリを起動したユーザーの「メイン機能・ユーザー単位」で一意になるID | | 担当者名 | `pic_name` | 文字列型 | | | 担当者カナ | `pic_kana` | 文字列型 | | | 部署名 | `pic_post_name` | 文字列型 | | | 社会保険区分 | `pic_social_insurance_id` | 文字列型 | | | 社会保険名 | `pic_social_insurance_name` | 文字列型 | | | 誕生日 | `pic_birth_date` | 日時型 | | | 郵便番号 | `pic_zip_code` | 文字列型 | | | 住所1 | `pic_address1` | 文字列型 | | | 住所2 | `pic_address2` | 文字列型 | | | 携帯番号 | `pic_mobile` | 文字列型 | | | 電話番号 | `pic_phone` | 文字列型 | | | メールアドレス | `pic_mail_address` | 文字列型 | | | 入社日 | `pic_entering_company_date` | 日時型 | | | 退職日 | `pic_retirement_date` | 日時型 | | | 担当店舗コードリスト | `pic_charge_shop_id_list` | 文字列型 | | | テンプレートフラグ | `pic_template_flag` | 文字列型 | | | スキンカラー | `pic_skin_color` | 文字列型 | | | 言語コード | `pic_language_code` | 文字列型 | | | uid | uid | 文字列型 | アプリを起動したユーザーの「購入アプリ・ユーザー単位」で一意になるID | | ネクストエンジン担当者ID | `pic_ne_id` | 文字列型 | アプリを起動したユーザーの「ユーザー単位」で一意になるID | | 削除フラグ | `pic_deleted_flag` | 文字列型 | | | 作成日 | `pic_creation_date` | 日時型 | | | 最終更新日 | `pic_last_modified_date` | 日時型 | | | 作成担当者ID | `pic_creator_id` | 数値型 | | | 作成担当者名 | `pic_creator_name` | 文字列型 | | | 最終更新者ID | `pic_last_modified_by_id` | 数値型 | | | 最終更新者名 | `pic_last_modified_by_name` | 文字列型 | | --- # 商品マスタ-フィールド URL: https://developer.next-engine.com/guides/fields/master_goods/ ### 商品マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_id` | 文字列型 | | | 代表商品コード | `goods_representation_id` | 文字列型 | | | 商品名 | `goods_name` | 文字列型 | | | 英語商品名 | `goods_foreign_name` | 文字列型 | | | 商品区分 | `goods_type_id` | 文字列型 | | | 商品区分名 | `goods_type_name` | 文字列型 | | | 取扱区分 | `goods_merchandise_id` | 文字列型 | | | 取扱区分名 | `goods_merchandise_name` | 文字列型 | | | 輸送方法指定 | `goods_forwarding_method_id` | 文字列型 | | | 輸送方法指定名 | `goods_forwarding_method_name` | 文字列型 | | | 商品ステータス区分 | `goods_status_id` | 文字列型 | | | 商品ステータス名 | `goods_status_name` | 文字列型 | | | 発送方法区分 | `goods_delivery_id` | 文字列型 | 商品マスタの配送業者の区分値 | | 発送方法名 | `goods_delivery_name` | 文字列型 | 商品マスタの配送業者の名称 | | 仕入先コード | `goods_supplier_id` | 文字列型 | | | JANコード | `goods_jan_code` | 文字列型 | | | メーカー名 | `goods_maker_name` | 文字列型 | | | メーカーカナ | `goods_maker_kana` | 文字列型 | | | メーカー住所 | `goods_maker_address` | 文字列型 | | | メーカー郵便番号 | `goods_maker_zip_code` | 文字列型 | | | 型番 | `goods_model_number` | 文字列型 | | | 色 | `goods_color` | 文字列型 | | | モールカテゴリ | `goods_mall_category` | 文字列型 | | | 店舗カテゴリ | `goods_shop_category` | 文字列型 | | | 原価 | `goods_cost_price` | 数値型 | | | 定価 | `goods_display_price` | 数値型 | | | 売価単価 | `goods_selling_price` | 数値型 | | | 外国売価単価 | `goods_foreign_selling_price` | 数値型 | | | 消費税率（%） | `goods_tax_rate` | 数値型 | | | 掛率 | `goods_wholesale_retail_ratio` | 数値型 | | | 重さ | `goods_weight` | 数値型 | | | 幅 | `goods_width` | 数値型 | | | 奥行き | `goods_length` | 数値型 | | | 高さ | `goods_height` | 数値型 | | | 発売日 | `goods_release_date` | 日時型 | | | 初販売日 | `goods_first_time_sold_date` | 日時型 | | | 最終販売日 | `goods_last_time_sold_date` | 日時型 | | | 初仕入れ日 | `goods_first_time_supplied_date` | 日時型 | | | 最終仕入れ日 | `goods_last_time_supplied_date` | 日時型 | | | 在庫定数 | `goods_stock_constant` | 数値型 | | | 発注点 | `goods_order_point` | 数値型 | | | ロット | `goods_lot` | 数値型 | | | 掲載日 | `goods_publication_date` | 日時型 | | | 在庫管理フラグ | `goods_stock_management_flag` | 文字列型 | | | 備考 | `goods_note` | 文字列型 | | | 表示フラグ | `goods_visible_flag` | 文字列型 | | | 商品分類タグ | `goods_tag` | 文字列型 | 値は名称値(goods_tag_name)が設定されている。複数設定可能。 | | ロケーション | `goods_location` | 文字列型 | | | メール便可否フラグ | `goods_delivery_mail_flag` | 数値型 | | | メール便最大数量 | `goods_delivery_mail_maximum_quality` | 文字列型 | | | ギフト可フラグ | `goods_gift_ok_flg` | 数値型 | | | サイズ | `goods_size` | 文字列型 | | | メーカー型番 | `goods_maker_model_number` | 文字列型 | | | 在庫アラートメール閾値 | `goods_stock_alert_mail_threshold` | 数値型 | | | 卸引当用敷居値 | `goods_wholesale_mortgage_threshold` | 数値型 | | | 発送元コード | `goods_shipping_base_id` | 文字列型 | | | メールタグ | `goods_mail_tag_id` | 文字列型 | | | 項目１ | `goods_1_item` | 文字列型 | | | 項目２ | `goods_2_item` | 文字列型 | | | 項目３ | `goods_3_item` | 文字列型 | | | 項目４ | `goods_4_item` | 文字列型 | | | 項目５ | `goods_5_item` | 文字列型 | | | 項目６ | `goods_6_item` | 文字列型 | | | 項目７ | `goods_7_item` | 文字列型 | | | 項目８ | `goods_8_item` | 文字列型 | | | 項目９ | `goods_9_item` | 文字列型 | | | 項目１０ | `goods_10_item` | 文字列型 | | | 項目１１ | `goods_11_item` | 文字列型 | | | 項目１２ | `goods_12_item` | 文字列型 | | | 項目１３ | `goods_13_item` | 文字列型 | | | 項目１４ | `goods_14_item` | 文字列型 | | | 項目１５ | `goods_15_item` | 文字列型 | | | 項目１６ | `goods_16_item` | 文字列型 | | | 項目１７ | `goods_17_item` | 文字列型 | | | 項目１８ | `goods_18_item` | 文字列型 | | | 項目１９ | `goods_19_item` | 文字列型 | | | 項目２０ | `goods_20_item` | 文字列型 | | | 選択肢ID１ | `goods_1_select_id` | 数値型 | | | 選択肢名１ | `goods_1_select_name` | 文字列型 | | | 選択肢ID２ | `goods_2_select_id` | 数値型 | | | 選択肢名２ | `goods_2_select_name` | 文字列型 | | | 選択肢ID３ | `goods_3_select_id` | 数値型 | | | 選択肢名３ | `goods_3_select_name` | 文字列型 | | | 選択肢ID４ | `goods_4_select_id` | 数値型 | | | 選択肢名４ | `goods_4_select_name` | 文字列型 | | | 選択肢ID５ | `goods_5_select_id` | 数値型 | | | 選択肢名５ | `goods_5_select_name` | 文字列型 | | | 選択肢ID６ | `goods_6_select_id` | 数値型 | | | 選択肢名６ | `goods_6_select_name` | 文字列型 | | | 選択肢ID７ | `goods_7_select_id` | 数値型 | | | 選択肢名７ | `goods_7_select_name` | 文字列型 | | | 選択肢ID８ | `goods_8_select_id` | 数値型 | | | 選択肢名８ | `goods_8_select_name` | 文字列型 | | | 選択肢ID９ | `goods_9_select_id` | 数値型 | | | 選択肢名９ | `goods_9_select_name` | 文字列型 | | | 選択肢ID１０ | `goods_10_select_id` | 数値型 | | | 選択肢名１０ | `goods_10_select_name` | 文字列型 | | | 掲載担当者ID | `goods_publication_pic_id` | 数値型 | | | 掲載担当者名 | `goods_publication_pic_name` | 文字列型 | | | 卸在庫数 | `goods_stock_wholesale_quantity` | 数値型 | | | 商品説明（テキスト） | `goods_description_text` | 文字列型 | | | 商品説明（HTML） | `goods_description_html` | 文字列型 | | | スペック（テキスト） | `goods_spec_text` | 文字列型 | | | スペック（HTML） | `goods_spec_html` | 文字列型 | | | 注意事項（テキスト） | `goods_caution_text` | 文字列型 | | | 注意事項（HTML） | `goods_caution_html` | 文字列型 | | | 商品状態説明 | `goods_condition_description` | 文字列型 | | | 商品状態ID | `goods_condition_id` | 文字列型 | 01:新品 10:中古 99:その他 | | ヒット商品お知らせ個数 | `goods_hit_syohin_alert_quantity` | 数値型 | | | 納期ID | `goods_delivery_date_id` | 文字列型 | | | 納期指定日 | `goods_designated_delivery_date` | 文字列型 | 納期IDが'date'の場合のみ有効 | | パッケージ込みの高さ(cm) | `goods_package_height` | 数値型 | | | パッケージ込みの幅(cm) | `goods_package_width` | 数値型 | | | パッケージ込みの奥行き(cm) | `goods_package_length` | 数値型 | | | パッケージ込みの重さ(g) | `goods_package_weight` | 数値型 | | | 販売開始日 | `goods_first_available_date` | 日時型 | | | 販売終了日 | `goods_last_available_date` | 日時型 | | | 消費税 | `goods_tax_id` | 数値型 | 0:税別 1:税込 2:非課税 | | ブランド名 | `goods_brand_name` | 文字列型 | | | 原産地 | `goods_origin_place` | 文字列型 | | | 原材料 | `goods_raw_materials` | 文字列型 | | | 保存方法 | `goods_preservation_method` | 文字列型 | | | 保証書の有無 | `goods_warranty` | 数値型 | 0:なし 1:あり | | のし対応 | `goods_option_noshi_id` | 数値型 | 0:対応しない 1:対応する | | 当日・翌日配送 | `goods_same_day_delivery_id` | 数値型 | 1:当日 2:翌日 | | 作成日 | `goods_creation_date` | 日時型 | | | 最終更新日 | `goods_last_modified_date` | 日時型 | | | 最終更新日 | `goods_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_creator_id` | 数値型 | | | 作成担当者名 | `goods_creator_name` | 文字列型 | | | 最終更新者ID | `goods_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 商品カテゴリ-フィールド URL: https://developer.next-engine.com/guides/fields/master_goods_category/ ### 商品カテゴリ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品カテゴリID | `goods_category_id` | 数値型 | | | 商品コード | `goods_category_goods_id` | 文字列型 | | | モールコード | `goods_category_mall_id` | 数値型 | | | カテゴリ(ID) | `goods_category_mall_category_id` | 数値型 | モールの場合、本カラムにモールカテゴリIDが設定される | | カテゴリ(テキスト) | `goods_category_text` | 文字列型 | カートの場合、本カラムに店舗カテゴリのテキストが設定される | | 削除フラグ | `goods_category_deleted_flag` | 文字列型 | | | 作成日 | `goods_category_creation_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_date` | 日時型 | | | 最終更新日 | `goods_category_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_category_creator_id` | 数値型 | | | 作成担当者名 | `goods_category_creator_name` | 文字列型 | | | 最終更新者ID | `goods_category_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_category_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_category_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_category_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 商品別卸先マスタ-フィールド URL: https://developer.next-engine.com/guides/fields/master_goods_wholesale/ ### 商品別卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 商品コード | `goods_wholesale_goods_id` | 文字列型 | | | 卸先コード | `goods_wholesale_wholesale_id` | 文字列型 | | | 商品別卸先掛率 | `goods_wholesale_wholesale_retail_ratio` | 数値型 | | | 作成日 | `goods_wholesale_creation_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `goods_wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `goods_wholesale_creator_id` | 数値型 | | | 作成担当者名 | `goods_wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `goods_wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `goods_wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `goods_wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 店舗マスタ-フィールド URL: https://developer.next-engine.com/guides/fields/master_shop/ ### 店舗マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗ID | `shop_id` | 数値型 | | | 店舗名 | `shop_name` | 文字列型 | | | 店舗名カナ | `shop_kana` | 文字列型 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | 閉店日 | `shop_close_date` | 日時型 | | | 備考 | `shop_note` | 文字列型 | | | モールID | `shop_mall_id` | 数値型 | | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | | オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | | | 税区分ID | `shop_tax_id` | 文字列型 | | | 税区分名 | `shop_tax_name` | 文字列型 | | | 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | | | 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | 削除フラグ | `shop_deleted_flag` | 文字列型 | | | 作成日 | `shop_creation_date` | 日時型 | | | 最終更新日 | `shop_last_modified_date` | 日時型 | | | 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `shop_creator_id` | 数値型 | | | 作成担当者名 | `shop_creator_name` | 文字列型 | | | 最終更新者ID | `shop_last_modified_by_id` | 数値型 | | | 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 在庫入出庫履歴-フィールド URL: https://developer.next-engine.com/guides/fields/master_stockiohistory/ ### 在庫入出庫履歴 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 在庫入出庫履歴ID | `stock_io_history_id` | 数値型 | | | 店舗コード | `stock_io_history_shop_id` | 数値型 | | | 商品コード | `stock_io_history_goods_id` | 文字列型 | | | 入出庫日 | `stock_io_history_date` | 日時型 | | | 更新前在庫数 | `stock_io_history_before_stock_quantity` | 数値型 | | | 更新後在庫数 | `stock_io_history_after_stock_quantity` | 数値型 | | | 更新前不良在庫数 | `stock_io_history_before_bad_stock_quantity` | 数値型 | | | 更新後不良在庫数 | `stock_io_history_after_bad_stock_quantity` | 数値型 | | | 入出庫数 | `stock_io_history_quantity` | 数値型 | | | 伝票番号 | `stock_io_history_cut_form_id` | 数値型 | 入出庫した処理別の伝票番号が設定される。例えば受注伝票により出庫された場合は受注伝票の伝票番号が設定される。 | | 入出庫フラグ | `stock_io_history_io_flag` | 文字列型 | 0:入庫、1:出庫 | | 入出庫区分 | `stock_io_history_io_type_id` | 文字列型 | | | 入出庫名 | `stock_io_history_io_type_name` | 文字列型 | | | 事由 | `stock_io_history_reason` | 文字列型 | | | 担当者ID | `stock_io_history_pic_id` | 数値型 | | | 担当者名 | `stock_io_history_pic_name` | 文字列型 | | | 削除フラグ | `stock_io_history_deleted_flag` | 文字列型 | | | 作成日 | `stock_io_history_creation_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_date` | 日時型 | | | 最終更新日 | `stock_io_history_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `stock_io_history_creator_id` | 数値型 | | | 作成担当者名 | `stock_io_history_creator_name` | 文字列型 | | | 最終更新者ID | `stock_io_history_last_modified_by_id` | 数値型 | | | 最終更新者ID | `stock_io_history_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `stock_io_history_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `stock_io_history_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 卸先マスタ-フィールド URL: https://developer.next-engine.com/guides/fields/master_wholesale/ ### 卸先マスタ | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 卸先コード | `wholesale_id` | 文字列型 | | | 卸先名 | `wholesale_name` | 文字列型 | | | 卸先カナ | `wholesale_kana` | 文字列型 | | | 部署名 | `wholesale_post_name` | 文字列型 | | | 郵便番号 | `wholesale_zip_code` | 文字列型 | | | 住所1 | `wholesale_address1` | 文字列型 | | | 住所2 | `wholesale_address2` | 文字列型 | | | 電話番号 | `wholesale_phone` | 文字列型 | | | FAX番号 | `wholesale_fax` | 文字列型 | | | メールアドレス | `wholesale_mail_address` | 文字列型 | | | 送付先名 | `wholesale_destination_pic_name` | 文字列型 | | | 送付先カナ | `wholesale_destination_pic_kana` | 文字列型 | | | 送付先郵便番号 | `wholesale_destination_zip_code` | 文字列型 | | | 送付先住所1 | `wholesale_destination_address1` | 文字列型 | | | 送付先住所2 | `wholesale_destination_address2` | 文字列型 | | | 送付先電話番号 | `wholesale_destination_phone` | 文字列型 | | | 発送方法区分 | `wholesale_delivery_id` | 文字列型 | | | 発送方法名 | `wholesale_delivery_name` | 文字列型 | | | 支払区分 | `wholesale_payment_method_id` | 文字列型 | | | 支払名 | `wholesale_payment_method_name` | 文字列型 | | | 掛率 | `wholesale_retail_ratio` | 数値型 | | | 卸先番号 | `wholesale_destination_no` | 数値型 | | | 与信枠（円） | `wholesale_credit_line_price` | 数値型 | | | 締日 | `wholesale_closing_day` | 数値型 | | | 備考 | `wholesale_note` | 文字列型 | | | 削除フラグ | `wholesale_deleted_flag` | 文字列型 | | | 作成日 | `wholesale_creation_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_date` | 日時型 | | | 最終更新日 | `wholesale_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `wholesale_creator_id` | 数値型 | | | 作成担当者名 | `wholesale_creator_name` | 文字列型 | | | 最終更新者ID | `wholesale_last_modified_by_id` | 数値型 | | | 最終更新者ID | `wholesale_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `wholesale_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `wholesale_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 受注伝票-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_base/ ### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `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_unattended_delivery_flg` | 文字列型 | 0:置き配指定なし 1:置き配指定あり | | 置き配場所名称 | `receive_order_unattended_delivery_location_name` | 文字列型 | 例：宅配ボックス、玄関前、メータボックス | | 発送伝票番号 | `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の場合作成者名 | --- # 受注確認内容-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_confirm/ ### 受注確認内容 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注確認内容ID | `confirm_id` | 文字列型 | | | 受注確認内容 | `confirm_name` | 文字列型 | 詳細はこちら | | 表示順序 | `confirm_display_order` | 数値型 | | | 説明文(HTML) | `confirm_html` | 文字列型 | 改行や強調表示のHTMLが含まれています | | 設定値 | `confirm_value` | 文字列型 | 受注確認内容設定画面で設定した値（設定可能な項目のみ） | | 有効フラグ | `confirm_valid_flag` | 数値型 | 1:有効 1以外:無効 | | 削除フラグ | `confirm_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `confirm_creation_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_date` | 日時型 | | | 最終更新日 | `confirm_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `confirm_creator_id` | 数値型 | | | 作成担当者名 | `confirm_creator_name` | 文字列型 | | | 最終更新者ID | `confirm_last_modified_by_id` | 数値型 | | | 最終更新者ID | `confirm_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `confirm_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `confirm_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 発送方法区分-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_forwardingagent/ ### 発送方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発送方法区分 | `forwarding_agent_id` | 文字列型 | 発送方法区分のdelivery_idと紐付きます | | 発送方法別項目タイプ | `forwarding_agent_type` | 文字列型 | 値は次の通り。binsyu_kbn:便種、eigyosyo_dome_kbn:営業所止め、jikantaisitei_kbn:時間帯、okurijyo_kbn:送り状、ondo_kbn:温度帯、seal1_kbn:シール1、seal2_kbn:シール2、seal3_kbn:シール3、seal4_kbn:シール4 | | 発送方法別項目区分 | `forwarding_agent_type_id` | 文字列型 | 各項目の区分値 | | 発送方法別項目名 | `forwarding_agent_type_name` | 文字列型 | 各項目の名称 | | 表示順序 | `forwarding_agent_display_order` | 数値型 | | | 削除フラグ | `forwarding_agent_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | --- # 受注伝票オプション-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_option/ ### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_option_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | | 受注時店舗原資クーポン | `receive_order_option_received_time_shop_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 受注時モール原資クーポン | `receive_order_option_received_time_mall_coupon` | 数値型 | 楽天とYahoo!に対応しています。 | | 作成日 | `receive_order_option_creation_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_option_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 作成担当者ID | `receive_order_option_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_option_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_option_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_option_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_option_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_option_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # 支払発送変換-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_payment_delivery_convert/ ### 支払発送変換 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 変換元テキスト | `payment_delivery_convert_text` | 文字列型 | CSV(API)などメイン機能に取り込む前の受注情報のテキスト | | 項目種類 | `payment_delivery_convert_type` | 文字列型 | 本項目の値と対応するオブジェクトは次の通り。 "siharai_kbn":支払区分 "hasou_kbn"：発送方法区分 "credit_kbn"：クレジット種類区分 "nyukin_kbn":入金区分 "jikantaisitei_kbn":発送方法区分の発送方法別項目タイプが"jikantaisitei_kbn" | | 各種ID | `payment_delivery_convert_multi_id` | 文字列型 | 項目種類で指定されたオブジェクトのID | | 発送方法区分 | `payment_delivery_convert_delivery_id` | 文字列型 | 項目種類が"jikantaisitei_kbn"の時のみ値がある | | 削除フラグ | `payment_delivery_convert_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `payment_delivery_convert_creation_date` | 日付型 | | | 最終更新日 | `payment_delivery_convert_last_modified_date` | 日付型 | | | 作成担当者ID | `payment_delivery_convert_creator_id` | 数値型 | | | 作成担当者名 | `payment_delivery_convert_creator_name` | 文字列型 | | | 最終更新者ID | `payment_delivery_convert_last_modified_by_id` | 数値型 | | | 最終更新者名 | `payment_delivery_convert_last_modified_by_name` | 文字列型 | | --- # 受注一括登録パターン-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_receive_order_upload_pattern/ ### 受注一括登録パターン | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注一括登録パターンID | `receive_order_upload_pattern_id` | 数値型 | | | 受注一括登録パターン名 | `receive_order_upload_pattern_name` | 文字列型 | | | 受注一括登録フォーマットパターンID | `receive_order_upload_pattern_format_id` | 数値型 | 参考資料：受注一括登録フォーマットパターンのIDと名称参照 | | 店舗ID | `receive_order_upload_pattern_shop_id` | 数値型 | | | 削除フラグ | `receive_order_upload_pattern_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `receive_order_upload_pattern_creation_date` | 日付型 | | | 最終更新日 | `receive_order_upload_pattern_last_modified_date` | 日付型 | | | 作成担当者ID | `receive_order_upload_pattern_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_upload_pattern_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_upload_pattern_last_modified_by_id` | 数値型 | | | 最終更新者名 | `receive_order_upload_pattern_last_modified_by_name` | 文字列型 | | --- # 参考資料：受注一括登録フォーマットパターンのID・名称-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_receive_order_upload_pattern_format/ ### 参考資料：受注一括登録フォーマットパターンのID・名称 | 受注一括登録フォーマットパターンID | 受注一括登録フォーマットパターン名 | | --- | --- | | 15 | Yahooオークション標準パターン | | 40 | DeNA BtoB market標準パターン | | 48 | ebay標準パターン | | 50 | 楽天全カラムDLパターン | | 90 | 汎用標準パターン | | 9001 | たまごリピートパターン | | 10001 | 楽天ペイ全カラムDLパターン | | 10003 | DeNAショッピングパターン | | 100011 | アマゾンパターン | | 100013 | おちゃのこネット（オーダーメイド対応）パターン | | 100014 | ショップサーブパターン | | 100019 | FutureShop2 パターン | | 100022 | Color Me Shop! Pro 2009-12 | | 100023 | `superdelivery` | | 100025 | マーキュリー備考欄ラッピング追加パターン | | 100026 | ワイズカートASP/ZERO | | 100034 | ヤマダモール（楽天互換形式 安定版）パターン | | 100035 | MakeShopパターン | | 100042 | ポンパレパターン | | 100043 | アマゾン海外パターン | | 100045 | LINE MALLパターン | | 200002 | YAHOOショッピング（ストアクリエイターPro）パターン | | 1000302 | Wow!manager全カラムDLパターン | --- # 受注明細-フィールド URL: https://developer.next-engine.com/guides/fields/receiveorder_row/ ### 受注明細 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 伝票番号 | `receive_order_row_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 | | 受注番号 | `receive_order_row_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） | | 明細行番号 | `receive_order_row_no` | 数値型 | ネクストエンジンで付与した明細行番号 | | 受注明細行番号 | `receive_order_row_shop_row_no` | 文字列型 | 店舗で付与された明細行番号 | | 商品コード | `receive_order_row_goods_id` | 文字列型 | | | 商品名 | `receive_order_row_goods_name` | 文字列型 | | | 受注数 | `receive_order_row_quantity` | 数値型 | | | 単価 | `receive_order_row_unit_price` | 数値型 | | | 受注時原価 | `receive_order_row_received_time_first_cost` | 数値型 | 受注時の商品マスタの原価。 | | 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | 小計金額 | `receive_order_row_sub_total_price` | 数値型 | 単価*(掛率/10)*受注数 | | 商品OP | `receive_order_row_goods_option` | 文字列型 | | | キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 同梱元伝票番号 | `receive_order_include_from_order_id` | 数値型 | | | 同梱元明細行番号 | `receive_order_include_from_row_no` | 数値型 | | | 複数配送親伝票番号 | `receive_order_row_multi_delivery_parent_order_id` | 数値型 | | | 分割元明細行番号 | `receive_order_row_divide_from_row_no` | 数値型 | | | 複写元明細行番号 | `receive_order_row_copy_from_row_no` | 数値型 | | | 引当数 | `receive_order_row_stock_allocation_quantity` | 数値型 | | | 予約引当数 | `receive_order_row_advance_order_stock_allocation_quantity` | 数値型 | | | 引当日 | `receive_order_row_stock_allocation_date` | 日時型 | | | 受注時取扱区分 | `receive_order_row_received_time_merchandise_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時取扱名 | `receive_order_row_received_time_merchandise_name` | 文字列型 | | | 受注時商品区分 | `receive_order_row_received_time_goods_type_id` | 文字列型 | 受注時の商品マスタの値が設定されます。 | | 受注時商品名 | `receive_order_row_received_time_goods_type_name` | 文字列型 | | | 良品返品数 | `receive_order_row_returned_good_quantity` | 数値型 | | | 不良品返品数 | `receive_order_row_returned_bad_quantity` | 数値型 | | | 返品事由区分 | `receive_order_row_returned_reason_id` | 文字列型 | | | 返品事由名 | `receive_order_row_returned_reason_name` | 文字列型 | | | 元受注明細行番号 | `receive_order_row_org_row_no` | 数値型 | | | 削除フラグ | `receive_order_row_deleted_flag` | 文字列型 | 1:有効 1以外:無効 | | 作成日 | `receive_order_row_creation_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_date` | 日時型 | | | 最終更新日 | `receive_order_row_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 | | 受注伝票・受注明細の最終更新日 | `receive_order_row_last_modified_newest_date` | 日時型 | 受注伝票と受注明細の内、より新しい方の最終更新日 | | 作成担当者ID | `receive_order_row_creator_id` | 数値型 | | | 作成担当者名 | `receive_order_row_creator_name` | 文字列型 | | | 最終更新者ID | `receive_order_row_last_modified_by_id` | 数値型 | | | 最終更新者ID | `receive_order_row_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID | | 最終更新者名 | `receive_order_row_last_modified_by_name` | 文字列型 | | | 最終更新者名 | `receive_order_row_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 | --- # オーソリ区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_authorizationtype/ ### オーソリ区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | オーソリ区分名 | `authorizationtype_id` | 文字列型 | | | オーソリ名 | `authorizationtype_name` | 文字列型 | | --- # 受注キャンセル区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_canceltype/ ### 受注キャンセル区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注キャンセル区分 | `cancel_type_id` | 文字列型 | | | 受注キャンセル名 | `cancel_type_name` | 文字列型 | | | 非表示フラグ | `cancel_type_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | --- # クレジット承認区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_creditapprovaltype/ ### クレジット承認区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | クレジット承認区分 | `credit_approval_type_id` | 文字列型 | | | クレジット承認名 | `credit_approval_type_name` | 文字列型 | | --- # クレジット種類区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_credittype/ ### クレジット種類区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | クレジット種類区分 | `credit_type_id` | 文字列型 | | | クレジット名 | `credit_type_name` | 文字列型 | | --- # 通貨単位区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_currencyunit/ ### 通貨単位区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 通貨単位区分名 | `currencyunit_id` | 文字列型 | | | 通貨単位名 | `currencyunit_name` | 文字列型 | | --- # 顧客区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_customertype/ ### 顧客区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 顧客区分 | `customer_type_id` | 文字列型 | | | 顧客名 | `customer_type_name` | 文字列型 | | --- # 発送方法区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_delivery/ ### 発送方法区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 発送方法区分 | `delivery_id` | 文字列型 | | | 発送方法名 | `delivery_name` | 文字列型 | | | 非表示フラグ | `delivery_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | --- # 納期-フィールド URL: https://developer.next-engine.com/guides/fields/system_delivery_date/ ### 納期 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 納期ID | `delivery_date_id` | 文字列型 | | | 納期名 | `delivery_date_name` | 文字列型 | | | 納期日数 | `delivery_date_days` | 文字列型 | | | 備考 | `delivery_date_note` | 文字列型 | | --- # 入金区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_deposittype/ ### 入金区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 入金区分 | `deposit_type_id` | 文字列型 | | | 入金名 | `deposit_type_name` | 文字列型 | | --- # モール/カート-フィールド URL: https://developer.next-engine.com/guides/fields/system_mall/ ### モール/カート | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | モール/カートID | `mall_id` | 数値型 | | | モール/カート名 | `mall_name` | 文字列型 | | | モール/カートカナ | `mall_kana` | 文字列型 | | | 備考 | `mall_note` | 文字列型 | | | 国ID | `mall_country_id` | 文字列型 | | | 削除フラグ | `mall_deleted_flag` | 文字列型 | | --- # 受注状態区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_orderstatus/ ### 受注状態区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 受注状態区分 | `order_status_id` | 文字列型 | | | 受注状態名 | `order_status_name` | 文字列型 | | --- # 支払区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_paymentmethod/ ### 支払区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 支払区分 | `payment_method_id` | 文字列型 | | | 支払名 | `payment_method_name` | 文字列型 | | | 非表示フラグ | `payment_method_deleted_flag` | 数値型 | 1:非表示になっている区分 0:表示されている区分 | --- # 税区分-フィールド URL: https://developer.next-engine.com/guides/fields/system_tax/ ### 税区分 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 税区分 | `tax_id` | 文字列型 | | | 税名 | `tax_name` | 文字列型 | | --- # コミュニティ URL: https://developer.next-engine.com/guides/forum/guideline/ ## 投稿 投稿は次の2とおりの方法です。 ### 1. コミュニティへの投稿 オープンな投稿です。 例えばアプリの開発中にわからないことがあったら、まずはここに投稿してみてください。 誰もが閲覧できるので個人情報や認証情報など公開してはいけないものが含まれないよう注意してください。 #### 投稿の方法 1. 次の項目にそれぞれ内容を書いてください。 - `件名` - `コミュニティ` - `本文` 2. `保存` ボタンを押してください。 ### 2. 運営への投稿 クローズドな投稿です。 Developer Networkの運営者への直接的な投稿です。 いろいろな理由でコミュニティに公開できない場合はこちらに投稿してください。 #### 投稿の方法 1. 次の項目にそれぞれ内容を書いてください。 - `件名` - `コミュニティ` - `本文` 2. `ステート` を`非公開`にしてください。 3. `保存` ボタンを押してください。 ## 公開について 投稿されたものはすぐに公開されません。その前にDeveloper Networkの運営者が内容を確認します。 内容を確認した後にコミュニティに公開されます。 そのため公開されるまで時間がかかることがあります。ご了承ください。 下記に該当するものは公開を制限したり、内容を一部変更する場合があります。ご了承ください。 - 開発と関係がないもの - 広告とみなされるもの - 個人情報や認証情報を含むもの - 誹謗や中傷 - その他、このコミュニティに不適切なもの ## 開発以外の質問 これまでのどおり、メイン機能のマニュアルを見るか、サポート窓口にお尋ねください。 --- # 利用規約 URL: https://developer.next-engine.com/guides/legal/ ネクストエンジン Developer Network利用規約 ネクストエンジン Developer Network利用規約（以下「本利用規約」といいます。）は、NE株式会社（以下「当社」といいます。）が運営するネクストエンジン Developer Network（以下「本サービス」といいます。）の提供条件及び当社と利用者との間の権利義務関係が定められています。本サービスの利用に際しては、本利用規約の全文をお読みいただいたうえで、本利用規約に同意頂く必要があります。利用者は、本サービスを実際に利用することによって本利用規約に有効かつ取消不能な同意をしたものとみなされます。 第1条（利用規約の適用範囲および変更） １．本利用規約は、NE株式会社（以下「当社」といいます。）が運営するネクストエンジンアプリ開発者向けコミュニティサービス（以下「本サービス」といいます。）本サービスをご利用いただく際の、当社と利用者との間の一切の関係に適用します。 ２．会員とは、所定の方法により会員登録をした者及び当社が発行するネクストエンジンIDを保有する者をいい、利用者とは、会員を含む当社が提供する本サービスを利用する全ての者とします。利用者は、本利用規約に同意のうえ、本サービスを利用するものとします。 ３．当社は、利用者に事前告知をすることなく、本利用規約を変更することができます。本利用規約が変更された場合、変更後の規約が適用されるものとし、利用者は変更後の規約に同意したものとみなされます。 第2条（本サービスの概要と範囲） １．本サービスは、ネクストエンジンアプリの開発に関する各種情報の提供や、会員間におけるネクストエンジンアプリの開発に関する質問と回答（当社が質問に回答することもあります）の形式による情報交換、利用者における情報収集および閲覧の機会ならびにそれらの環境を提供することを目的とします。 ２．当社は、利用者に事前告知することなく、本サービスに新しいサービスを追加、または変更することができるものとします。 第3条（会員に関する情報の開示と利用） １．当社は原則として、会員が会員登録および本サービスの利用において当社に対して開示した個人情報（以下「会員情報」といいます）のうち、本サービス上で開示される会員情報以外の会員情報について、事前の同意なく当社が第三者に対しこれらの会員情報を開示することはありません。ただし、公的機関からの照会および当社が法令によって開示義務を負う場合等はその限りではありません。 ２．会員は、会員登録の際に当社に開示した情報に変更が生じた場合には、速やかに変更登録を行うものとします。 ３．当社は、会員情報を当社が有益だと判断する情報（当社、広告主および提携先の商品、サービスなどの情報を含む）を提供する目的で利用することができるものとします。 ４．当社は、本サービスの向上および当社のマーケティング等の目的で会員情報を集計および分析などをするものとします。 ５．会員情報は、当社のプライバシーポリシーに従い、当社が管理します。 ６．会員は、本条に定めるとおりに当社が会員情報を扱い、保有することに同意し、異議を申し立てないこととします。 7．当社は、本サービスの運営を第三者に委託する場合があります。その場合、委託先に対し、会員情報を会員の同意を得ることなく、開示することがありますが、当社は委託先について責任を持って、管理いたします。 第4条（会員IDとパスワードの管理） 会員は、会員本人の責任の下で会員IDやパスワードを管理するものとし、パスワードの盗用、不正利用その他の事情により当該会員以外の者が本サービスを利用し会員に損害が生じた場合でも、入力された会員IDおよびパスワードが登録されたものと一致することを所定の方法により確認したとき、当該会員による本サービスの利用があったものとみなし、当社は一切の責任を負わないものとします。 第5条（会員資格の取消） １．当社は、会員が以下の事由に該当すると判断した場合には、事前に通知することなく、かつ、会員の承諾を得ることなく、当該会員による本サービスの利用停止、当該会員のパスワードなどの変更、または当該会員の会員資格の取消しを行うことができるものとし、当該理由を開示する義務を負わないものとします。 （1） 本利用規約に違反した場合 （2） 会員登録の際の記入事項に虚偽があることが判明した場合 （3） パスワードを不正に使用した場合 （4） 本サービスによって提供された情報を不正に使用した場合 （5） 当該会員が利用者、第三者および当社に損害を与える危険があると判断した場合 （6） 第9条に定める禁止事項に定める行為を行った場合 （7） その他、当社が本サービスの利用について不適当と判断した場合 ２．会員が前項各号に該当するため、当社が前項に定める措置をとった場合において、当該会員に損害が発生したとしても、当社は一切責任を負わないものとします。 第6条（質問の投稿） １．会員は、本サービスにより、ネクストエンジンアプリの開発に関する質問及び補足質問を投稿することができます。 ２．投稿された質問及び補足質問については、本利用規約第9条の禁止事項に該当するか否か等を当サービスの運営者（以下「運営者」といいます。）が審査し、審査時点で掲載することが不適切であると運営者が判断した場合を除き、当サイトに掲載いたします。 ３．当社は、投稿された質問及び補足質問について当サイトに掲載する義務を負いません。 第7条（質問への回答） １．会員は、本サービスにより、当サイトに掲載されたネクストエンジンアプリの開発に関する質問及び補足質問の回答を投稿することができます。なお、当社が当該質問及び補足質問について回答を投稿することもあります。 ２．当社は、投稿された回答について当サイトに掲載する義務を負いません。 第8条（免責事項） １．当社は、第6条2項にかかわらず、本サービスによって提供する当サイトに掲載された質問や回答等の情報の正確性、完全性などを保証するものではありません。当該情報に起因して利用者および第三者に損害が発生したとしても、当社は一切責任を負わないものとします。 ２．本サービス上に投稿された回答の履歴は本サービス上で公開されます。回答履歴の公開に伴い損害が発生したとしても、当社は一切責任を負わないものとします。 ３．当社は、利用者に発生した使用機会の逸失、データの滅失、業務の中断、またはあらゆる種類の損害（間接損害、特別損害、付随損害、派生損害、逸失利益を含みます）に対して、たとえ当社がかかる損害の可能性を事前に通知されていたとしても、一切責任を負わないものとします。 ４．当社は、利用者が本サービスの利用によって、他の利用者および第三者に対して損害を与え、生じた侵害および紛争に対し、また、利用者自身に損害が生じ、発生した侵害および紛争に対して、一切責任を負わないものとします。 ５．本サービスを受けるためのウェブサイトへの接続は、利用者が自己の費用で行うものとし、当社は一切の費用および責任を負わないものとします。 ６．会員登録の際に当社に開示した情報の変更登録がなされなかったことにより生じた損害について、当社は一切責任を負わないものとします。 第９条（禁止事項） １．当社は、利用者が本サービスを利用するにあたり、以下の事由に該当する行為を禁止します。  （1） 公序良俗に反する行為 （2） 犯罪的行為を助長、またはその実行を暗示する行為 （3） 利用者、第三者および当社の知的財産権、肖像権、パブリシティ権などの正当な権利を侵害する、または侵害のおそれがある行為 （4） 利用者または第三者の財産、信用、名誉またはプライバシーを侵害する、または侵害のおそれがある行為 （5） 他の利用者または第三者に無断で当該人物の個人を特定できる情報を公開する行為 （6） 会員が自己の責任に基づき掲載した内容の責任を負うことについて会員自身の明確な同意を条件に会員自身に関わる個人を特定できる情報の公開を許諾し 可能とするものとして当社が提供するスペース以外において、当該スペースで公開された情報以外の会員自身に関わる個人を特定できる情報を公開する行為 （7） 本サービスの提供される地域において法令に反する行為 （8） 他の利用者または第三者に不利益または損害を与える行為 （9） 他の利用者または第三者に対する誹謗中傷 （10） 営業や広告などに関する宣伝を目的にする行為 （11） 過度あるいは不適切に特定の外部Webサイトへ誘導することが目的と判断される行為 （12） 児童・若年者に対し悪影響があると判断される行為 （13） アダルトサイト・出会い系サイトなど年齢制限を有するサイトや、違法・有害サイトなどへのリンク行為 （14） 会員の資格を第三者に譲渡、貸与すること、または第三者と共用する行為 （15） 本サービスの運営を妨げる行為 （16） 当社の信用を毀損する行為 （17） 本利用規約に違反する行為 （18） その他、当社が不適当と判断する行為 ２．前項各号に該当する行為によって、当社が何らかの損害を被った場合には、当社が被った損害を、その利用者に賠償するよう請求することができるものとします。 第10条（投稿内容の変更および削除） １．当社は、以下の事由がある場合には、会員に承諾を得ることなく投稿、表示される内容を変更および削除することができるものとします。また、当社は投稿者である会員への対応業務に従事した者に係る人件費、その他の費用に相当する金額を含め、当社が被った損害を当該会員に賠償するよう請求することができるものとします。  （1） 法令または本利用規約などに違反したものである場合 （2） 第9条に定める禁止事項に該当する場合 （3） 当社が直ちに変更または削除する必要があると判断した場合 ２．当社は、会員から、その会員自身が投稿し、表示されている内容の変更、修正または削除の申し出を受けた場合でも、投稿し、表示されている内容の変更、修正および削除を行わないものとします。ただし、その投稿が、本サービス内で会員自身が任意に登録情報を削除・編集可能とする当社提供のスペース以外においてなされたものであって、かつ、その投稿し、表示されている内容が前項各号に該当する場合を除きます。 第11条（情報の無断使用の禁止） １．本サービス上の情報（文章、画像、イラストおよび動画などを含みます）の無断使用を禁止します。 ２．本サービスに関わる記載（ウェブ上での告知、メールマガジンなどを含みます）について、無断で編集、複製または転載することを禁止します。 ３．第1項または第2項に違反し、当社が何らかの損害を被った場合には、利用者は当社に対して損害の賠償をしなければならないものとします。 第12条（投稿内容の利用権） １．会員は、当社に対し、投稿内容のデータについて、世界的、非独占的、無償、サブライセンス可能かつ譲渡可能な使用、複製、編集、改編、掲載、転載、公衆送信、上映、展示、提供、販売、譲渡、貸与、翻訳、翻案、配布などができる権利および二次的著作物に関する現著作権者の権利（著作権法21条ないし28条の権利をいい、商用利用を含みます。）に関するライセンスを付与します。 ２．会員は、当サイトの質向上・宣伝・利用促進のため、投稿内容の編集、メタデータ等への配信、当社の別サイト内での掲載、当社が提携しているサイトへの掲載等を許可するものとします。 ３．会員は、当社及び当社から権利を承継しまたは許諾された者に対して投稿内容のデータについて著作者人格権を行使しないことに同意するものとします。 第13条（本サービスの一時的な中断) １．当社は以下の事由により、利用者に事前に連絡することなく、一時的に本サービスの提供を中断することがあります。本サービスの中断による損害について、当社は一切責任を負わないものとします。 （1） 当社のシステムの保守、点検、修理などを行う場合 （2） 火災、停電または天災地変により本サービスの提供ができなくなった場合 （3） 運用上または技術上、本サービスの提供ができなくなった場合 （4） その他、当社が中断をせざるを得ないと判断した場合 第14条（本サービスの追加・変更・停止・廃止） １．当社は、本サービスの内容を、利用者への事前告知なく追加または変更することができるものとします。 ２．当社は、本サービスを、利用者への事前告知なく停止または廃止することができるものとします。 ３．前2項に基づき利用者および第三者に損害が発生したとしても、当社は一切責任を負わないものとします。 第15条（連絡・通知） 本サービスに関する問い合わせその他利用者から当社に対する連絡または通知及び本利用規約の変更に関する通知その他当社から利用者に対する連絡または通知は、当社の定める方法で行うものとします。 第16条（サービス利用契約上の地位の譲渡等） １．会員は、当社の書面による事前の承諾なく、サービス利用契約上の地位または本利用規約に基づく権利もしくは義務につき、第三者に対し、譲渡、移転、担保設定、その他の処分をすることはできません。 ２．当社は本サービスにかかる事業を他社に譲渡した場合には、当該事業譲渡に伴いサービス利用契約上の地位、本利用規約に基づく権利及び義務並びに会員の登録事項その他の顧客情報を当該事業譲渡の譲受人に譲渡することができるものとし、会員は、かかる譲渡につき本項において予め同意したものとします。なお、本項に定める事業譲渡には、通常の事業譲渡のみならず、会社分割その他事業が移転するあらゆる場合を含むものとします。 第17条（反社会的勢力の排除について） １．利用者は本サービスを利用するにあたって、自身が反社会的勢力（「暴力団員による不当な行為の防止等に関する法律」に定義する暴力団およびその関係団体をいうほか、総会屋、社会運動や政治運動を標ぼうするゴロ、特殊知能暴力団等、その他反社会的勢力の総称をいいます）ではないことを表明し、将来にわたっても、所属もしくは該当、または関与していないことを確約するものとします。 ２．当社は、利用者が反社会的勢力に所属もしくは該当する、または関与していると判断した場合、当該利用者に事前に通知等を行うことなく、当該利用者による本サービスの利用停止、当該利用者のパスワードなどの変更、当該利用者の会員資格の取消しなど必要な措置をとることができるものとします。 第18条（国外からの利用） １．日本国外から本サービスを利用する場合、利用者は、居住国の法律および関係する国際条約に従うものとします。 ２．利用者が日本国外から本サービスを利用する場合において、本サービスの利用が居住国の法律および関係する国際条約に違反しないにもかかわらず、日本法に違反したために当該利用者に損害が発生したとき、または第三者に損害を発生させたときは、当社は一切責任を負わないものとします。 第19条（準拠法） 本利用規約は、日本法に準拠して解釈されるものとします。 第20条（管轄裁判所） 本サービスに関して当社と利用者との間で紛争が生じた際には、東京地方裁判所を第一審の専属的合意管轄裁判所とします。 第21条（分離可能性） 本利用規約のいずれかの規定が、法令の改廃、消費者契約法その他の特別法の適用、準拠法などの理由で、無効と判断された場合においても、本利用規約のその他の規定の有効性は、そのことにより一切影響を受けず、効力を維持するものとします。 第22条（本利用規約の効力） 本利用規約は平成28年12月1日から発効するものとします。 --- # access_token取得について-入出力パラメータ URL: https://developer.next-engine.com/guides/param/access_token/ ### access_token取得について 本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります ### access_token・refresh_tokenの取扱注意事項 アクセストークン(及びリフレッシュトークン)は、ユーザーのメイン機能の情報にアクセス出来る重要な情報です アクセストークン(及びリフレッシュトークン)の漏洩は、ユーザーのメイン機能の情報の漏洩に繋がる可能性があります 漏洩のリスクを下げる為にも、アプリケーションサーバー(及びアプリのDBサーバー)とAPIサーバーとの通信以外には使わないで下さい （ユーザーにアプリケーションサーバーからアクセストークン・リフレッシュトークンを返却する事も漏洩のリスクを高めてしまいます） ### 入力パラメータ 　　　　　　　　　　　　　　　　　　　　　　 | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | uid | uid・state取得により取得した値 | 必須 | | | `state` | uid・state取得により取得した値 | 必須 | | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | 必須 | | | `client_secret` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントシークレット | 必須 | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | メイン機能のデータにアクセスする為のトークン | access_tokenには有効期限(1日)があります。有効期限が切れないようにする為にも、各APIを実行する際にrefresh_tokenも指定することを推奨します | | `refresh_token` | access_tokenの有効期限が切れた際に、access_tokenを再発行する為のトークン | refresh_tokenには有効期限(3日)があります。有効期限が切れた場合はuid・state取得を呼ぶ必要があります | | `company_ne_id` | アプリを購入した企業のネクストエンジンで一意になるID | | | `company_name` | アプリを購入した企業の企業名 | | | `company_kana` | アプリを購入した企業の企業名かな | | | uid | アプリを起動したユーザーの「購入アプリとユーザー単位」で一意になるID | 同じユーザーでも複数同じアプリを利用した場合は、uidが別になります。同一人物か判定する場合はpic_ne_idを利用します | | `pic_ne_id` | アプリを起動したユーザーの「ユーザー単位」で一意になるID | メイン機能のpic_idとは別。１ユーザーが複数のメイン機能を使うケースがある | | `pic_name` | アプリを起動したユーザーの氏名 | | | `pic_kana` | アプリを起動したユーザーの氏名かな | | | `pic_mail_address` | アプリを起動したユーザーのメールアドレス | | --- # アプリの利用企業一覧について-入出力パラメータ URL: https://developer.next-engine.com/guides/param/app_company/ ### アプリの利用企業一覧について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 本APIはアプリを利用可能な企業(※)のメイン機能企業ID(company_id)の一覧を返却します ※：無料期間中・契約中・解約予定の企業を利用可能な企業として返却します。解約が終了した企業は結果に返却しません 　　一度利用不可能になった企業が再契約した場合、再度利用可能な企業になります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントID | 不可(SDKの場合不要) | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する | | `client_secret` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントシークレット | 不可 | client_idと同じ | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) 例）"data": [{ "company_id": "xxxxxxxxx", "company_ne_id": "yyyyyyyy" }] | フィールドは企業のメイン機能企業ID（company_id）とネクストエンジン企業ID（company_ne_id）です。アプリ種別が「ログインのみアプリ」の場合は、メイン機能企業ID（company_id）がnullとなりますのでご注意ください。 また、企業情報の取得は、各企業がアプリを起動した際に企業情報取得にて保持して下さい | --- # 店舗接続確認-入出力パラメータ URL: https://developer.next-engine.com/guides/param/checkconnect_shop/ ### 店舗接続確認 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗の接続確認と同じです 接続に成功した場合はresultがsuccessになります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `shop_id` | 店舗ID | 必須 | 接続確認対象の店舗のshop_id | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | --- # パラメータ共通事項 URL: https://developer.next-engine.com/guides/param/common/ 本ページではパラメータの共通事項について説明します 機能毎の入出力パラメータは機能別入出力パラメータ一覧から参照して下さい ### 成功時以外の出力パラメータ 出力結果をレスポンスで返すAPIは、出力パラメータに必ず"result"があり処理ステータスを表します | resultの値 | 返却パラメータ | 備考 | | --- | --- | --- | | `success` | 呼び出したAPIにより結果が異なります | | | `error` | 同時に「code」にエラー原因を特定する為のメッセージコード、「message」にエラーメッセージが設定されます | メッセージコードとメッセージの一覧はこちらを参照下さい | | `redirect` | 同時に「code」に要リダイレクト(要再認証)原因を特定する為のメッセージコード、「message」にメッセージが設定されます | この値を受け取った場合、ネクストエンジンに(再)ログインするためにuid・state取得にリダイレクトする必要があります。メッセージコードとメッセージの一覧はこちらを参照下さい | ### 待機フラグについて access_tokenを指定する全てのAPIに待機フラグ(wait_flag)が指定可能です。 メイン機能過負荷の場合、エラーにせず実行可能になるまで待機するか指定するフラグです。 データの状態により実施出来ない場合(例えば受注伝票更新APIで棚卸中、受注取込中の場合)は待機せずにエラーを返却します | wait_flagの値 | 動作 | 備考 | | --- | --- | --- | | 1 | メイン機能過負荷の場合、エラーにせず実行可能になるまで最大60分待機しAPIを実行します。 60分待っても過負荷であった場合、サーバー接続を確保出来るなら正常にAPIを実行します。 サーバー接続さえ確保出来ない状態の場合、003001のエラーを返却します。 | こちらは高負荷な処理(バッチ処理、大量検索・大量更新)や、アプリ側の1連の処理を途切れさせたくない場合にご利用頂くことを想定しています。 企業情報取得などユーザーに即時レスポンスを返すべき処理ではご利用頂かない事を強く推奨致します。 (Ex:メイン機能過負荷の場合、アプリの起動やアプリ内の画面遷移に60分近く時間が掛かってしまう可能性があります)。 また必ずAPIが成功する事を保証するパラメータではない為、再開可能なようにアプリを設計して下さい。 | | 1以外(省略時含む) | メイン機能過負荷の場合、003002のエラーを返却します。 | こちらはユーザーに即時レスポンスを返すべき処理で利用することを推奨致します。 アプリ側で「003002のエラーの場合、リトライする」よりも、"1"を指定し待機した方がより高速になります。 （実行可能になり次第、即時APIを実施する為。また極度に頻繁なリトライ処理を実施した場合はサーバーに負荷を与えたと判断する為） | ### カンマ区切りの指定について 値にカンマ、ダブルクォート、改行のいずれかを含む場合は、必ずダブルクォートで囲む必要があります また値に含まれるダブルクォートは、ダブルクォートを２つ並べてエスケープする必要があります --- # 件数取得について-入出力パラメータ URL: https://developer.next-engine.com/guides/param/count/ ### 件数取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | --- # 店舗作成-入出力パラメータ URL: https://developer.next-engine.com/guides/param/create_shop/ ### 店舗作成 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗追加と同じです 【注意】メイン機能は50店舗まで作成可能ですが、一度登録した店舗は削除出来ません。開発時はチェックのみ実施するtest_flagを1にしてご利用下さい。店舗数が50になってしまった場合はこちらを確認下さい ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `test_flag` | 1:テスト, 1以外:通常 | 0(通常) | テストの場合、入力チェックのみ実施し店舗を登録しません。作成したshop_idは固定で1を返却します | | `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `shop_id` | 登録した店舗のID | | ### XML形式 入力パラメータのdataで指定する値です サンプルはこちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | | | 店舗情報の親タグ | | 3 | | ○ | | | 作成する店舗のフィールド名と値を指定します必須ではないフィールドは、タグ自体を省略することも可能です(値が空欄の場合と同じ挙動になります) | | 2 | | ○ | | | | | 1 | | ○ | | | | XMLサンプル ```xml 1 楽天店 raku スマホグッズ 1 1 1 login_id password 13 ``` ### 作成仕様 APIで指定できるフィールドの一覧です ここに記載されていないフィールドは指定できません #### 店舗情報 | 項目名 | フィールド名 | データ型 | 省略 | 備考 | | --- | --- | --- | --- | --- | | モール/カートID | `shop_mall_id` | 数値型 | 必須 | モール/カートのIDを指定します。この項目は更新時に指定出来ません | | 店舗名 | `shop_name` | 文字列型 | 必須 | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | 必須 | | | 店舗カナ | `shop_kana` | 文字列型 | | | | 備考 | `shop_note` | 文字列型 | | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | | 税区分ID | `shop_tax_id` | 文字列型 | 必須 | 税区分のIDを指定します | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 必須 | 0:商品計で税計算, 1:単価から税計算 | | 通貨単位ID | `shop_currency_unit_id` | 文字列型 | 必須 | 通貨単位のIDを指定します | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します | | ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細はこちらを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます | | ログインID_2 | `mall_login_id2` | 文字列型 | | | ログインID_3 | `mall_login_id3` | 文字列型 | | | パスワード_1 | `mall_password1` | 文字列型 | | | パスワード_2 | `mall_password2` | 文字列型 | | | パスワード_3 | `mall_password3` | 文字列型 | | | インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:適用しない | | 規定の発送方法ID | `default_delivery_id` | 文字列型 | | 発送方法区分のIDを指定します。この項目は更新時に指定出来ません。また「21:ヤマト(コレクト)B2v6」、「25:ヤマト(コレクト)B2v5」、「36:楽天コンビニ受取(ゆうパック)」は規定の発送方法に対応していないため、指定しても規定の発送方法が登録されません | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | #### ログインID/パスワードの扱い | モール/カートID | モール/カート名 | フィールド名 : 項目名 | 備考 | | --- | --- | --- | --- | | 1 | 楽天市場 | mall_login_id2 : SMTP AUTH ID mall_password2 : SMTP AUTH password mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | | | 2 | Yahoo!ショッピング | mall_login_id1 : ストアアカウント(API使用時にのみ登録) mall_password1 : リクエストURL(API使用時にのみ登録) mall_login_id2 : 認証キー(API使用時にのみ登録) mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | | | 3 | DeNAショッピング | mall_login_id1 : ID mall_password1 : password | | | 7 | 電脳卸 | 利用しません | | | 8 | 電話FAX | 利用しません | | | 11 | amazon（プロマーチャント） | mall_login_id1 : Eメールアドレス mall_password1 : パスワード mall_login_id2 : 【MWSアカウント】出品者 ID mall_login_id3 : 【MWSアカウント】マーケットプレイス ID | | | 13 | おちゃのこネット | mall_login_id1 : ログインID mall_password1 : password mall_login_id3 : 管理画面URL | | | 14 | ショップサーブ | mall_login_id1 : ショップID password : mall_password1 mall_login_id2 : 管理画面URL | | | 15 | ヤフオク!ストア | mall_login_id1 : Yahoo! JAPANビジネスID mall_password1 : password mall_login_id2 : YahooJapanID mall_password2 : password | | | 19 | `FutureShop2` | mall_login_id1 : FTPユーザ mall_password1 : password mall_login_id2 : ホスト名 | | | 20 | `ZenCartPro-R` | mall_login_id1 : 在庫更新実行URL mall_login_id2 : FTPホスト名 mall_password2 : 読み込み対象ディレクトリ mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | | | 21 | `EC-CUBE` | mall_login_id1 : 在庫更新用URL mall_password1 : ご利用のバージョンを入力してください。例：2.13.1 | | | 22 | カラーミーショップ | mall_login_id1 : ログインID mall_password1 : password | | | 23 | スーパーデリバリー | mall_login_id1 : ログインID mall_password1 : password | | | 25 | マーキュリー | mall_password2 : FTPホスト mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | | | 26 | `WiseCart` | mall_login_id1 : ショップID | | | 28 | DeNA BtoB market | mall_login_id1 : ログインID mall_password1 : password | | | 30 | ぐるなび食市場 | mall_login_id1 : ID mall_password1 : password | | | 31 | `aiship` | mall_login_id1 : ID mall_password1 : password mall_login_id2 : 管理者用ログイン画面URL | | | 32 | `BuyersClub` | mall_login_id2 : 企業ID | | | 33 | Qoo10(Gmarket) | mall_login_id1 : IDまたはメール mall_password1 : password | | | 35 | MakeShop & NEカート | mall_login_id1 : ショップID mall_password1 : password | | | 40 | `SHOPLIST` | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント 認証キー : mall_login_id2 | | | 41 | 楽天B2B | mall_login_id1 : FTP用 ユーザ mall_password1 : FTP用 password | | | 42 | ポンパレモール | mall_login_id1 : ショップログインID mall_password1 : ショップパスワード | | | 90 | 汎用 | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント mall_login_id2 : 認証キー mall_login_id3 : Ver.1の場合 : 空文字を指定、Ver.2の場合: 2を指定 | | | 91 | 卸 | 利用しません | | ### 店舗数が最大になってしまった場合 開発環境：リカバリすることは出来ませんが、[013011]のエラー(店舗数のチェック)が最後のチェックになっております。このエラーになる場合は、本番環境では登録が成功します 本番環境：お手数ですが弊社まで問い合わせするよう回答をお願いします --- # 受注伝票分割-入出力パラメータ URL: https://developer.next-engine.com/guides/param/divide_receive_order/ ### 索引 - 受注伝票分割 - 入力パラメータ - 出力パラメータ - XML形式 ### 受注伝票分割 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は分割処理と同じで、受注伝票をパラメータで指定した値で分割処理します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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形式で指定します [形式はこちら](#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)=空 ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `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になります | ### XML形式 入力パラメータのdataで指定する値です。 分割先の明細行、受注数を指定します。 引当数・予約引当数の指定は出来ません。分割元から引当数・予約引当数が割り当てられ、余った値が分割先の引当数・予約引当数となります。 有効な明細行のみを全て、明細行順に指定してください。 完成サンプルは[こちら](/api/fields/create_shop_sample)を参照。 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | ○ | | | 受注明細の項目を指定する要素 | | 3 | | | ○ | `value` | 属性に更新対象の明細行を指定します更新する明細行が複数ある場合はその分、要素を繰り返します | | 4 | | ○ | | | 分割先の受注数を正の整数で指定します | | 3 | | | | | | | 2 | | | | | | | 1 | | ○ | | | | XML完成サンプル（有効な受注明細行のみを、受注明細行順に全て指定する） ```xml 1 0 0 ``` --- # 配送情報出力済み-入出力パラメータ URL: https://developer.next-engine.com/guides/param/labelprinted_receive_order/ ### 配送情報出力済み 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 有効な受注伝票の配送情報ステータスを出力済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | | `receive_order_label_print_flag` | ラベル発行フラグ | | 1：配送情報出力対象にする2：配送情報出力済みにするパラメータが無い場合は「2：配送情報出力済みにする」として処理します。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 出力済みにできる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | ラベル発行フラグ | `receive_order_label_print_flag` | 0：配送情報出力対象にする1：配送情報出力済みにする | --- # メッセージコード URL: https://developer.next-engine.com/guides/param/message/ 「復帰」は時間を置いて再度同じAPIを同じパラメータで実行して成功するかを表します - ○：時間を置くことで成功します。バッチ等の場合は再開処理を記述することを推奨致します - ×：時間を置いても成功しません - 空欄：ユーザーやサーバーの状況により成功する可能性があります | 機能・分類 | メッセージコード(code) | メッセージ(message) | 復帰※1 | 備考 | | --- | --- | --- | --- | --- | | 共通 | 000001 | 存在しないパス[xxxxx]にアクセスしました。 | × | | | AccessToken取得 | 001001 | POSTパラメータにuidが指定されていません。 | × | | | 001002 | POSTパラメータにstateが指定されていません。 | × | | | 001003 | uid[xxxxx]又はstate[xxxxx]が不正です。 | × | | | 001004 | stateの有効期限が終了しました。 | × | stateを再発行する為に、uid・state取得を実施して下さい | | 001005 | アクセス元ホストのURIスキームがhttpsではありません。 | × | アプリとAPIサーバーは、必ずhttpsで通信する必要があります | | 001006 | アクセス元ホストとネクストエンジンで指定したredirect_uriが一致しません。 | × | ネクストエンジンで指定したredirect_uri以外のホストは、APIを使用出来ません | | 001007 | [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています。[xxxxx] | | 本エラーについて企業様からお問い合わせがあった場合、お手数ですが弊社まで問い合わせするよう回答をお願いします | | 001008 | client_id[xxxxx]又はclient_secret[xxxxx]が不正です。 | × | 正しいclient_id、client_secretを設定してください。ネクストエンジンにログイン→「アプリを作る」→該当アプリの「編集」ボタン→「API」タブに表示されているクライアントID、クライアントシークレットを設定してください。※2018/10/31以前はこの値が送信されていない場合でもログインが成功していました。 | | 001009 | POSTパラメータにclient_idが指定されていません。 | × | 古いバージョンのSDKを利用している可能性があります。最新のSDKを利用するか、最新のマニュアルに従ってログイン処理を実装し直してください。 | | 001010 | POSTパラメータにclient_secretが指定されていません。 | × | 古いバージョンのSDKを利用している可能性があります。最新のSDKを利用するか、最新のマニュアルに従ってログイン処理を実装し直してください。 | | 001011 | POSTパラメータにclient_id,client_secretが指定されていません。 | × | 古いバージョンのSDKを利用している可能性があります。最新のSDKを利用するか、最新のマニュアルに従ってログイン処理を実装し直してください。 | | API共通処理(ネクストエンジン) | 002001 | POSTパラメータにaccess_tokenが指定されていません。 | × | | | 002002 | access_token[xxxxx]が不正です。 | × | | | 002003 | [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています。[xxxxx] | | 本エラーについて企業様からお問い合わせがあった場合、お手数ですが弊社まで問い合わせするよう回答をお願いします。 | | 002004 | access_tokenの有効期限が終了しました。 | × | uid・state取得後、access_token取得を実施して下さい | | 002005 | アクセス元ホストのURIスキームがhttpsではありません。 | × | アプリとAPIサーバーは、必ずhttpsで通信する必要があります | | 002006 | アクセス元ホストとネクストエンジンで指定したredirect_uriが一致しません。 | × | ネクストエンジンで指定したredirect_uri以外のホストは、APIを使用出来ません。 | | 002007 | 現在ネクストエンジンサーバーがメンテナンス中の為、再度時間を置いてからアクセスして下さい。[xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx] | ○ | ネクストエンジンサーバーメンテナンス終了までAPIを利用することが出来ません。xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxにはメンテナンスの詳細が入ります | | API共通処理(メイン機能) | 003001 | 現在メイン機能サーバーが混み合っておりますので、再度時間を置いてからアクセスして下さい。 | ○ | メイン機能サーバー混雑の為、APIが停止になっております。アクセスが減少すると復旧致します（本エラーが発生しなくなります）。 | | 003002 | | 003003 | [xxxxx]様のメイン機能が、利用停止です。 | | 本エラーについて企業様からお問い合わせがあった場合、お手数ですが弊社まで問い合わせするよう回答をお願いします。 | | 003004 | 現在メイン機能サーバーがメンテナンス中の為、再度時間を置いてからアクセスして下さい。 | ○ | メイン機能のサーバー(企業情報のcompany_host)毎に発生しているメンテナンスです。お客様が利用しているメイン機能のサーバーによりAPI利用可否が変わりますのでご注意下さい。 | | 003005 | 現在メイン機能がメンテナンス中の為、再度時間を置いてからアクセスして下さい。 | ○ | メイン機能(企業情報のcompany_id)毎に発生しているメンテナンスです。お客様が利用しているメイン機能によりAPI利用可否が変わりますのでご注意下さい。 | | 件数取得・検索・情報取得共通 | 004001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 004002 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | × | 検索パラメータが不正な場合に表示されます。内容は不正であると判断した理由により異なります | | 004003 | fieldsの数が多すぎます。fieldsの指定を減らして下さい。 | × | 内部で発行するSQLのJOINするテーブルの数が多すぎる際に発生します。別オブジェクトに関するfieldsや検索条件の数を減らして下さい | | 004004 | 検索を実行可能な時間を超過しました。limitやfieldsを調整して下さい。 | × | 内部で発行するSQLの実行時間が長すぎる(約30分以上)場合に発生します。limitや別オブジェクトに関するfieldsや検索条件の数を減らして下さい | | アップロード&ダウンロード | 006001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 006002 | POSTパラメータにxxxxxが指定されていません。 | × | データ種類の指定がない場合のエラーです。 | | 006003 | xxxxxのデータ種類[xxx]が不正です。 | × | | | 006004 | POSTパラメータにxxxxxが指定されていません。 | × | データの指定がない場合のエラーです。 | | 006005 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | データの内容が不正な場合に表示されます。内容は不正であると判断した理由により異なります | | 006006 | POSTパラメータにreceive_order_upload_pattern_idが指定されていません。 | × | | | 006007 | 存在しない受注一括登録パターン[xxxxxxxxxxxxxxxxx]です。 | × | 指定したreceive_order_upload_pattern_idが不正な場合に表示されます | | 006008 | POSTパラメータにdata_type_2を指定する場合は、data_2も指定して下さい。 | × | | | 006009 | POSTパラメータにdata_2を指定する場合は、data_type_2も指定して下さい。 | × | | | 006010 | 指定されたファイルは存在していません | × | パラメータで指定したファイルが存在しない場合のエラーです。アップロードしたファイルは保存期間(3日)を越えると自動的に削除されます。 | | 納品書印刷済み | 008001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 008002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | × | | | 008003 | 受注取込中のため、更新出来ません。 | ○ | しばらく時間を空けて再度APIを実行して下さい | | 008004 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 008005 | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | | | | 008006 | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | | | | 008007 | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | ○ | | | 008008 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | × | | | 008009 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 008010 | 棚卸中のため、更新出来ません。 | ○ | 棚卸を終了してから再度APIを実行して下さい | | 008011 | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | ○ | 納品書印刷指示日がAPI実行日以前になる、または納品書印刷指示日の設定を解除して再度APIを実行して下さい | | 008013 | 受注伝票[xxxxxx]は配送情報出力済みです。 | | xxxxxxには指定した番号が表示されます。 | | 008999 | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | | xxxxxxには例外の内容が表示されます。 | | 出荷確定処理 | 009001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 009002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | × | | | 009003 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | × | | | 009004 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | | | | 009005 | 受注取込中のため、更新出来ません。 | ○ | しばらく時間を空けて再度APIを実行して下さい | | 009006 | 棚卸中のため、更新出来ません。 | ○ | 棚卸を終了してから再度APIを実行して下さい | | 009007 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | データの内容が不正な場合に表示されます。内容は不正であると判断した理由により異なります | | 配送情報出力済み | 010001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 010002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | × | | | 010003 | 受注取込中のため、更新出来ません。 | ○ | しばらく時間を空けて再度APIを実行して下さい | | 010004 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 010005 | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | | | | 010006 | 受注伝票[xxxxxx]は配送情報出力済みです。 | | | | 010007 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | × | | | 010008 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 010009 | 棚卸中のため、更新出来ません。 | ○ | 棚卸を終了してから再度APIを実行して下さい | | 010010 | receive_order_label_print_flag[xxxxxx]は不正な値です。 | × | 1：配送情報出力対象にする2：配送情報出力済みにするパラメータが無い場合は「2：配送情報出力済みにする」として処理します。上記以外の値はエラーを返します。xxxxxxには指定した値が表示されます。 | | 010012 | 受注伝票[xxxxxx]は配送情報出力済みに出来る状態ではありません。 | | 配送情報出力対象の伝票のみ出力済みに変更できます。 | | 010999 | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | | xxxxxxには例外の内容が表示されます。 | | 受注伝票更新 | 011001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 011002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | × | | | 011003 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 011004 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | 更新可能なフィールド名以外のタグや属性は何も処理されません。エラーにもなりません。 | | 011005 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | × | | | 011006 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 011007 | 受注取込中のため、更新出来ません。 | ○ | 再度受注伝票を検索してAPIを実行して下さい。 | | 011008 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 011009 | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | | xxxxxxには指定した項目名が表示されます。 | | 011010 | 受注状態が出荷確定済の伝票は更新できません。 | | | | 011011 | 棚卸中のため、更新出来ません。 | ○ | | | 011014 | 更新フィールドが1つも設定されておりません。 | × | | | 011015 | [xxxx]xxxxxxxxxx | | 受注伝票の更新に関するエラーが表示されます。xxxxにはエラーになったフィールド名が表示されます。xxxxxxxxxxにはエラー内容が表示されます。 | | 011016 | 明細行xx[xxxx]xxxxxxxxxx | | 受注明細の更新に関するエラーが表示されます。xxには該当の明細行が表示されます。xxxxにはエラーになったフィールド名が表示されます。xxxxxxxxxxにはエラー内容が表示されます。 | | 011017 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | 受注明細の追加に関するエラーが表示されます。追加できる条件を満たしていない場合にエラー内容が表示されます。 | | 011018 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | 受注伝票と受注明細の更新に関するエラーが表示されます。更新できる条件を満たしていない場合にエラー内容が表示されます。 | | 011019 | xxxx[xx]は、メイン機能に登録されていない値です。 | | 存在しないマスタや区分を指定した場合にエラーが表示されます。xxxxにはエラーになったフィールド名が表示されます。xxには指定した値が表示されます。 | | 011030 | 所属拠点が異なる店舗に変更することはできません。 | × | 店舗コードを変更したとき、所属拠点が異なる店舗に変更しようとした場合に、表示されます。店舗コードを変更したい場合は、一旦複写したあとに、伝票をキャンセルしてください。 | | 011999 | 更新処理中に例外が発生したため、処理を行いませんでした。 | | | | 店舗接続確認 | 012001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 012002 | POSTパラメータにshop_idが指定されていない、または値が空です。 | × | | | 012003 | 店舗[xxx]は存在しません。 | × | | | 012004 | 店舗[xxx]は使用停止中の為、接続確認出来ません。 | × | 使用停止中の店舗は接続確認出来ません。メイン機能で店舗の使用を再開する必要があります | | 012005 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | × | 接続に失敗した理由が表示されます | | 店舗作成 | 013001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 013002 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 013003 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | XMLが不正なフォーマットの場合のエラーです | | 013004 | dataにshopタグが設定されておりません。 | × | | | 013005 | 必須の[xxxxxx]タグが設定されておりません。 | × | | | 013006 | 必須の[xxxxxx]タグの値が設定されておりません。 | × | | | 013007 | [xxxxxx]タグは指定出来ません。 | × | | | 013008 | shopタグにネストしたタグを設定することは出来ません。 | × | | | 013009 | xxxxxx[xxxxxxxxx]は、メイン機能に登録されていない値です。 | × | | | 013010 | shop_tax_calculation_sequence_id[xxx]には0又は1を設定して下さい。 | × | | | 013011 | 店舗は50件まで登録可能です。 | × | 本エラーについて企業様からお問い合わせがあった場合、お手数ですが弊社まで問い合わせするよう回答をお願いします | | 013012 | shop_hit_syohin_alert_flag[xxxxx]には0又は1を設定して下さい。 | × | | | 店舗更新 | 014001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 014002 | POSTパラメータにshop_idが指定されていない、または値が空です。 | × | | | 014003 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 014004 | POSTパラメータにshop_last_modified_dateが指定されておりません。 | × | | | 014005 | 店舗[xxx]は存在しません。 | × | | | 014006 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | XMLが不正なフォーマットの場合のエラーです | | 014007 | dataにshopタグが設定されておりません。 | × | | | 014008 | [xxxxxx]タグを指定する場合、値が必須です。 | × | | | 014009 | [xxxxxx]タグは指定出来ません。 | × | | | 014010 | shopタグにネストしたタグを設定することは出来ません。 | × | | | 014011 | 更新フィールドが設定されておりません。 | × | 何も更新しない設定にした場合のエラーです | | 014012 | xxxxxx[xxxxxxxxxxxx]は、メイン機能に登録されていない値です。 | × | | | 014013 | shop_tax_calculation_sequence_id[xxx]には0又は1を設定して下さい。 | × | | | 014014 | shop_last_modified_dateが更新されています。再度店舗を検索してAPIを実行して下さい。 | × | | | アプリ契約企業取得 | 015001 | POSTパラメータにclient_id が指定されていません。 | × | | | 015002 | POSTパラメータにclient_secretが指定されていません。 | × | | | 015003 | client_id[xxxxxxxxxx]又はclient_secret[xxxxxxxxxxx]が不正です。 | × | | | 受注伝票分割 | 016001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 016002 | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | × | | | 016003 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 016004 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | 更新可能なフィールド名以外のタグや属性は何も処理されません。エラーにもなりません。 | | 016005 | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | × | | | 016006 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 016007 | 受注状態が受注メール取込済の伝票は更新できません。 | | | | 016008 | 受注状態が取込情報不足の伝票は更新できません。 | | | | 016009 | 受注状態が出荷確定済の伝票は更新できません。 | | | | 016010 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 016011 | 棚卸中のため、更新出来ません。 | ○ | | | 016012 | dataにreceiveorder_rowタグが設定されておりません。 | × | 変更がない場合でもreceiveorder_rowタグは必要です。 | | 016013 | receiveorder_rowに更新フィールドが設定されておりません。 | × | receiveorder_rowタグは必要です。 | | 016014 | receive_order_row_noタグのvalue属性の値[xxxxxx]は0より大きい整数を指定してください。 | × | xxxxxxにはreceive_order_row_noタグのvalue属性が表示されます。 | | 016015 | dataにreceive_order_row_quantityタグが設定されておりません。receive_order_row_no[xxxxxx] | × | receive_order_row_quantityタグは必要です。xxxxxxには該当するreceive_order_row_noタグのvalue属性が表示されます。 | | 016016 | receive_order_row_noタグ内のreceive_order_row_quantityタグの値[xxxxxx]は0以上の整数を指定してください。 | × | xxxxxxにはreceive_order_row_quantityタグの値が表示されます。 | | 016017 | 分割先の受注数に全て0が指定されているため、分割できません。 | × | | | 016018 | 有効な受注明細行とdataで指定した受注明細行が一致しません。有効な受注明細行のみを全て指定してください。 | × | | | 016019 | 有効でない受注明細行の指定があるか、受注明細行の並び順が昇順ではありません。 | × | | | 016020 | 指定した分割先受注数が、受注伝票の受注数より大きいです。受注伝票の受注数以下の数値を指定してください。receive_order_row_no[xxxxxx] | × | xxxxxxにはreceive_order_row_noタグのvalue属性が表示されます。 | | 016021 | 分割元の受注数に全て0が指定されるため、分割できません。分割可能な伝票か確認してください。 | × | | | 016022 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | 分割処理に関するエラーが表示されます。納品書出力中や、指定した伝票が複数配送である場合などにエラー内容が表示されます。 | | 016023 | 引当処理対象になる伝票は、引当処理中に分割処理出来ません。しばらく時間をおいて、再度実行してください。 | ○ | | | 016999 | 分割処理中に例外が発生したため、処理を行いませんでした。 | | | | 受注確認内容更新 | 017001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 017002 | POSTパラメータにconfirm_idが指定されていない、または値が空です。 | × | | | 017003 | POSTパラメータにconfirm_valueが指定されていない、または値が空です。 | × | | | 017004 | POSTパラメータにconfirm_last_modified_dateが指定されていません。 | × | | | 017005 | 受注確認内容ID[xx]は、メイン機能に登録されていない値です。 | × | | | 017006 | 受注確認内容ID[xx]は、設定値が設定出来ない受注確認内容です。 | × | | | 017007 | confirm_last_modified_dateが更新されています。再度受注確認内容を検索してAPIを実行して下さい。 | × | | | 店舗受注情報取り込み用メールアドレス取得 | 018001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 018002 | POSTパラメータにshop_idが指定されていない、または値が空です。 | × | | | 018003 | 店舗[xxx]は存在しません。 | × | | | 018004 | 店舗[xxx]は使用停止中の為、情報を取得できません。 | × | 使用停止中の店舗は情報を取得出来ません。メイン機能で店舗の使用を再開する必要があります | | 実行結果お知らせ追加 | 019001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 019002 | POSTパラメータにexecution_notice_titleが指定されていない、または値が空です。 | × | | | 019003 | POSTパラメータにexecution_notice_contentが指定されていない、または値が空です。 | × | | | 受注伝票一括更新 | 020001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 020002 | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | × | | | 020003 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 020004 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | 更新可能なフィールド名以外のタグや属性は何も処理されません。エラーにもなりません。 | | 020005 | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | × | | | 020006 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 020007 | 受注取込中のため、更新出来ません。 | ○ | 再度受注伝票を検索してAPIを実行して下さい。 | | 020008 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 020009 | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | | xxxxxxには指定した項目名が表示されます。 | | 020010 | 受注状態が出荷確定済の伝票は更新できません。 | | | | 020011 | 棚卸中のため、更新出来ません。 | ○ | | | 020014 | 更新フィールドが1つも設定されておりません。 | × | | | 020015 | [xxxx]xxxxxxxxxx | | 受注伝票の更新に関するエラーが表示されます。xxxxにはエラーになったフィールド名が表示されます。xxxxxxxxxxにはエラー内容が表示されます。 | | 020016 | 明細行xx[xxxx]xxxxxxxxxx | | 受注明細の更新に関するエラーが表示されます。xxには該当の明細行が表示されます。xxxxにはエラーになったフィールド名が表示されます。xxxxxxxxxxにはエラー内容が表示されます。 | | 020017 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | 受注明細の追加に関するエラーが表示されます。追加できる条件を満たしていない場合にエラー内容が表示されます。 | | 020018 | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | | 受注伝票と受注明細の更新に関するエラーが表示されます。更新できる条件を満たしていない場合にエラー内容が表示されます。 | | 020019 | xxxx[xx]は、メイン機能に登録されていない値です。 | | 存在しないマスタや区分を指定した場合にエラーが表示されます。xxxxにはエラーになったフィールド名が表示されます。xxには指定した値が表示されます。 | | 020021 | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | × | | | 020022 | 更新対象が１つも指定されていません。 | × | | | 020023 | POSTパラメータにdata_typeが指定されていない、または値が空です。 | × | | | 020024 | data_typeの値を正しい形式で指定して下さい。 | × | | | 020025 | data_type[xxx]とdataの形式が一致しません。正しい形式で指定してください。 | × | | | 020030 | 所属拠点が異なる店舗に変更することはできません。 | × | 店舗コードを変更したとき、所属拠点が異なる店舗に変更しようとした場合に、表示されます。店舗コードを変更したい場合は、一旦複写したあとに、伝票をキャンセルしてください。 | | 020500 | `xxxxxxx` | | 更新に失敗している伝票が1件以上ある場合に表示されます。 | | 020999 | 更新処理中に例外が発生したため、処理を行いませんでした。 | | | | 納品書印刷済み一括更新 | 024001 | アクセス情報[xxxxxx]の許可が必要です。 | × | ネクストエンジンの「アプリを作る」「APIタブ」にて、アクセス許可をする必要があります | | 024002 | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | × | | | 024003 | 受注取込中のため、更新出来ません。 | ○ | しばらく時間を空けて再度APIを実行して下さい | | 024004 | 受注伝票[xxxxxx]は存在しません。 | × | xxxxxxには指定した番号が表示されます。 | | 024005 | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | × | | | 024006 | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | × | | | 024007 | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | ○ | | | 024008 | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | × | | | 024009 | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | × | | | 024010 | 棚卸中のため、更新出来ません。 | ○ | 棚卸を終了してから再度APIを実行して下さい | | 024011 | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | ○ | 納品書印刷指示日がAPI実行日以前になる、または納品書印刷指示日の設定を解除して再度APIを実行して下さい | | 024013 | 受注伝票[xxxxxx]は配送情報出力済みです。 | × | xxxxxxには指定した番号が表示されます。 | | 024014 | data_typeの値を正しい形式で指定して下さい。 | × | | | 024015 | dataの値を解析できませんでした。正しい形式で指定して下さい。 | × | | | 024016 | data_type[xml or gz]とdataの形式が一致しません。正しい形式で指定して下さい。 | × | | | 024018 | POSTパラメータにdata_typeが指定されていない、または値が空です。 | × | | | 024019 | POSTパラメータにdataが指定されていない、または値が空です。 | × | | | 024020 | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | × | | | 024021 | 更新対象の受注伝票が１つも指定されていません。 | × | | | 024500 | `xxxxxxx` | × | 納品書印刷済み一括更新処理に関するエラーが表示されます。 | | 024999 | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | × | xxxxxxには例外の内容が表示されます。 | | 例外 | 999999 | APIサーバーのシステムエラーが発生しました。 | | | --- # パラメータ比較演算子 URL: https://developer.next-engine.com/guides/param/operator_compare/ 商品ページでは使用できるパラメータの差異が存在するため商品ページの検索のパラメータ比較演算子は[こちら](/api/param/operator_compare_via_main)からご確認ください。 パラメータにフィールド名+演算子を指定することで、検索条件の比較演算子を設定できます 例えば、商品コードgoods_idがabc,def,efgのいずれかであること、と指定する場合パラメータ"goods_id-in"に"abc, def, efg"を指定します。 複数の検索条件を指定した場合は、かつ(AND)条件になります。 fieldsに指定可能な項目は全て検索条件に設定することが出来ます。 | 演算子 | 意味 | 値について | 文字列型 | 数値型 | 日時型 | | --- | --- | --- | --- | --- | --- | | -eq | = | | 利用可能 | 利用可能 | 利用可能 | | -neq | != | | 利用可能 | 利用可能 | 利用可能 | | -lt | < | | | 利用可能 | 利用可能 | | -lte | <= | | | 利用可能 | 利用可能 | | -gt | > | | | 利用可能 | 利用可能 | | -gte | >= | | | 利用可能 | 利用可能 | | -in | IN() | カンマ区切りで指定する。最大1000個まで指定可能。 | 利用可能 | 利用可能 | | | -nin | NOT IN() | カンマ区切りで指定する。最大1000個まで指定可能。 | 利用可能 | 利用可能 | | | -like | `LIKE` | MySQLのLIKE演算子と同じ | 利用可能 | | | | -nlike | NOT LIKE | MySQLのNOT LIKE演算子と同じ | 利用可能 | | | | -nlikeornull | NOT LIKE 'value' OR IS NULL | MySQLのNOT LIKE演算子とIS NULL演算子の論理和。NOT LIKEで指定した値を使用する。 | 利用可能 | | | | -blank | (IS NULL OR = "") | 値は不要(無視) | 利用可能 | 利用可能 | 利用可能 | | -nblank | (IS NOT NULL AND <> "") | 値は不要(無視) | 利用可能 | 利用可能 | 利用可能 | | -null | IS NULL | 値は不要(無視) | 利用可能 | 利用可能 | 利用可能 | | -nnull | IS NOT NULL | 値は不要(無視) | 利用可能 | 利用可能 | 利用可能 | --- # パラメータ比較演算子-商品ページの場合 URL: https://developer.next-engine.com/guides/param/operator_compare_via_main/ パラメータにフィールド名+演算子を指定することで、検索条件の比較演算子を設定できます 例えば、商品コードgoods_idがabc,def,efgのいずれかであること、と指定する場合パラメータ"goods_id-in"に"abc, def, efg"を指定します。 複数の検索条件を指定した場合は、かつ(AND)条件になります。 fieldsに指定可能な項目は全て検索条件に設定することが出来ます。 | 演算子 | 意味 | 値について | 文字列型 | 数値型 | 日時型 | 日時型(DATE) | 時刻型(TIME) | メタ型(META) | | --- | --- | --- | --- | --- | --- | --- | --- | --- | | -eq | = | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | -neq | != | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | | -lt | < | | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | | -lte | <= | | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | | -gt | > | | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | | -gte | >= | | | 利用可能 | 利用可能 | 利用可能 | 利用可能 | | | -in | IN() | カンマ区切りで指定する。最大1000個まで指定可能。 | 利用可能 | 利用可能 | | | | | | -nin | NOT IN() | カンマ区切りで指定する。最大1000個まで指定可能。 | 利用可能 | 利用可能 | | | | | | -like | `LIKE` | MySQLのLIKE演算子と同じ | 利用可能 | | | | | 利用可能<< /td> | | -nlike | NOT LIKE | MySQLのNOT LIKE演算子と同じ | 利用可能 | | | | | | | -nlikeornull | NOT LIKE 'value' OR IS NULL | MySQLのNOT LIKE演算子とIS NULL演算子の論理和。NOT LIKEで指定した値を使用する。 | 利用可能 | | | | | | | -blank | (IS NULL OR = "") | 値は不要(無視) | | | | | | | | -nblank | (IS NOT NULL AND <> "") | 値は不要(無視) | | | | | | | | -null | IS NULL | 値は不要(無視) | 利用可能 | 利用可能 | | | | | | -nnull | IS NOT NULL | 値は不要(無視) | 利用可能 | 利用可能 | | | | | --- # 納品書印刷済み-入出力パラメータ URL: https://developer.next-engine.com/guides/param/receipted_receive_order/ ### 納品書印刷済み 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 有効な納品書印刷待ちの受注伝票を納品書印刷済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | | `receive_order_label_print_flag` | ラベル発行フラグ | 可能 | 1：配送情報出力対象にする上記以外の値は何も処理しません。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 納品書印刷済みにできる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | 受注状態区分 | `receive_order_order_status_id` | 20：納品書印刷待ちの受注伝票 | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること | | ラベル発行フラグ | `receive_order_label_print_flag` | ラベル発行フラグが「0」または「1」ただしこの条件は、上記の入力パラメータreceive_order_label_print_flagで「1」を指定した場合のみ有効。 | --- # 検索について-入出力パラメータ URL: https://developer.next-engine.com/guides/param/search/ ### 検索について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 検索条件を複数指定した場合、全ての条件がかつ(AND)となります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します | | フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します | | `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ | | `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | | ### 検索速度について 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します --- # 出荷確定処理-入出力パラメータ URL: https://developer.next-engine.com/guides/param/shiped_receive_order/ ### 出荷確定処理 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は出荷確定処理と同じで、有効な納品書印刷済みの受注伝票を出荷確定済みにします。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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を実行して下さい。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### 出荷確定処理できる条件 以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。 | 項目名 | フィールド名 | 条件 | | --- | --- | --- | | 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 | | 受注状態区分 | `receive_order_order_status_id` | 20または40：納品書印刷待ちまたは納品書印刷済みの受注伝票 | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること | --- # uid・state取得について-入出力パラメータ URL: https://developer.next-engine.com/guides/param/uid_state/ ### uid・state取得について 本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です 入力パラメータはGET、出力パラメータは入力パラメータで指定したredirect_uriへのリダイレクト(GET)になります。 アプリを起動したユーザーのログイン状態により以下の違いがあります - 未ログインの場合は、ユーザーにログイン画面が表示される - ログイン済みの場合は、ユーザーの入力が必要ない 上記の後に、入力パラメータで指定したredirect_uriにリダイレクトされます ユーザーがログイン画面でログインしなかった場合は制御がアプリ側に戻りません ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | 不可 | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する | | `redirect_uri` | ネクストエンジンへのログイン後、リダイレクトするuriを指定する | 可能(ネクストエンジンのアプリを作る->APIのRedirect URIになる) | ネクストエンジンのアプリを作る->APIのRedirect URIのホスト以外を指定することは出来ない | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | uid | アプリを起動したユーザーのuid | | | `state` | アプリを起動したユーザーのstate | stateには有効期限があります。有効期限が切れた場合は再度本APIを呼ぶ必要があります | | 入力パラメータに渡したパラメータ | | 上記パラメータ以外に、入力パラメータに渡したパラメータがそのまま返却されます | --- # 受注確認内容更新-入出力パラメータ URL: https://developer.next-engine.com/guides/param/update_confirm/ ### 受注確認内容更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 本機能では、受注確認内容更新の設定値を更新する事のみ可能です（店舗ごとに受注確認内容が有効/無効か設定することは出来ません。）。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `confirm_id` | 受注確認内容ID | 必須 | 更新する受注確認内容のconfirm_id。設定値が有効(confirm_valid_flagが'1')の受注確認内容のみ指定可能です | | `confirm_value` | 設定値 | 必須 | 更新する受注確認内容のconfirm_value。値を空に更新することは出来ません | | `confirm_last_modified_date` | 最終更新日 | 必須 | 更新する店舗のconfirm_last_modified_date API実行時にメイン機能またはアプリで、受注確認内容が更新されていないかを確認するために利用します メイン機能またはアプリで受注確認内容が更新されている場合はエラーになります エラーになったら再度、受注確認内容を検索してAPIを実行して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | --- # 受注伝票更新-入出力パラメータ URL: https://developer.next-engine.com/guides/param/update_receive_order/ ### 索引 - 受注伝票更新 - 入力パラメータ - 出力パラメータ - XML形式 - 更新仕様 ### 受注伝票更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 受注伝票の項目をパラメータで指定した値で更新します。 処理結果はレスポンスのステータスコードで確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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形式で指定します [形式はこちら](#xml形式)を参照 | | `receive_order_shipped_update_flag` | 1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可 | 可能(省略時は1以外とする) | | | `receive_order_row_cancel_update_flag` | 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし | 可能(省略時は1以外とする) | このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。 | | `receive_order_recalculate_flag` | 1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない | 可能(省略時は1以外とする) | 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは 成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `access_token_end_date` | access_tokenの有効期限切れ日時 | | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | | ### XML形式 入力パラメータのdataで指定する値です 完成サンプルは こちらを参照 | 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 | | --- | --- | --- | --- | --- | --- | | 1 | | ○ | | | | | 2 | | | | | 受注伝票の項目を指定する要素 更新する 受注伝票のフィールド名と値を指定します | | 3 | | | | | | | 3 | | | | | | | 2 | | | | | | | 2 | | | | | 受注伝票オプションの項目を指定する要素 更新する 受注伝票オプションのフィールド名と値を指定します | | 3 | | | | | | | 3 | | | | | | | 2 | | | | | | | 2 | | | | | 受注明細の項目を指定する要素 | | 3 | | | ○ | `value` | 属性に更新対象の明細行を指定します 更新する明細行が複数ある場合はその分、要素を繰り返します | | 4 | | | | | 更新する 受注明細のフィールド名と値を指定します | | 4 | | | | | | | 3 | | | | | | | 2 | | | | | | | 1 | | ○ | | | | XML完成サンプル1（受注伝票と受注明細を更新） ```xml 12345-6789 2014-05-01 00:00:00 テスト商品 1 テスト商品2 3 ``` XML完成サンプル2（受注伝票の更新と、受注明細の更新と追加） ```xml 12345-6789 2014-05-01 00:00:00 テスト商品 1 テスト商品2 3 ``` XML完成サンプル3（受注伝票のみ更新） ```xml 12345-6789 2014-05-01 00:00:00 ``` ### 更新仕様 APIで指定出来るフィールドの一覧です。 ここに記載されていないフィールドは指定できません。 以下のフィールドはAPIで更新成功した場合、自動的に登録・更新されます。 - 最終更新日 - 最終更新者ID - 重要チェックをつけた場合、重要チェック担当者ID - 更新した受注伝票の操作履歴 受注メール取込済の伝票は、以下のフィールドのみAPIで更新できます。 - 受注キャンセル区分 - 作業用欄 - 受注分類タグ #### 受注伝票 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 店舗コード | `receive_order_shop_id` | 数値型 | | | 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | メイン機能内でユニークかのチェックはしない | | 受注日 | `receive_order_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 受注確認内容 | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDを":"区切りで設定します。明細行に対する確認は"#"の後に明細行番号が設定されます。 Ex: "AO:AA#1:AA#2"の場合 送り先の郵便番号と住所があってません。 商品コードが商品マスタに存在しません。：1行目 商品コードが商品マスタに存在しません。：2行目 | | 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0：チェックを外す 1：チェックをつける チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る 納品書印刷済み以降はエラーが返る | | 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | タグを[ ]で括る 例：[テストタグ][倉庫A] メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される | | 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 0：有効 1：顧客依頼によりキャンセル 受注キャンセルコードを指定 | | 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない 整合性が必要な場合は、 発送方法別項目タイプの値を指定 | | 支払区分 | `receive_order_payment_method_id` | 文字列型 | 出荷可能設定の整合性チェックはしない 整合性が必要な場合は、アプリ側で考慮して設定して下さい。 | | 商品計 | `receive_order_goods_amount` | 数値型 | | | 税金 | `receive_order_tax_amount` | 数値型 | | | 手数料 | `receive_order_charge_amount` | 数値型 | | | 発送代 | `receive_order_delivery_fee_amount` | 数値型 | | | 他費用 | `receive_order_other_amount` | 数値型 | | | ポイント数 | `receive_order_point_amount` | 数値型 | | | 総合計 | `receive_order_total_amount` | 数値型 | | | 入金額 | `receive_order_deposit_amount` | 文字列型 | | | 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | | | 入金日 | `receive_order_deposit_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 備考 | `receive_order_note` | 文字列型 | | | 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | | | 作業用欄 | `receive_order_worker_text` | 文字列型 | | | ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | | | 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 送り状区分 | `receive_order_invoice_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | 温度区分 | `receive_order_temperature_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール1区分 | `receive_order_seal1_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール2区分 | `receive_order_seal2_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール3区分 | `receive_order_seal3_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | シール4区分 | `receive_order_seal4_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 | | ギフトフラグ | `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_approval_no` | 文字列型 | | | クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | | | クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | | | クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | | | クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 顧客区分 | `receive_order_customer_type_id` | 文字列型 | | | 顧客コード | `receive_order_customer_id` | 文字列型 | | | 購入者名 | `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` | 文字列型 | ハイフンは不要 | | 購入者メールアドレス | `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` | 文字列型 | ハイフンは不要 | | 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 0：チェックしない 1：チェックする | | 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | クレジット支払い回数 | `receive_order_credit_number_payments` | 数値型 | | | 出荷予定日 | `receive_order_send_plan_date` | 日時型 | YYYY-MM-DD hh:mm:ss | | 請求金額（0%） | `receive_order_request_amount_tax0` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（8%） | `receive_order_request_amount_tax8` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求金額（10%） | `receive_order_request_amount_tax10` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) | | 請求額に対する税額（8%） | `receive_order_request_amount_tax_tax8` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 請求額に対する税額（10%） | `receive_order_request_amount_tax_tax10` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 | | 手数料（0%） | `receive_order_charge_amount_tax0` | 数値型 | | | 手数料（8%） | `receive_order_charge_amount_tax8` | 数値型 | | | 手数料（10%） | `receive_order_charge_amount_tax10` | 数値型 | | | 他費用（0%） | `receive_order_other_amount_tax0` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（8%） | `receive_order_other_amount_tax8` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | 他費用（10%） | `receive_order_other_amount_tax10` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） | | クーポン割引額（0%） | `receive_order_coupon_amount_tax0` | 数値型 | | | クーポン割引額（8%） | `receive_order_coupon_amount_tax8` | 数値型 | | | クーポン割引額（10%） | `receive_order_coupon_amount_tax10` | 数値型 | | | クーポン割引額（按分） | `receive_order_coupon_amount_distribute` | 数値型 | | | ポイント（0%） | `receive_order_point_amount_tax0` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（8%） | `receive_order_point_amount_tax8` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（10%） | `receive_order_point_amount_tax10` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） | | ポイント（按分） | `receive_order_point_amount_distribute` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント） | | ポイント（支払い） | `receive_order_point_amount_payment` | 数値型 | | #### 受注伝票オプション | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | | | メッセージ | `receive_order_option_message` | 文字列型 | | | のし | `receive_order_option_noshi` | 文字列型 | | | ラッピング | `receive_order_option_rapping` | 文字列型 | | | オプション1 | `receive_order_option_1` | 文字列型 | | | オプション2 | `receive_order_option_2` | 文字列型 | | | オプション3 | `receive_order_option_3` | 文字列型 | | | オプション4 | `receive_order_option_4` | 文字列型 | | | オプション5 | `receive_order_option_5` | 文字列型 | | | オプション6 | `receive_order_option_6` | 文字列型 | | | オプション7 | `receive_order_option_7` | 文字列型 | | | オプション8 | `receive_order_option_8` | 文字列型 | | | オプション9 | `receive_order_option_9` | 文字列型 | | | オプション10 | `receive_order_option_10` | 文字列型 | | #### 受注明細 | 項目名 | フィールド名 | データ型 | 登録 | 更新 | 備考 | | --- | --- | --- | --- | --- | --- | | 明細行番号 | `receive_order_row_no` | 数値型 | | 必須 | 更新のキーとして利用 空の場合、商品コード＋受注数＋αで明細行を最後尾に登録する | | 商品コード | `receive_order_row_goods_id` | 文字列型 | 必須 | | 更新不可 登録時のみ必須 メイン機能の商品マスタにない商品は登録できない | | 商品名 | `receive_order_row_goods_name` | 文字列型 | | | | | 受注数 | `receive_order_row_quantity` | 数値型 | 必須 | | | | 単価 | `receive_order_row_unit_price` | 数値型 | | | | | 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | | | 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | | | 小計金額 | `receive_order_row_sub_total_price` | 数値型 | | | 金額の再計算および整合性チェックはしない 整合性が必要な場合は、アプリ側で計算して設定する | | 商品OP | `receive_order_row_goods_option` | 文字列型 | | | | | キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 0：有効 1：キャンセル 明細は削除できない キャンセルフラグを指定してキャンセルにする | --- # 店舗更新-入出力パラメータ URL: https://developer.next-engine.com/guides/param/update_shop/ ### 店舗更新 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 動作はメイン機能の店舗更新と同じです ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `shop_id` | 店舗ID | 必須 | 更新する店舗のshop_id | | `shop_last_modified_date` | 最終更新日 | 必須 | 更新する店舗のshop_last_modified_date API実行時にメイン機能またはアプリで、店舗が更新されていないかを確認するために利用します メイン機能またはアプリで店舗が更新されている場合はエラーになります エラーになったら再度、店舗を検索してAPIを実行して下さい | | `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | ### XML形式 入力パラメータのdataで指定する値です [店舗作成](/api/param/create_shop#xml)と同じです。更新可能なフィールドのみ異なります XMLサンプル ```xml ラクテン ``` ### 更新仕様 APIで指定できるフィールドの一覧です ここに記載されていないフィールドは指定できません #### 店舗情報 | 項目名 | フィールド名 | データ型 | 値必須 | 備考 | | --- | --- | --- | --- | --- | | 店舗名 | `shop_name` | 文字列型 | ○ | | | 店舗略名 | `shop_abbreviated_name` | 文字列型 | ○ | | | 店舗カナ | `shop_kana` | 文字列型 | | | | 備考 | `shop_note` | 文字列型 | | | | 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | | | 税区分ID | `shop_tax_id` | 文字列型 | ○ | 税区分のIDを指定します | | 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | ○ | 0:商品計で税計算, 1:単価から税計算 | | 通貨単位ID | `shop_currency_unit_id` | 文字列型 | ○ | 通貨単位のIDを指定します | | オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します | | ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細は店舗作成のログインID/パスワードの扱いを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます | | ログインID_2 | `mall_login_id2` | 文字列型 | | | ログインID_3 | `mall_login_id3` | 文字列型 | | | パスワード_1 | `mall_password1` | 文字列型 | | | パスワード_2 | `mall_password2` | 文字列型 | | | パスワード_3 | `mall_password3` | 文字列型 | | | インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:変更しない | | ヤマト請求先顧客コード | `claim_id_yamato` | 文字列型 | | | | 西濃荷送人コード | `claim_id_seinou` | 文字列型 | | | | 福山荷送人コード | `claim_id_fukuyama` | 文字列型 | | | | 後払い.com サイトID | `shop_type_id` | 文字列型 | | | --- # 商品マスタ予約一括登録-入出力パラメータ URL: https://developer.next-engine.com/guides/param/upload_goods/ ### 商品マスタ予約一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は商品管理の一括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | | `data_type` | dataのファイル種類 | 必須 | csv:商品マスタCSV,gz:商品マスタCSVをGZIPで圧縮 | | `data` | 商品マスタCSVのファイル内容 | 必須 | メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8） | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | --- # 受注一括登録-入出力パラメータ URL: https://developer.next-engine.com/guides/param/upload_receive_order/ ### 受注一括登録 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。 動作は受注一括登録と同じですが、必ず非同期でメイン機能に登録可能になった時に登録されます。 登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。 ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `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_upload_pattern_id` | 登録対象の受注一括登録パターンID | 必須 | | | `data_type_1` | data_1のファイル種類 | 必須 | csv:受注CSV,gz:受注CSVをGZIPで圧縮 | | `data_type_2` | data_2のファイル種類 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | csv:受注CSV,gz:受注CSVをGZIPで圧縮 | | `data_1` | 受注CSVのファイル内容 | 必須 | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 | | `data_2` | 受注CSVのファイル内容 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 | --- # クイックスタート URL: https://developer.next-engine.com/guides/quickstart/ このページは **5 分で API を 1 回叩くまで** 進める最短コースです。SDK の細かい仕様は [認証フロー](/guides/auth/) や個別の [API リファレンス](/api/api_v1_master_goods/search/) を参照してください。 ## 全体像 ```json [1] アプリを登録 → client_id / client_secret を取得 ↓ [2] アプリを「テスト環境」で開く → uid / state を取得 ↓ [3] uid + client_id + client_secret で access_token を取得 ↓ [4] access_token を付けて API (例: 商品マスタ検索) を叩く ↓ [5] アクセスが切れたら refresh_token で再発行 ``` ステップ 1〜2 はネクストエンジン管理画面で 1 回だけ行う準備、ステップ 3〜5 がアプリの実装範囲です。 ## ステップ 1: アプリ登録 (5 分) 1. [ネクストエンジンアカウント作成ページ](https://base.next-engine.org/account?campaign_code=devnet) でアカウント作成 (既にある方は次へ) 2. 「[アプリを作る](https://manual.next-engine.net/pf/pf017/)」から新規アプリを登録 3. 登録完了後、編集画面の **API** タブから: - **テスト環境設定** の `client_id` / `client_secret` - **Redirect URI** (後で `https://example.com/callback` などに設定) を控えます。 > **テスト環境**: アプリ申請前に試せる開発用環境。`client_id`/`client_secret` は本番と別物。 ## ステップ 2: uid / state を取得 (1 分) ブラウザで以下にアクセスします。 ``` https://base.next-engine.org/users/sign_in/?client_id=&redirect_uri= ``` ネクストエンジンのログイン後、`?uid=xxxx&state=xxxx` にリダイレクトされます。`uid` と `state` を控えます。 詳細は [`/api/users/sign_in/`](/api/users/sign_in/) を参照。 ## ステップ 3: access_token を取得 (1 分) curl で叩きます (`` `` `` `` を実際の値に置換): ```bash curl -X POST https://api.next-engine.org/api_neauth \ -d 'uid=' \ -d 'state=' \ -d 'client_id=' \ -d 'client_secret=' ``` レスポンスの `access_token` と `refresh_token` を控えます (両方とも数十文字の英数字)。 ```json { "result": "success", "access_token": "abcd1234...", "access_token_end_date": "2026-05-02 14:00:00", "refresh_token": "efgh5678...", "refresh_token_end_date": "2026-05-04 14:00:00", "company_account": "test-shop" } ``` 詳細は [NEログインaccess_token取得](/api/api_neauth/)。 ## ステップ 4: API を叩く (1 分) 商品マスタ検索を例に。`` `` は前ステップの値。 ### curl ```bash curl -X POST https://api.next-engine.org/api_v1_master_goods/search \ -d 'access_token=' \ -d 'refresh_token=' \ -d 'wait_flag=1' \ -d 'fields=goods_id,goods_name,stock_quantity' \ -d 'limit=5' ``` ### TypeScript ```ts const params = new URLSearchParams({ access_token: '', refresh_token: '', wait_flag: '1', fields: 'goods_id,goods_name,stock_quantity', limit: '5', }) const res = await fetch('https://api.next-engine.org/api_v1_master_goods/search', { 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) ``` ### Python ```python import requests params = { 'access_token': '', 'refresh_token': '', 'wait_flag': '1', 'fields': 'goods_id,goods_name,stock_quantity', 'limit': '5', } res = requests.post('https://api.next-engine.org/api_v1_master_goods/search', data=params) json = res.json() if json['result'] != 'success': raise RuntimeError(json.get('message') or json.get('code')) print(json.get('data')) ``` 成功すれば `data` 配列に商品が最大 5 件返ります。 ## ステップ 5: トークン期限切れの扱い `access_token` は 1 日、`refresh_token` は 3 日で期限切れます。アプリ側ではリクエスト毎に **両方を毎回送信** すれば、期限切れ時に自動で新しいトークンを発行してくれます (レスポンスの `access_token` / `refresh_token` を保存して次回以降に使う)。 ```ts // レスポンスから受け取ったトークンを永続化 if (json.access_token) saveTokens(json.access_token, json.refresh_token) ``` 詳細は [パラメータ共通事項](/guides/param/access_token/)。 ## 次のステップ - [API リファレンス (商品マスタ検索)](/api/api_v1_master_goods/search/) — 全パラメータと出力フィールド - [API リファレンス (受注伝票検索)](/api/api_v1_receiveorder_base/search/) — 受注データの取得・絞り込み - [API リファレンス (在庫マスタ検索)](/api/api_v1_master_stock/search/) — 在庫数の確認（更新は[拠点在庫マスタアップロード](/api/api_v1_warehouse_stock/upload/)） - [はじめに](/guides/start/) — アプリ登録〜申請〜公開の全体フロー - [認証フロー](/guides/auth/) — 認証経路 3 パターン (アプリメニュー / メイン機能起動 / バッチ処理) - [パラメータ共通事項](/guides/param/common/) — 待機フラグ / wait_flag の挙動 - [エラーコード一覧](/guides/param/message/) — `result=error` 時の `code` の意味 - [SDK](/guides/sdk/) — 公式 PHP SDK のセットアップ - [FAQ](/faq/) — 81 件の Q&A をカテゴリ別に集約 ## トラブルシューティング | 症状 | 確認 | |---|---| | 401 / 403 で全リクエストが弾かれる | `client_id` / `client_secret` がテスト環境のものか確認 | | `result: "redirect"` が返る | `refresh_token` の期限切れ。ステップ 2-3 を再実行して `uid`/`state`/`access_token` を再取得 | | `code: "001001"` (POST パラメータに `client_id` が…) | `client_id` を送り忘れ。ステップ 3 のリクエストを確認 | | `code: "003002"` (メイン機能過負荷) | `wait_flag=1` を付けて再送 ([詳細](/guides/param/common/)) | | 文字化け | リクエスト/レスポンスとも UTF-8。`Content-Type: application/x-www-form-urlencoded; charset=utf-8` を明示 | --- # SDK URL: https://developer.next-engine.com/guides/sdk/ SDKは、ネクストエンジンAPIの認証処理を内包している為、新たに認証処理を開発する必要がありません 必須パラメータを指定した後、エンドポイントを指定してデータアクセスを開始出来ます ### SDK | 言語 | リポジトリ | 備考 | | --- | --- | --- | | PHP | https://github.com/hamee-dev/sdk-php | | | `Java` | https://github.com/hamee-dev/sdk-java | JSONデータのパースにJacksonを使用しています。 | | `Node` | https://github.com/hamee-dev/sdk-node | | | Ruby(公認) | https://github.com/infinity-octaver/ne_api | RubyのSDKは公式でありませんのでSDKのご利用方法をサポートすることはできかねます。issueやプルリクエストを投稿するようにしてください。 | ### SDKの必須パラメータ | パラメータ名 | 設定値 | 備考 | | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」->「API」->「クライアントID」を指定します | | | `client_secret` | ネクストエンジンの「アプリを作る」->「API」->「クライアントシークレット」を指定します | | 　**他の言語のSDKを開発された方がいらっしゃいましたら、ぜひコミュニティに貢献しましょう！弊社公認としてリファレンスに掲載させていただきます。** ### サンプルコード | 言語 | リポジトリ | 備考 | | --- | --- | --- | | PHP | https://github.com/hamee-dev/app-template-fuel | ドキュメント | | `Java` | https://github.com/hamee-dev/java-sample-code | | --- # 開発時の注意事項 URL: https://developer.next-engine.com/guides/secure/ ネクストエンジンAPIを使用したアプリを作成する上で注意すべき点をご説明致します。 　**ネクストエンジンAPIによるリクエストには、認証情報を含める必要があります** - リクエストに認証情報を含める方法は、リファレンスやSDKを参考にしてください 　**ネクストエンジンアプリはhttpsでの提供をお願い致します** - SSL接続についてはApplication Load Balancer（AWS）のセキュリティポリシーに準じます。（2021/8時点） [AWS Application Load Balancer](https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/application/create-https-listener.html) 　**取得したデータは適切に保管してください** 　**取得したデータは適切に保管してください** - ネクストエンジンから取得したデータには、個人情報や機密情報が含まれます これらの情報を外部アプリケーションで保存する場合は、データの流出や損失が発生しないよう、慎重にシステムの設計と運用を行うようにしてください 特に、パスワードなどの重要な情報をプログラムにハードコーディングするような実装は避けてください 　**短期間での大量のリクエスト送信はしないでください** - 自動的に大量のリクエストを送信するようなプログラムや、並列で多数のリクエストを同時実行するプログラムは、レスポンス悪化などのサービス低下を招く原因になります サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください 　**同一ユーザーでのマルチスレッドによるリクエストはしないでください** - 認証情報の有効期限がきれた場合、マルチスレッドでリクエストを行っているとエラーレスポンスが返却される可能性があります。 また、上述の通り、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください 　**対応環境について** - 読み込むJavaScriptやCSSやHTMLの問題によって、作成したアプリの機能が正常に動作しない場合があります 対応環境に記載する環境については、ネクストエンジンAPIを利用して作成したアプリが意図通りに動作していることをテスト環境で十分確認してください Webブラウザの種類やバージョンの違いによって問題が発生する場合があります --- # はじめに URL: https://developer.next-engine.com/guides/start/ ネクストエンジンアプリ開発の流れを記載します。 ### 1. ネクストエンジンアカウントの作成 ネクストエンジンアプリを作るにはネクストエンジンアカウントが必要になります。 ネクストエンジンアカウントを作成後、テストメイン機能を発行し、アプリ開発が可能になります。 ネクストエンジンアカウントは[こちら](https://base.next-engine.org/account?campaign_code=devnet)から作成可能です。 ### 2. アプリの登録 ネクストエンジンにこれから開発するアプリを登録します。 アプリを登録すると、ネクストエンジンAPIにリクエストする際に必要なclient_id、client_secretが発行されます。 [こちら](https://manual.next-engine.net/pf/pf017/)をご覧になり、アプリを登録してください。 登録する際にはアプリの「種類」と「販売形態」を選択してください。以下に詳細を記載します。 アプリの種類 | 種類 | 説明 | | --- | --- | | メイン機能と連携するアプリ | メイン機能のデータ（受注データや商品データ等）を使ったアプリ。APIを利用してメイン機能と連携する場合はこの種類を選択 | | ネクストエンジンログインのみのアプリ | メイン機能へネクストエンジンIDを使ったログインを行うアプリ。メイン機能のデータを一切使わないが、ネクストエンジンのユーザー認証やアプリの請求をご利用の場合はこの種類を選択 | | 自社サービスのアプリ | 御社のサービスをアプリとして登録し、ページを作って宣伝するアプリ。すでに公開しているサービスでネクストエンジンとのシステム的な連携はしない場合はこの種類を選択 | アプリの販売形態 | 販売形態 | 説明 | | --- | --- | | すべての企業に公開 | アプリをすべての企業に公開・販売します。販売開始後、「アプリを探す」タブのアプリ一覧に表示されるアプリです。 | | 特定の企業に公開 | アプリを特定の企業にのみ公開します。自社の基幹システムと連携したい場合などに適した販売形態です。 一メイン機能にのみご利用可能です。 販売開始後、「アプリを探す」タブのアプリ一覧には表示されず、「アプリを作る」タブの基本タブの「接続先メイン機能」で選択したメイン機能にのみ利用できるアプリです。 | ### 3. アプリの実行方法の決定 アプリが登録できたら、実行方法を決めましょう。 アプリを作る＞編集＞APIタブ＞テスト環境設定＞Redirect URIを入力・更新すると、実行方法設定を選択するフォームが表示されます。 アプリの実行(提供)方法として、「単独機能」か「拡張機能」を選択することができます。 アプリの実行方法 | 実行方法 | 説明 | | --- | --- | | 単独機能として実行 | アプリの一覧から起動することができます。 Redirect URIにパラメータ「execution_method=single」を付与してアプリを起動します。 | | ネクストエンジンの拡張機能として実行 | メイン機能の検索結果画面で選択したデータ（受注伝票や商品マスタ等）に対してアプリを起動することができます。 Redirect URIにパラメータ「execution_method=extension&extension_execution_id=拡張機能実行ID」を付与してアプリを起動します。 ※ 拡張機能実行IDは受注伝票検索API等の入力パラメータに指定することで、メイン機能の検索結果画面で選択したデータに合致した情報を取得することができます。 詳細はこちらをご参照ください。 | ### 4. アプリの開発 ネクストエンジンAPIは、ネクストエンジン(メイン機能)のデータを操作するためのインターフェースです。 (ex. メイン機能の受注情報をアプリに取り込む、アプリからメイン機能の受注情報を書き込む) 本リファレンスや[サンプルコード(PHP)](/tutorial/sample-fuelphp)や[サンプルコード(Java)](https://github.com/hamee-dev/java-sample-code)をご参考ください。 ネクストエンジンAPIの利用料金については以下のとおりです。 - 販売形態が「すべての企業に公開」の場合は**無料**となります。 - 販売形態が「特定の企業に公開」の場合は以下の表をご参照ください。 「特定の企業に公開」アプリ料金表 | APIリクエスト回数/月 | 通信データ量(GB)/月 | 金額/月 | | --- | --- | --- | | 1～1000 | ～3 | 0 | | 1001～2000 | ～4 | 5,000 | | 2001～5000 | ～5 | 10,000 | | 5001～10000 | ～6 | 30,000 | | 10001～ | 6～ | 要相談(サポートまでご連絡ください) | ※ APIリクエスト回数、通信データ量のどちらか利用料が多いものを基準として利用料金が発生します。 ※ APIリクエスト回数、通信データ量は「アプリを作る」＞「リクエスト履歴」から確認することが可能です。 ### 5. アプリの申請 開発したアプリを公開します。 [こちら](https://manual.next-engine.net/pf/pf024/)をご参照ください。 --- # アプリの開き方について URL: https://developer.next-engine.com/guides/tutorial/app-sample/app_open_methods/ 「新しいウィンドウで開く」「起動した画面で開く」「新しいタブで開く」の3つから選ぶことができます。 これはアプリ購入時のデフォルトの開き方を指定するもので、設定によりユーザーが後から変えることができるものです。 下の動画は拡張機能アプリで「新しいウィンドウで開く」の時の例 ![新しいウィンドウで開く](/images/17ee4f80d7a6.gif) --- # 実行方法について URL: https://developer.next-engine.com/guides/tutorial/app-sample/execution_method/ 単独機能として実行 こちらにチェックがついているとプラットフォーム画面の下部にアプリアイコンが表示され、ここから起動ができます。 Redirect URIにパラメータ「execution_method=single」を付与してアプリを起動します。 「単独機能」かつ「拡張機能」両方で開けるようなアプリの場合に、どの開き方をしたかを判別するためなどにご利用ください。 ![単独機能として実行](/images/d44fc7f30e8b.png) --- ネクストエンジンの拡張機能として実行 こちらにチェックがついているとメイン機能の検索画面の下部にアプリアイコンが表示され、ここから起動ができます。 Redirect URIにパラメータ「execution_method=extension&extension_execution_id=拡張機能実行ID」を付与してアプリを起動します。 拡張機能実行IDは受注伝票検索API等の入力パラメータに指定することで、メイン機能の検索結果画面で選択したデータに合致した情報を取得することができます。 拡張機能実行IDを用いた受注伝票検索APIのサンプル ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&fields=receive_order_shop_id, receive_order_id, receive_order_cancel_date&extension_execution_id=xxx' https://api.next-engine.org/api_v1_receiveorder_base/search ``` ![拡張機能として実行](/images/61b87797c757.png) --- # アプリの設定画面有無について URL: https://developer.next-engine.com/guides/tutorial/app-sample/have_setting_screen/ 設定画面有りにチェックを入れるとメイン機能＞設定＞アプリの一覧に表示され、ここから設定画面を開けるようになります。 Redirect URIにパラメータ「execution_method=config」付与してアプリ設定を起動します。 アプリ側ではexecution_methodの値を判断材料にルーティングや画面表示を制御してください。 ![設定画面有り](/images/46cb10c1a9bc.png) --- # アプリのマニュアルURLについて URL: https://developer.next-engine.com/guides/tutorial/app-sample/manual_url/ アプリのマニュアルURLを設定すると、メイン機能の「この画面のマニュアル」をクリックした時にそのマニュアルURLが参照されるようになります。 マニュアルURLの設定がない場合「この画面のマニュアル」をクリックした時に表示できるものがないためお問い合わせフォームへと繋がります ![この画面のマニュアル](/images/5fbac21f7122.gif) --- # 拡張機能の実行対象について URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/execution_target/ ## 拡張機能の実行対象について 実行可能な対象を限定することが可能です。 例えば下記画像のように「出荷済み」のみに対して許可した場合、出荷済みの伝票を選んでいる時しか機能を実行できません。 ![実行対象出荷済みのみ](/images/6e89b40703eb.png) ![実行対象について](/images/989dff6311ea.gif) 「出荷済み」の伝票を選択している時は該当の機能が表示されます。 別のステータスの伝票を選択すると該当の機能は表示されません。 --- # 拡張機能の実行画面有無について URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/execution_window/ ## 拡張機能の実行画面有無について 実行画面有りにチェックを入れた機能は実行時にアプリ画面に遷移します。 実行する設定を選んだり実行前の確認をアプリで行う場合などにお使いください。 ![実行画面有り](/images/a44e9a8f818a.gif) --- チェックがない機能は実行後、レスポンスが返ってくるまで待機し、結果を画面に表示します。 実行する処理が明確で特に確認も必要ないようなシンプルな機能の場合などにお使いください。 実行画面なしの場合、以下のフォーマットでレスポンス(レスポンスボディにJSON)を返す必要があります。 | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `result` | success または error | 必須 | success: 成功、error: 失敗 | | `message` | 任意の文字列 | 必須 | 例: 受注伝票番号「XXXX」の備考欄更新に失敗しました。 | JSONサンプル ```json {"result":"success","message":"処理に成功しました。"} ``` ![実行画面なし](/images/1e9bea820a99.gif) --- # 拡張機能の説明画像 URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/extension_description_image/ アプリ選択時（メイン機能の検索結果画面にてアプリアイコンにマウスカーソルを当てた時）に表示される説明画像となります。 画像の下赤枠の部分 ![この画面のマニュアル](/images/540b0cbd1bf5.png) --- # 拡張機能の概要 URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/extension_summary/ 「実行方法」にて「ネクストエンジンの拡張機能として実行」を選んでいる場合に必須の項目です。 アプリ選択時（メイン機能の検索結果画面にてアプリアイコンにマウスカーソルを当てた時）に表示される説明文となります。 画像の上赤枠の部分 ![この画面のマニュアル](/images/540b0cbd1bf5.png) --- # 拡張機能の作り方 URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/how_to_make/ ## 拡張機能の作り方 アプリを作るのAPIタブに拡張機能関連の設定項目が増えています。 ![アプリを作るAPIタブ](/images/1494ad3c5e4e.png) 実行設定の欄から各種設定が行なえます。 ![拡張機能の作り方](/images/3b003c01ddd5.gif) --- ## 単独機能アプリの拡張機能化 元々[ネクストエンジン](https://base.next-engine.org/)の下部アプリランチャーから起動するアプリ（単独機能）を、メイン機能の検索結果画面から起動するアプリ（拡張機能）に変更することが可能です。 単独機能アプリにも拡張機能関連の情報があるので、「ネクストエンジンの拡張機能として実行」にチェックを入れることで拡張機能化することができます。 ただし受け取った情報を正しく処理するようにアプリ側の改修も必要となります。 改修しなかった場合、拡張機能メニューから起動できるようになるだけです。 --- # 実行結果のお知らせ URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/notice/ ## 実行結果のお知らせ 処理が終わった後にユーザーへ実行結果を通知することが可能です。 --- ### 成功通知 成功したら以下のような緑色のお知らせがユーザーへ通知されます。 成功通知はしばらく表示したあと自動で既読になり画面から消えます。 ![成功通知](/images/41ac8ca5ead9.png) --- ### 失敗通知 失敗した場合は以下のような赤色のお知らせになります。 失敗通知はクリックしないと既読にならずユーザーの見逃しがありません。 ![失敗通知](/images/fa3d2513cbc0.png) --- ### その他 お知らせ通知のエンドポイントはこちら [/api_v1_notice_execution/add](/api/api_v1_notice_execution/add) [/api_v1_notice_execution/count](/api/api_v1_notice_execution/count) [/api_v1_notice_execution/search](/api/api_v1_notice_execution/search) - 拡張機能でなくてもお知らせ通知は行うことができます - 非同期処理が完了した後旨を通知するなどの用途でお使いください - 実行結果の通知は必須ではないですが推奨しておりますので是非ご活用ください - ユーザーはユーザー毎に通知のon/offができます --- # おすすめの拡張機能の作り方 URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/recommend/ ## おすすめの拡張機能の作り方 サンプルコードを公開しています。 ソースコードの方にREADMEがあるのでローカルで動かす際にはそちらをご参照ください。 また「ネクストエンジン」のスタイルを踏襲できるようにスタイルテンプレートも公開していますので合わせてご利用ください。 ### サンプルコード 受注伝票一括更新アプリ [https://github.com/hamee-dev/extension-bulk-update-orders](https://github.com/hamee-dev/extension-bulk-update-orders) スタイルテンプレート [https://github.com/hamee-dev/extension-apps-view-template](https://github.com/hamee-dev/extension-apps-view-template) --- # 注意事項 URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/warning/ ## 注意事項 - レスポンスヘッダーでiframeの読み込みを禁止している場合「起動した画面で開く」は使用できません - X-Frame-Options HTTPの設定をヘッダーにしているとiframeの読み込みができません - 詳しくは[こちらのドキュメント](https://developer.mozilla.org/ja/docs/Web/HTTP/X-Frame-Options)をご参照ください - アプリの開き方で「新しいウィンドウで開く」は常に新しいウィンドウで開きます（targetが常に_blank） - 起動したウィンドウ毎に拡張機能実行IDが異なります - 例えば拡張機能実行ID1の画面Aを開いたとしてセッションに拡張機能実行ID1を保持する - 次に拡張機能実行ID2の画面Bを開いたとする - この時にセッションは拡張機能実行ID2に上書きする - 上記のような挙動にしていた場合、そのまま画面Aで何か操作をしようとすると、拡張機能実行ID1のつもりが拡張機能実行ID2になっている、というような混乱が起きる可能性があります - そのため複数ウィンドウの拡張機能実行IDとセッションに関する処理にはご注意ください - [公開しているサンプルアプリ](https://github.com/hamee-dev/extension-bulk-update-orders)では拡張機能実行IDはセッションには持たずGETパラメータとして引き継ぎ回すなどの対策をとっていますのでご参考ください --- # 拡張機能について URL: https://developer.next-engine.com/guides/tutorial/extension-function-sample/ ## 拡張機能とは メイン機能本体の機能を拡張することが出来る機能です。 以下の動画のように検索画面から対象を選択して任意の処理を行うことが可能です。 例えば対象伝票を選択して一括で受注キャンセルにする、一括で納品書を印刷するなどの処理が可能となります。 現在は受注伝票管理画面のみ対応しております。 ![拡張機能とは](/images/a5e3d87b43b9.gif) 検索結果の左端にチェックボックスがあり、それを1つ以上選択している状態だと画面下部に拡張機能メニューが表示されます。 こちらから実行したい任意の機能を選択し実行することが可能です。 --- ## 拡張機能のメリット - 開発コストの削減（検索機能開発不要） - 提供可能機能の拡大 - 販売機会の拡大 --- # チュートリアル URL: https://developer.next-engine.com/guides/tutorial/ # チュートリアル ネクストエンジン API の実装例・サンプルコードをカテゴリ別に紹介します。 - [シングル機能サンプル](/guides/tutorial/single-function-sample/) — 単一API呼び出しのサンプル - [拡張機能サンプル](/guides/tutorial/extension-function-sample/) — 複数API連携のサンプル - [FuelPHP サンプル](/guides/tutorial/sample-fuelphp/) — PHP フレームワーク利用例 初めての方は [クイックスタート](/guides/quickstart/) からお読みください。 --- # はじめに - ネクストエンジンアプリ基盤を動かす URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/about-sample/ ### はじめに - ネクストエンジンアプリ基盤を動かす ネクストエンジンアプリ基盤の初期設定と、ネクストエンジンAPIを利用する方法です ※1 ダウンロードページ1でのDBへの接続情報の設定やマイグレーションは済んでいるものとします ※2 アプリの作成や利用許可など、アプリを使うためのネクストエンジン側の設定については[こちら](https://manual.next-engine.net/pf/pf017/)を御覧下さい なお、ネクストエンジンアプリ基盤を利用するためには、`https`のローカル環境が必要になります 設定をしたのに動作しないと思った際には、お確かめ下さい --- #### ネクストエンジンAPIの設定を更新 アプリを動作させるためには、`client_id`, `client_secret`が必要です [ネクストエンジン](https://base.next-engine.org/apps/make/)の、`アプリを作る > 設定 > API`から取得して下さい client_idとclient_secretを入手したら、 `fuel/app/config/nextengine.php`を編集します 各項目を`*************************`の部分に入力して下さい なお、redirect_uriのパスは、実装済みの認証コントローラを利用するために、`/auth/callback`にして下さい ``` '*************************', 'client_secret' => '*************************', 'redirect_uri' => 'https://localhost/auth/callback', 'debug' => array( // 今回の説明上関係ないため省略 ) ); ``` これで、ネクストエンジンAPIを使用するための設定が終わりました --- #### ログインする 次に、実際にネクストエンジンAPIを利用してログインをしてみます まず、`https://localhost/auth/login`(ポートやパスは自分の環境に合わせて修正) へアクセスして下さい ![認証完了](/images/daf2637463c7.png) `https://localhost/auth/callback`へリダイレクトされ、画像のような画面が出たら、ログイン成功です データベースのcompanies, usersテーブルを見てみると、企業データとユーザデータが1件ずつ挿入されています --- #### APIを試す ネクストエンジンAPIを使用するデモも用意しました ※ 取得系のAPIのみしか使用していません その他APIについては、SDKのドキュメント2をお読み下さい `https://localhost/demo/api/find`にアクセスして下さい ![認証完了](/images/1675dd0d99c7.png) ネクストエンジンAPIを使用してメイン機能のデータが表示されます なお、この画面を担当しているコントローラは、 `fuel/app/modules/demo/classes/controller/api.php`です こちらのファイルを書き換えてもアプリへの影響はないため、 APIを試すデモファイルとして、各APIをお試し下さい --- ##### 更新履歴 - 2015/02/17: はじめに - ネクストエンジンアプリ基盤を動かすページ作成 --- 1. [デモのダウンロード](./download); ↩ 2. [ネクストエンジンAPI SDK ドキュメント](/sdk) ↩ --- # はじめに - Vagrantについて URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/about-vagrant/ ### Vagrantについて [Vagrant](https://www.vagrantup.com/)を使用してローカル環境を構築できます boxを追加し、`vagrant up`でVMを起動します ```bash $ vagrant box add --name centos65_64bit https://github.com/2creatives/vagrant-centos/releases/download/v6.5.3/centos65-x86_64-20140116.box $ cd /path/to/base-fuelphp $ vagrant up ``` プロビジョニングの設定は全てVagrantfileに書かれています そちらをご確認の上、必要であれば修正をお願い致します ### バージョン VMにインストールされるソフトウェア・パッケージのバージョンは下記の通りです | 項目名 | バージョン | | --- | --- | | `CentOS` | 6.5(64bit) | | `Nginx` | 1.0.15 | | PHP | 5.5 | | `MySQL` | 5.6.20 | ### データベースの設定 VM内のデータベースを使用する際は**データベースの設定が必須です** `vagrant up`を実行すると、標準出力に下記の内容が出力されます ``` # The random password set for the root user at Mon Aug 11 00:26:15 2014 (local time): sH6kzNxNbpcyCfgV ``` 行末の`sH6kzNxNbpcyCfgV`（※この値は実行ごとに変わります）をコピーし、下記の手順を行って下さい ```bash $ vagrant ssh [vagrant@vagrant-centos65 ~]$ mysql_secure_installation Enter current password for root (enter for none): # コピーしたパスワードを貼り付け Change the root password? [Y/n] y New password: # 任意のパスワードを入力 Re-enter new password: # 任意のパスワードを入力 Remove anonymous users? [Y/n] y Disallow root login remotely? [Y/n] y Remove test database and access to it? [Y/n] y Reload privilege tables now? [Y/n] y ``` ユーザ名`root`、設定したパスワードでmysqlにログインできれば正しく設定されています 参考：[DBの接続設定の更新 - ネクストエンジンAPI](./download) VM内のデータベースはリモートから接続できない設定にしているため、 DBに関する操作（DBの作成・マイグレーションなど）はVMにログインした状態で行って下さい --- ##### 更新履歴 - 2015/02/17: Vagrantについてページ作成 --- # ネクストエンジンAPI - バッチ処理でAPIを使用する URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/api-batch/ ### ネクストエンジンAPI - バッチ処理でAPIを使用する ここでは、ネクストエンジンAPIクライアントを使用したバッチ処理の作成方法について説明いたします ## バッチ処理でネクストエンジンAPIを使用するために最低限必要なこと バッチ処理でネクストエンジンAPIを使用するために最低限必要なことは、 - `Nextengine\Api\Client`クラスのインスタンスを作成 - そのインスタンスに、DBから取得したModel_Userのインスタンスを`setUser`メソッドを使用しセットする という手順が必要になります また、setUserメソッドでセットされるユーザは、 `access_token`プロパティと`refresh_token`プロパティに値が格納されている前提で動作するため、 事前に`access_token`プロパティと`refresh_token`プロパティの値をチェックする必要があります まとめると、以下の様な処理が最低限必要になります ``` // アクセストークンを持っている(nullでない)ユーザを全件取得 $users = \Model_User::findBy('access_token', null, '!='); // それら全てのユーザに対して foreach($users as $user) { // APIクライアントのインスタンスを生成し、 $client = new \Nextengine\Api\Client(); // ユーザをセットし $client->setUser($user); // 何かする } ``` --- ## FuelPHPのタスクを作成 バッチ処理は、FuelPHPのタスク1で実現します タスクを作成するには、`oil generate task`コマンドを使用します ```bash $ cd /path/to/sample-fuelphp $ php oil generate task [任意のタスク名] ``` `[任意のタスク名]`には、アルファベットのみ指定できます 今回は、デモとして「商品マスタの情報を取得」する`goods`タスクを作成します 商品マスタを取得するタスクは、`fetch_master`メソッドで実装します 早速oilコマンドを使ってファイルを生成します ```bash $ php oil generate task goods fetch_master Preparing task method [Fetch master] Creating tasks: /Users/SYS-INOUE/work/noob/tmp/fuel/app/tasks/goods.php ``` 生成された`fuel/app/tasks/goods.php`を開き、 `fetch_master`メソッドを編集します ``` /** * This method gets ran when a valid method name is not used in the command. * * Usage (from command line): * * php oil r goods:fetch_master * * @return string */ public function fetch_master() { // アクセストークンを保持しているユーザのみ取得する $users = \Model_User::findBy('access_token', null, '!='); foreach($users as $user) { $client = new \Nextengine\Api\Client(); $client->setUser($user); // 商品マスタの情報を取得する $response = $client->apiExecute('/api_v1_master_goods/search', array( 'fields' => 'goods_id,goods_name,stock_quantity,supplier_name', 'limit' => 1000, )); $goods = $response['data']; echo count($goods)."件の商品マスタの情報を取得しました".PHP_EOL; } } ``` 1. アクセストークンを持っている全ユーザに対して、 2. 商品マスタ検索APIから 3. `goods_id,goods_name,stock_quantity,supplier_name`といったフィールドを持つレスポンスを 4. 1000件取得し 5. 取得できた件数をechoして終了 という処理をしています 使用できるAPIや引数については、[APIのドキュメント](/api)を御覧下さい --- このタスクを実行してみます タスクを実行するには、`oil refine [タスク名](:メソッド名)`コマンドを使用します ```bash $ php oil r goods:fetch_master 1000件の商品マスタの情報を取得しました ``` 期待通りの動作をしています このように、APIを使用するバッチ処理を記述して下さい --- ##### 更新履歴 - 2015/02/17: ネクストエンジンAPI - バッチ処理でAPIを使用するページ作成 --- 1. Tasks - 概要 - FuelPHP ドキュメント [http://fuelphp.jp/docs/1.7/general/tasks.html](http://fuelphp.jp/docs/1.7/general/tasks.html) ↩ --- # ネクストエンジンAPI - はじめに URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/api-beginning/ ### ネクストエンジンAPI - はじめに ここでは、ネクストエンジンAPIクライアントの アクセストークンとリフレッシュトークンに関連する処理について説明いたします ネクストエンジンAPIクライアントクラスが記述されているファイルは、 `fuel/packages/nextengine/classes/nextengine`以下となります ## アクセストークンのリフレッシュ リフレッシュトークンについては、[APIのドキュメント](/api/refresh_token)の「利用方法：SDKを利用する方 」を御覧下さい 上記リンクにあるように、 ネクストエンジンAPIクライアントのアクセストークンとリフレッシュトークンは自動的に更新されるため、 それらが更新された時に、DBが持っているアクセストークンとリフレッシュトークンも更新しなければなりません そのため、APIクライアントクラスでは以下の様な処理をapiExecuteに加えています 記述されているファイルは、`fuel/packages/nextengine/classes/nextengine/client.php`です ``` /** * ネクストエンジンAPIを叩く * * ### 親クラスからの拡張点 * - userプロパティがセットされており、アクセストークンが更新されたら自動でDBの値を更新する * - レスポンスに含まれるresultフィールドの値がsuccessでないなら、例外をスローするという処理を追加した * * @throws NextengineApiException * @return mixed APIのレスポンス詳しくはhttp://api.next-e.jp/request_url.phpを参照 */ public function apiExecute($path, $api_params = array(), $redirect_uri = NULL) { $before_exec_access_token = $this->_access_token; $response = parent::apiExecute($path, $api_params, $redirect_uri); // NOTE: エラーの種類については→を参照：http://api.next-e.jp/message.php // エラー時の振る舞いについては、本クラスのfailoverメソッドを参照 if($response['result'] !== self::RESULT_SUCCESS) { $this->failover($response['code'], $response['message']); } // APIを叩く前後でアクセストークンが変わっていたら、ユーザモデルを更新してDBに反映、セッションも更新する // ユーザモデルが格納されていない場合もあるため、その場合は処理しない if(!is_null($this->user) && ($before_exec_access_token !== $this->_access_token)) { $this->user->access_token = $this->_access_token; $this->user->refresh_token = $this->_refresh_token; $this->user->save(); $user_key = \Config::get('session.keys.ACCOUNT_USER'); \Session::set($user_key, $this->user); } return $response; } ``` 「エラー時の振る舞い」と書かれている箇所については後述します `parent::apiExecute()`を実行する前にアクセストークンを保存しておき、 親クラスのapiExecuteを実行した前後でアクセストークンの値が変更されていたら、 セットされているModel_Userのインスタンスを通じて、DBに保存されているアクセストークンとリフレッシュトークンを更新します つまり、このネクストエンジンAPIクライアントを使用している限り、 アクセストークンやリフレッシュトークンの更新について気を配る必要はありません --- ## APIレスポンスのエラー処理 次に、APIからのレスポンスにエラー情報が含まれていた場合に、 それを例外へ変換する処理について説明いたします ネクストエンジンAPIのレスポンスに含まれるエラーと原因一覧は、 [APIのドキュメント](/api/param/message)を御覧下さい これらのエラー情報がレスポンスに含まれていた場合、 ネクストエンジンAPIクライアントクラスは例外(`Nextengine\Api\NextengineApiException`)をスローします その例外をキャッチし、開発者やネクストエンジンの営業へ通知メールを飛ばす必要がある例外 （料金未払いによる利用停止やシステムエラーなど）だった場合には、通知メールを送信します まずは例外をスローしているメソッドについて説明いたします 該当ファイルは、先ほどと同じく`fuel/packages/nextengine/classes/nextengine/client.php`です ``` /** * ネクストエンジンAPIからエラーが返っていた場合の処理する * @param string $code NextengineApiExceptionに渡すエラーコード * @param string $message NextengineApiExceptionに渡すエラーメッセージ * @return void * @throws NextengineApiException */ protected function failover($code, $message) { // NOTE: ログにログレベルERRORで書き込む $log = '['.$code.']'.$message; \Log::error($log); // 開発者にメール送信 $this->reportToDeveloper($code, $message); // 受け取ったコード、メッセージを例外としてスローする try { throw new NextengineApiException($message, $code); } catch(NextengineApiException $e) { switch($e->getCode()) { // 支払い等の理由で利用停止、システムエラー => 営業に問い合わせて下さい画面へリダイレクト case '001007': // [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています[xxxxx] case '002003': // [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています[xxxxx] case '003003': // [xxxxx]様のメイン機能が、利用停止です $this->reportToSales($code, $message); break; } // NOTE: 握りつぶさずにスローしなおす throw $e; } } ``` この`failover`メソッドは、先ほどのapiExecuteメソッド内でコールされます メソッド内部で`reportToDeveloper`, `reportToSales`メソッドがコールされていますが、 単にメールを送信するだけのユーティリティのため、詳細は割愛します また、このクラスを継承したクラスで更に例外処理を分岐させるために、キャッチした例外を再度スローしています 具体的な使用例は、[Client_Router](./api-controller)クラスを御覧下さい --- 次に、通知メールの送信先の設定について説明いたします `fuel/app/config/nextengine.php`を御覧下さい ``` return array( 'client_id' => '2zG7d5MjXPh4m8', 'client_secret' => 'FTNubmlpyAgE5e3BnqWt6IHJ18voxVkMS9Yh4Zjc', 'redirect_uri' => 'https://localhost:8443/ne-base/auth/callback', 'debug' => array( // デバッグや通知メールの送信先(開発者) 'developer' => array( 'xxxxxxxxxx@hamee.co.jp', ), // デバッグや通知メールの送信先(営業) 'sales' => array( 'xxxxxxxxxx@hamee.co.jp', ), 'mail_subject' => "[NE-API] NextengineApiException" ) ); ``` この設定ファイルの`debug`の中に、通知メールの送信先を設定することができます 送信先は複数設定することができます debugの中に含まれている各キーの説明をいたします | キー名 | 型 | 説明 | | --- | --- | --- | | `developer` | string[] | 通知メールの送信先(開発者) | | `sales` | string[] | 通知メールの送信先(営業) | | `mail_subject` | `string` | 通知メールの件名 | `developer`に設定されたメールアドレスには、例外が発生した時必ずメールを送信します `sales`に設定されたメールアドレスには、支払い等の理由で利用停止やシステムエラーのときのみ通知メールを送信します --- ##### 更新履歴 - 2015/02/17: ネクストエンジンAPI - はじめにページ作成 --- # ネクストエンジンAPI - コントローラでAPIを使用する URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/api-controller/ ### ネクストエンジンAPI - コントローラでAPIを使用する ここでは、コントローラで使用するためのネクストエンジンAPIクライアント、 `Nextengine\Api\Client_Router`クラスについてご説明致します このクラスは、APIのレスポンスによってエラー画面へリダイレクトさせることが主な役割です そのため、Client_Routerというクラス名にしております Client_Routerクラスは、`fuel/packages/nextengine/classes/nextengine/api/client/router.php`に記述されています また、このクラスは[Controller_Neapi](./controller-neapi)で使用されております あわせてお読み下さい ## Clientクラスとの相違点 親クラスであるClientクラスとの相違点は、大きく分けて２点あります ### 1. failoverメソッドでリダイレクトする ネクストエンジンAPIからのレスポンスにエラーが含まれていると、例外がスローされます1 このとき、 - メイン機能もしくはネクストエンジンがメンテナンス中 - 受注の取り込み中やアクセスが集中している - 料金未払いによる利用停止やシステムエラー などのエラーだった場合には、該当するエラー画面へリダイレクトします それぞれのエラー画面は、とても簡素なHTMLになっていますアプリに合わせてコーディングし直して下さい それ以外のエラーだった場合には、キャッチした例外を再スローします そのため、ネクストエンジンAPIクライアントを利用している際に、該当する例外が発生したら自動的にリダイレクトされます ``` protected function failover($code, $message) { // 親クラスがスローする例外をキャッチし、その詳細を解析する try { parent::failover($code, $message); } catch(NextengineApiException $e) { // NOTE: redirectはexitを実行するため、`break;`を書かないでも動作するが、 // redirectじゃない処理に変えた時に意図しないバグを防ぐためbreakを入れている switch($e->getCode()) { // メンテナンス中 => メンテナンス中です画面へリダイレクト case '002007': // 現在ネクストエンジンサーバーがメンテナンス中の為、再度時間を置いてからアクセスして下さい case '003004': // 現在メイン機能サーバーがメンテナンス中の為、再度時間を置いてからアクセスして下さい \Response::redirect('/error/maintenance'); break; // 混み合ってます、受注取り込み中です => しばらく待ってアクセスして下さい画面へリダイレクト case '003001': // 現在メイン機能サーバーが混み合っております。再度時間を置いてからアクセスして下さい case '003002': // 現在メイン機能サーバーが混み合っております。再度時間を置いてからアクセスして下さい case '008003': // 受注取込中のため、更新できません case '008007': // 納品書印刷中の伝票があります時間を空けて再度APIを実行して下さい case '008010': // 棚卸中のため、更新できません \Response::redirect('/error/congestion'); break; // 支払い等の理由で利用停止、システムエラー => 営業に問い合わせてねエラー画面へリダイレクト case '001007': // [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています[xxxxx] case '002003': // [xxxxx]様のネクストエンジンが、次の理由により利用停止になっています[xxxxx] case '003003': // [xxxxx]様のメイン機能が、利用停止です case '999999': // APIサーバーのシステムエラーが発生しました \Response::redirect('/error'); break; default: throw $e; } } } ``` --- ### 2. authenticateメソッド [Controller_Auth](./controller-auth)クラスにて説明いたしました authenticateメソッドはユーザのuidを引数に取り、 - ネクストエンジンAPIの認証処理 - 必要であれば、企業情報、ユーザ情報を作成しDBに保存 - ユーザモデルをネクストエンジンAPIクライアントのインスタンスにセット という処理をします 具体的なコードは以下の通りです ``` /** * ユーザのuidを用いて認証する * DB < APIの順でコストが高く、APIを使用することはなるべく避けたい * そのため、まずDBを見てから、仕方ない場合のみAPIを叩く形にしている * FIXME: 戻り値で配列を使用しているため、ややオレオレ仕様になっている * * ```php * list($company, $user) = $client->authenticate($uid); * ``` * * @param string $uid ユーザのuid * @return array [Model_Company, Model_User]のインスタンスの配列listで受け取る想定 */ public function authenticate($uid) { // APIを１回は呼ばないと、アクセストークンとリフレッシュトークンが入手できない $company = $this->_createCompany(); $users = \Model_User::findBy('uid', $this->_uid); // uidに対応するユーザがいる場合、そのまま利用する if(count($users) > 0) { $user = $users[0]; // uidに対応するユーザが居ない場合、APIを叩き認証する } else { // NOTE: fキー制約の都合でcompanyが先、elseと並び順が違うのは意図的 $user = $this->_createUser($company->id); } $this->setUser($user); return array($company, $user); } ``` 内部で`_createCompany`, `_createUser`メソッドがコールされていますが、 どちらもAPIからレスポンスを取得しDBに情報を保存するユーティリティのため、詳細は割愛致します `Controller_Auth`に記述された認証処理を変更したい際には、ご参考にして下さい --- ##### 更新履歴 - 2015/02/17: ネクストエンジンAPI - コントローラでAPIを使用するページ作成 --- 1. [ネクストエンジンAPI - はじめに](./api-beginning) ↩ --- # ネクストエンジンAPI - アクセストークンのリフレッシュバッチ URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/api-refresh/ ### ネクストエンジンAPI - アクセストークンのリフレッシュバッチ ここでは、アクセストークンをリフレッシュするためのバッチ処理について説明いたします --- ## oil task user:refresh リフレッシュタスクを呼び出すには、以下のコマンドを入力します ```bash $ cd /path/to/sampel-fuelphp $ php oil refine user:refresh ``` このコマンドを実行すると、 DBに格納されているアクセストークンが更新可能なユーザ全てのアクセストークンがリフレッシュされます このバッチ処理はFuelPHPのタスク1で実装されており、 記述されているファイルは`fuel/app/tasks/user.php`です --- ## コードの解説 次に、どのようなタスクが実行されているのか、 具体的なコードを載せて説明いたします 上記ファイル内で、アクセストークンをリフレッシュする`refresh`メソッドを抜粋します ``` /** * ユーザのアクセストークンをリフレッシュするタスク * user_idを与えるとそのIDのユーザのアクセストークンのみリフレッシュする * * ## Usage (from command line): * `php oil r user:refresh [user_id]` * * @return string */ public function refresh($user_id = null) { if(is_null($user_id)) { $users = \Model_User::findAll(); } else { // NOTE: 1件でも全件でもforeachで回すためにあえて配列に格納している $users = array(\Model_User::find($user_id)); } foreach($users as $user) { if(is_null($user)) continue; if(is_null($user->access_token) || is_null($user->refresh_token)) continue; $this->_refresh($user); } } ``` refreshメソッドは、アクセストークンをリフレッシュするメソッドです - ユーザを全件（`$user_id`が与えられた場合は１件）DBから取得 - 取得したユーザに対して - `$user`がNULLでなく、かつアクセストークンとリフレッシュトークンがセットされていれば、 - そのユーザのアクセストークンをリフレッシュする --- refreshメソッドはDBから取得したデータのチェックと_refreshを呼び出します 実際にアクセストークンをリフレッシュしている`_refresh`メソッドは、以下の通りです ``` /** * アクセストークンをリフレッシュする実体部 * @param Model_User $user トークンを更新したいユーザオブジェクト * @return boolean 更新に成功したらtrue、更新が必要なかった場合もtrue */ private function _refresh(\Model_User $user) { $client = new \Nextengine\Api\Client(); $client->setUser($user); $client->apiExecute('/api_v1_login_user/info'); } ``` - ネクストエンジンAPIクライアントのインスタンスを生成し - そのインスタンスにModel_Userの情報をセットし - ユーザ情報のAPIにアクセスする という処理をします [ネクストエンジンAPIクライアント](./api-beginning)でも説明いたしましたが、 apiExecuteが実行された前後で、APIクライアント内のアクセストークン・リフレッシュトークンが更新されていたら、 DB内のアクセストークン・リフレッシュトークンも更新する処理を記述しています そのため、何らかのAPIを実行すれば、DBのアクセストークン・リフレッシュトークンを更新することができます --- ##### 更新履歴 - 2015/02/17: ネクストエンジンAPI - アクセストークンのリフレッシュバッチページ作成 --- 1. Tasks - 概要 - FuelPHP ドキュメント [http://fuelphp.jp/docs/1.7/general/tasks.html](http://fuelphp.jp/docs/1.7/general/tasks.html) ↩ --- # マジックメソッドの動作速度 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/benchmarks/magic-method/ ### 検証：マジックメソッドの動作速度 マジックメソッド（`__get`, `__set`）を使用したプロパティアクセスと、 マジックメソッドを使用しないプロパティアクセスの動作速度を検証しました 結果としては、マジックメソッドは遅いです 絶対値で見れば僅かな差ですが、相対的に見ると**約15倍**通常のプロパティアクセスの方が高速です ## プロパティが１つの場合 ### テストコード ``` define('NL', php_sapi_name() === 'cli' ? "\n" : "
"); // 計測結果の少数第何位まで表示するか define('ROUND_DIGIT', 10); function benchmark($name, $test_fn, $step = 10) { $times = array(); $memories = array(); for($ii = 0; $ii < $step; $ii++) { $start = time() + microtime(); $test_fn(); $memories[] = memory_get_usage(true); $end = time() + microtime(); $sub = $end - $start; $current = $ii + 1; echo sprintf("%d/%d => %.".ROUND_DIGIT."f%s", $current, $step, $sub, NL); $times[] = $sub; } $total_time_ms = array_sum($times) * 1000; $total_memory = array_sum($memories); echo "=============================================".NL; echo sprintf("Result for '%s'%s", $name, NL); echo sprintf("Time:total: %.".ROUND_DIGIT."f ms%s", $total_time_ms, NL); echo sprintf("Time:average: %.".ROUND_DIGIT."f ms%s", $total_time_ms / $step, NL); echo sprintf("Memory:average: %d B (%.4f MB)%s", $total_memory / $step, ($total_memory / $step) / 1024, NL); echo sprintf("Memory:max: %d B (%.4f MB)%s", memory_get_peak_usage(true), memory_get_peak_usage(true) / 1024, NL); echo "=============================================".NL.NL; } define('TEST', 1000); set_time_limit(600); // マジックメソッドを使用しないクラス class Model { public $id = 1; } // マジックメソッドを使用するクラス class MagicModel { public $attributes = array( 'id' => 1, ); public function __set($name, $value) { $this->attributes[$name] = $value; } public function __get($name) { return $this->attributes[$name]; } } benchmark('マジックメソッドを使用しないプロパティアクセス', function() { $model = new Model(); for($ii = 0; $ii < 10000; $ii++) { $tmp = $model->id; // 取得 $model->id = $ii; // 設定 } }); benchmark('マジックメソッドを使用したプロパティアクセス', function() { $model = new MagicModel(); for($ii = 0; $ii < 10000; $ii++) { $tmp = $model->id; // 取得 $model->id = $ii; // 設定 } }); ``` ### ベンチマーク結果 ``` 1/10 => 0.0022928715 2/10 => 0.0022192001 3/10 => 0.0021739006 4/10 => 0.0021870136 5/10 => 0.0022110939 6/10 => 0.0024940968 7/10 => 0.0043790340 8/10 => 0.0033369064 9/10 => 0.0035238266 10/10 => 0.0023758411 ============================================= Result for 'プロパティ１つのクラスでマジックメソッドを使用しないプロパティアクセス' Time:total: 27.1937847137 ms Time:average: 2.7193784714 ms Memory:average: 262144 B (256.0000 MB) Memory:max: 262144 B (256.0000 MB) ============================================= 1/10 => 0.0422289371 2/10 => 0.0485138893 3/10 => 0.0372209549 4/10 => 0.0458679199 5/10 => 0.0456209183 6/10 => 0.0451428890 7/10 => 0.0421690941 8/10 => 0.0383639336 9/10 => 0.0446751118 10/10 => 0.0502278805 ============================================= Result for 'プロパティ１つのクラスでマジックメソッドを使用したプロパティアクセス' Time:total: 440.0315284729 ms Time:average: 44.0031528473 ms Memory:average: 262144 B (256.0000 MB) Memory:max: 262144 B (256.0000 MB) ============================================= ``` --- ## プロパティを増やした場合 マジックメソッドはプロパティを走査するため、 プロパティを走査するのであれば、プロパティが増えれば取得にかかる時間も増えるという仮説のためにクラスとベンチマークスクリプトを少し書き換えます ネクストエンジンAPIの[商品マスタ](/api/fields/master_goods)から取得できる項目を、 すべてクラスのプロパティとして定義し、その動作速度を検証します これは、商品マスタの情報をDBに蓄積して利用するモデルがある想定です #### テストコード ``` class Model { public $goods_id = 1; // 商品コード public $goods_representation_id = 1; // 代表商品コード public $goods_name = 1; // 商品名 // 長いので省略 } class MagicModel { public $attributes = array( 'goods_id' => 1, // 商品コード 'goods_representation_id' => 1, // 代表商品コード 'goods_name' => 1, // 商品名 // 長いので省略 ); } ``` 結果を先に説明すると、相対的に遅くなっています #### ベンチマーク結果 ``` 1/10 => 0.0039870739 2/10 => 0.0042259693 3/10 => 0.0039098263 4/10 => 0.0054919720 5/10 => 0.0052731037 6/10 => 0.0038580894 7/10 => 0.0054771900 8/10 => 0.0068209171 9/10 => 0.0062510967 10/10 => 0.0057909489 ============================================= Result for 'プロパティ110個のクラスでマジックメソッドを使用しないプロパティアクセス' Time:total: 51.0861873627 ms Time:average: 5.1086187363 ms Memory:average: 524288 B (512.0000 MB) Memory:max: 524288 B (512.0000 MB) ============================================= 1/10 => 0.0822989941 2/10 => 0.0844771862 3/10 => 0.0775389671 4/10 => 0.0746560097 5/10 => 0.0761110783 6/10 => 0.0804190636 7/10 => 0.0751941204 8/10 => 0.0845780373 9/10 => 0.0734241009 10/10 => 0.0821299553 ============================================= Result for 'プロパティ110個のクラスでマジックメソッドを使用したプロパティアクセス' Time:total: 790.8275127411 ms Time:average: 79.0827512741 ms Memory:average: 524288 B (512.0000 MB) Memory:max: 524288 B (512.0000 MB) ============================================= ``` --- - 2015/02/17: 検証：マジックメソッドの動作速度ページ作成 --- # はじめに - コーディング規約 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/coding-standards/ ### コーディング規約 ### FuelPHPのコーディング規約との差分 ネクストエンジンアプリ基盤が推奨するコーディング規約と、 [FuelPHPが推奨しているコーディング規約](http://fuelphp.jp/docs/1.7/general/coding_standards.html)には、２点差異があります #### 1. ブレース（波括弧）について FuelPHPではクラス、メソッドのブロックを表すブレースは1行下げますが、 その限りではなく、プロジェクト内で統一されていれば良しとします ``` // FuelPHPのコーディング規約 class Hoge { public function hogeFoobar() { // do something... } private static function fizzBuzz() { // do something... } } // どちらでも可 class Hoge { public function hogeFoobar() { // do something... } private static function fizzBuzz() { // do something... } } ``` #### 2. メソッド名 FuelPHPではクラスのメソッド名は`スネークケース`で記述することになっていますが、 メソッド名は`キャメルケース`で記述するルールを設けます ``` class Hoge { // publicもprivateもstaticも全てキャメルケースで定義する public function hogeFoobar() {} private static function fizzBuzz() {} } ``` --- ##### 更新履歴 - 2015/02/17: コーディング規約ページ作成 --- # はじめに - 設定 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/config/ ### 設定 ネクストエンジンアプリ基盤で設定可能な項目の一覧です 各設定ファイルのコメントに詳細説明が書かれているので、詳しくはそちらをご覧下さい ※Fuelに最初から入っている設定項目の説明は公式ドキュメントをお読み下さい — [FuelPHP ドキュメント](http://fuelphp.jp/docs/1.7/) #### セッション設定 セッションに関する設定です 該当ファイル：`fuel/app/config/session.php` | 項目名 | 型 | 概要 | | --- | --- | --- | | keys.ACCOUNT_USER | `string` | ユーザIDを格納するセッションのキー名 | | keys.ACCOUNT_COMPANY | `string` | 企業IDを格納するキセッションのー名 | --- #### ログ設定 Fuelデフォルトのログではなく、企業ID別にログを出力するための設定です 該当ファイル：`fuel/packages/base/config/base.php` | 項目名 | 型 | 概要 | | --- | --- | --- | | log.base_path | `string` | ログファイルのルートディレクトリ | | log.level | int | ログレベルの指定 | | log.file_name | `string` | ログファイルのファイル名(内部でdate関数をコールした結果になります) | --- #### ネクストエンジンAPI設定 ネクストエンジンアプリの設定です 該当ファイル：`fuel/packages/nextengine/config/nextengine.php` | 項目名 | 型 | 概要 | | --- | --- | --- | | `client_id` | `string` | 実装するネクストエンジンアプリのclient_id | | `client_secret` | `string` | 実装するネクストエンジンアプリのclient_secret | | `redirect_uri` | `string` | 実装するネクストエンジンアプリのredirect_uri | --- ##### 更新履歴 - 2015/02/17: 設定ページ作成 --- # コントローラ - Controller_Authクラス URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/controller-auth/ ### コントローラ - Controller_Authクラス ここでは、`Base\Controller_Auth`クラスについて説明いたします このコントローラは、ネクストエンジンAPIを利用した認証処理を実装してあるコントローラです 認証処理ですと、Authパッケージ内に含まれる`Opauth`がありますが、 DB構造や、ログイン処理とネクストエンジンAPIとの相性の兼ね合いにより、使用しておりません #### _initメソッド `_init`メソッドの処理は以下の通りです - 言語ファイルの読み込み(Controller_Baseの_initを呼び出す) - ネクストエンジンAPIクライアントクラスのインスタンス生成 以後、ネクストエンジンAPIクライアントクラスのインスタンスには、`self::$client`でアクセスすることができます ``` private static $client; public static function _init() { parent::_init(); // NOTE: 認証画面ではコンストラクタに何も渡せない（login時には何も渡せるものがないので、ナシで統一） self::$client = new \Nextengine\Api\Client_Router(); } ``` --- #### get_loginメソッド `get_login`メソッドでは、ネクストエンジンAPIクライアントクラスの`neLogin`メソッドを呼び出しています neLoginの認証処理につきましては、[こちらの資料](/sdk#php)を御覧下さい ``` public function get_login() { self::$client->neLogin(); } ``` --- #### get_logoutメソッド `get_logout`メソッドでは、ネクストエンジンAPIの機能は利用しておりません 現在のセッションを破棄します ``` public function get_logout() { \Session::destroy(); } ``` **親クラスではリダイレクトを行わない**ため、 `fuel/app/classes/controller`に定義された`Controller_Auth`にて、リダイレクト処理を記述して下さい ※ 既にトップページへリダイレクトする処理が書かれておりますが、 こちらの処理は書き換えていただいても問題ありません ``` public function get_logout() { parent::get_logout(); \Response::redirect('/'); } ``` --- #### get_callbackメソッド `get_callback`メソッドは、ネクストエンジンAPIの認証が済むとリダイレクトされるメソッドです セッションやGETパラメータの値を見て、認証済みのデータをDBとセッションに保存します 処理の詳細は、ソースコードおよび上記リンクを御覧下さい ``` public function get_callback() { // ネクストエンジンAPIの認証処理 } ``` `get_callback`もリダイレクトを行わないため、子クラスの`Controller_Auth`にリダイレクト処理を記述しています ``` public function get_callback() { parent::get_callback(); // NOTE: 動作デモを試したら、コメントアウトを解除して任意の場所へリダイレクトさせて下さい // http://api.next-e.jp/secret/sample-fuelphp/about-sample.php // \Response::redirect('/demo/api/find'); // NOTE: 上記を編集しリダイレクトさせる場合には下記の記述は不要です $this->template->title = 'Authenticate complete!!'; $this->template->content = ""; } ``` --- #### 処理を拡張する これらの処理はすべて`base`パッケージの中で実装されており、 `fuel/app/classes/controller/auth.php`に、それを継承したクラスが定義されています baseパッケージのコントローラファイルを直接編集すると差分の反映が困難になるため、 拡張や変更がある場合には`fuel/app/classes/controller`に記述されているクラスを拡張して下さい 例えば、企業モデルやユーザモデルにカラムを追加する場合には、 `_create_company`, `_create_user`メソッドをオーバーライドして追加したカラムの値も設定することで実現できます 必要に応じてメソッドを拡張して下さい ``` protected function _create_company(array $company_info) { $company = parent::_create_company($company_info); // NOTE: ここに任意のパラメータを入れ込む処理を記述できます return $company; } // ... protected function _create_user(array $user_info, $company_id) { $user = parent::_create_user($user_info, $company_id); // NOTE: ここに任意のパラメータを入れ込む処理を記述できます return $user; } ``` --- ##### 更新履歴 - 2015/02/17: コントローラ - Controller_Authクラスページ作成 --- # コントローラ Controller_Baseクラス URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/controller-base/ ### コントローラ - Controller_Baseクラス ここでは、コントローラの基底クラスである`Base\Controller_Base`について説明いたします また、多言語対応のアプリのために、多言語化についても説明いたします ## Controller_Baseが記述されているファイル Controller_Baseクラスは、 `fuel/packages/base/classes/controller/base.php` に定義されています このクラスでは、`before`メソッドと`_init`メソッド、 _initメソッドで使用しているユーティリティを定義しています --- ## beforeメソッド beforeメソッドでしていることは以下の通りです 1. ユーザがアプリにログイン済みなら、DBからそのユーザ情報と企業情報を取得する ログインをしていればこのプロパティに自動でセットします このクラスを継承したコントローラであれば`$this->company`と`$this->user`からアクセスできます `company`, `user`プロパティのデフォルト値は`null`です プロパティの値がnullだったらユーザがログインしていないと判定することができます --- ## _initメソッド _initメソッドでしていることは以下の通りです 1. ユーザの設定言語を取得し 2. その言語にそった言語ファイルのロードをする 多言語対応については次章で説明します ``` abstract class Controller_Base extends Controller_Template { // ... public static function _init() { // 言語のセット $locale = self::getLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']); \Config::set('language', $locale); // 言語ファイルのロード \Lang::load('common.yml', 'common'); \Lang::load('model.yml', 'model'); \Lang::load('page.yml', 'page'); \Lang::load('message.yml', 'message'); } } ``` --- ## 多言語化対応 ネクストエンジンアプリ基盤では、多言語化対応するための処理が記述されています 言語の設定処理(_initメソッド)と、言語ファイルは既に作成済みです 言語ファイルは`fuel/app/lang`以下に配置されています `en`が英語、`ja`が日本語のファイルとなっています 言語フォルダの命名や、詳しい仕様方法などは[公式ドキュメント](http://fuelphp.jp/docs/1.7/classes/lang.html)をご覧下さい _initメソッドでは４つの言語ファイルを読み込んでいます この４ファイルの使い分けについては下記の表を御覧下さい | ファイル名 | 使用方法 | | --- | --- | | common.yml | アプリ・システム全体で使用する共通の文言を記述する | | model.yml | モデルのデータを多言語化するための文言を記述する | | page.yml | ページに表示する、汎用的でない文言を記述する | | message.yml | エラーメッセージや通知メッセージなど、ユーザへ知らせるメッセージを記述する | 上記以外に言語ファイルを作成することも、既存の言語ファイルを削除することも可能です その際は、言語ファイルに合わせて必ず_initメソッドを変更して下さい --- 多言語対応のデモとして、`fuel/app/views/error/index.php`を説明いたします ```

``` Controller_Baseクラスを継承したコントローラであれば、 コントローラ側で多言語対応について気を配る必要はありません ビュー側で、ページに表示する文言を取得し、表示します このページで使用している言語ファイル`fuel/app/lang/ja/page.yml`は以下の通りです ``` error: title: '内部エラーが発生しました' suggestion: 'お手数ですが、サポートにお問い合わせ下さい' support_page: 'お問い合わせ | ネクストエンジン' maintenance: title: 'メイン機能、ネクストエンジンがメンテナンス中です' suggestion: 'お手数ですが、しばらく時間をおいてからアクセスして下さい' congestion: title: 'システムが混み合っています' suggestion: 'お手数ですが、しばらく時間をおいてからアクセスして下さい' ``` 特別なキーワードがあるわけではなく、任意のキー名を用いることができます プロジェクトごとにキーの命名規約を設けて、ご活用下さい --- ##### 更新履歴 - 2015/02/17: コントローラ - Controller_Baseクラスページ作成 --- # コントローラ - はじめに URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/controller-beginning/ ### コントローラ - はじめに ネクストエンジンAPI関連の処理や、コントローラの構造についての説明です ### コントローラのクラス図 コントローラに関連するクラス図は[こちら](http://api.next-e.jp/sample-fuelphp/apidoc/graphs/class.html)を御覧下さい プロパティやメソッドまで詳細に記述していないため、継承関係や主なクラスの概要を理解するための参考程度にご使用下さい 具体的なクラスの内容については[APIドキュメント](http://api.next-e.jp/sample-fuelphp/apidoc/)を御覧下さい 詳細や注意事項は各ページで説明するため、 ここでは各クラスの概要を説明いたします --- ### コントローラに関連するクラスの概要 基盤として提供しているクラスの概要とリンクです | クラス名 | 役割 | | --- | --- | | `Controller_Template` | FuelPHPが提供しているクラステンプレート機能1を用いることができますBase\Controller_Baseはこのクラスを継承しています | | Base\Controller_Base | (abstract)コントローラの基底クラス多言語対応のために、表示言語の設定や言語ファイルの読み込みなどを行います | | Base\Controller_Neapi | (abstract)ネクストエンジンAPIを利用するコントローラを作成する際にはこちらを継承して下さいController_Baseもですが、abstractクラスになっているため、これらのクラスを継承させずに直接コントローラとして使用することはできません | | Base\Controller_Error | APIのレスポンスにエラー情報が含まれていたときのためのエラー画面を表示させるコントローラです基本的に変数は受け取らず、静的なビューを描画します | | Base\Controller_Auth | ネクストエンジンAPIを用いてログイン処理をするためのコントローラですアクションはlogin, logout, callbackを実装しています | --- ##### 更新履歴 - 2015/02/17: コントローラ - はじめにページ作成 --- 1. Template コントローラ [http://fuelphp.jp/docs/1.7/general/controllers/template.html](http://fuelphp.jp/docs/1.7/general/controllers/template.html) ↩ --- # コントローラ - Controller_Neapiクラス URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/controller-neapi/ ### コントローラ - Controller_Neapiクラス ここでは、ネクストエンジンAPIを使用するコントローラの基底クラスである、`Base\Controller_Neapi`について説明いたします ## beforeメソッド beforeメソッドの処理は以下の通りです 1. ネクストエンジンAPIクライアントのインスタンスを格納 2. ネクストエンジンAPIクライアントのインスタンスにログイン済みのユーザ情報をセット 2でセッションに格納されたユーザ情報ではなく、DBの内容を取得しているのは、 セッションに保存されたアクセストークンが途中で使用期限切れになり、DBの値が更新される恐れがあるためです そのため、常にDBから最新のアクセストークンを取得しています つまり、**画面遷移をするたびにSELECTが実行されます** しかし、最新のアクセストークンを常に取得する必要が有るため、このような処理にしております ``` abstract class Controller_Neapi extends Controller_Base { /** * ネクストエンジンAPIクライアントのインスタンスを格納する * @var \Nextengine\Api\Client */ protected static $client; /** * APIを使用する画面で共通処理として必要な処理、クライアントの初期化を行う。 * * @return void */ public function before() { parent::before(); if(is_null($this->user)) { \Response::redirect('/auth/login'); } self::$client = new \Nextengine\Api\Client_Router(); self::$client->setUser($this->user); } } ``` --- ## Controller_Neapiクラスを継承したクラスのデモ `fuel/modules/demo/classes/controller/api.php`に、 Controller_Neapiクラスを継承したクラスのデモとして、`Controller_Api`クラスを定義しています [ネクストエンジンアプリ基盤を動かす](/tutorial/sample-fuelphp/about-sample)ページの[APIを試す](./about-sample#use-api)で使用したクラスです このクラスのコードを説明いたします ``` namespace Demo; class Controller_Api extends \Controller_Neapi { public function action_find() { $data = array( 'products' => self::$client->apiExecute('/api_v1_master_goods/search', array( 'fields' => 'goods_id,goods_name,stock_quantity,supplier_name', 'limit' => 5 )), 'divisions' => array( 'order' => self::$client->apiExecute('/api_v1_system_order/info'), 'credit' => self::$client->apiExecute('/api_v1_system_credittype/info'), ) ); $this->template->title = 'Demo » Api » find'; $this->template->content = \View::forge('api/find', $data); } } ``` Controller_Neapiクラスを継承しているため、親クラスの`before()`でインスタンスが初期化され、 `self::$client`でネクストエンジンAPIクライアントのインスタンスにアクセスできます ネクストエンジンAPIを使用するには、`apiExecute`メソッドを実行します apiExecuteメソッドの説明は、[SDKのドキュメント](/sdk#php_neApiClient)を御覧下さい 使用できるAPI一覧は、[APIのドキュメント](/api)を御覧下さい --- ## Controller_Neapiを継承する際に気をつけること #### ネクストエンジンAPIを使用しないアクションを混在させない Controller_Neapiを継承すると、アクセスのたびにセッションを見に行き、 セッションにユーザ情報が保存されていなければ認証処理へリダイレクトしてしまいます そのため、ネクストエンジンへのログインが不要なアクションを、コントローラ内に混在させないで下さい 設計レベルで、ネクストエンジンAPIを使用する必要が有る・無いを分けてコントローラを実装して下さい --- ##### 更新履歴 - 2015/02/17: コントローラ - Controller_Neapiクラスページ作成 --- # はじめに - ダウンロード URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/download/ ### はじめに - ダウンロード ネクストエンジンアプリ基盤のダウンロードページです 現在、zipとgit形式でダウンロードができます [ダウンロード(.zip)](https://github.com/hamee-dev/app-template-fuel/archive/master.zip) [リポジトリを見る(Github)](https://github.com/hamee-dev/app-template-fuel) ### ダウンロード後の下準備 ダウンロードしたネクストエンジンアプリ基盤を動作させるための準備を行います 1. composerで必要なパッケージを読み込む 2. DBの接続設定の更新 3. ネクストエンジンアプリ基盤の更新を取り込む設定 を行います #### composerで必要なパッケージを読み込む ```bash $ cd /path/to/sample-fuelphp/ $ php composer.phar self-update $ php composer.phar update ``` #### DBの接続設定の更新 composerパッケージの読み込みが完了したら、 次は`fuel/app/config/development/db.php`を編集します ローカルの開発環境に合わせて、DBの接続情報を設定します 設定を更新したら、動作確認を兼ねてマイグレーションを実行します 正しく設定されていれば、マイグレーションが実行できます ```bash $ php oil r migrate --packages=base ``` このとき、 「Error - date_default_timezone_get(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in COREPATH/classes/fuel.php on line 161」 というエラーが出たら、php.iniで`date.timezone`の設定がされているかご確認下さい — [PHP: 実行時設定 - Manual](http://php.net/manual/ja/datetime.configuration.php#ini.date.timezone) #### ネクストエンジンアプリ基盤の更新を取り込む設定 ##### zip版をご利用の場合 変更された箇所を手動でプロジェクトに取り込む必要があります ##### git版をご利用の場合 git版をご利用の方は、gitを用いて更新された箇所を取り込むことができます ```bash $ git remote rm origin # ネクストエンジンアプリ基盤への参照を切る $ git remote add base https://github.com/hamee-dev/app-template-fuel # baseというオリジン名でネクストエンジンアプリ基盤を参照する ``` `base`というオリジン名は特別な意味を持つわけではないため、必要であれば別名をご利用下さい この設定を事前にしておき、ネクストエンジンアプリ基盤の更新を取り込む際には ```bash $ git pull base master # baseオリジンの更新を取得する(baseは設定したオリジン名) ``` と実行することでネクストエンジンアプリ基盤の更新を取り込むことができます コンフリクトした際は解消をお願い致します --- ##### 更新履歴 - 2015/02/17: はじめに - ダウンロードページ作成 --- # はじめに - 動作環境 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/environment/ #### はじめに - 動作環境 ネクストエンジンアプリ基盤は、下記の環境で動作を確認しております また、開発には[Vagrant](https://www.vagrantup.com/)が必要です インストールされていない方は事前にインストールをお願い致します | 名称 | バージョン | | --- | --- | | `nginx` | 1.0.15 | | `MySQL` | 5.6.20 | | PHP | 5.4.31 | | `FuelPHP` | 1.7.2 | --- ##### 更新履歴 - 2015/02/17: はじめに - 動作環境ページ作成 --- # モデル - Model_Baseクラス URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/model-base/ ### モデル - Model_Baseクラス ここでは、モデルの基底クラスについて説明いたします ## なぜフルスクラッチで書いたのか FuelPHPには、`Model_Crud`や`Orm\Model`といったモデルクラスが提供されています しかし、**`Model_Base`は、それらのクラスを継承しておりません** その理由をまず説明いたします `Model_Crud`や`Orm\Model`は、 プロパティの取得や設定など、高頻度でアクセスされるプロパティにマジックメソッド(`__get`, `__set`)を使用しています **マジックメソッドは動作が遅い**1ため、コードではなく「動作速度を」軽量にしたいことと、 後述のいくつかの制約や機能を加えたかったため、Model_CrudもOrmパッケージも継承しない基底クラスModel_Baseを実装しました 完全にゼロベースではなく、FuelのModel_Crudにあるメソッドを一部組み込んでおります --- ## 制約 Model_Baseクラスは、 モデルクラスの名前とテーブル名の関係に命名規約があるなど、**いくつか制約を加えています** #### 1. モデルクラス名とテーブル名の命名規約 **Model_Baseを継承するクラスの名前と、DB上のテーブル名は対応させなければなりません** 代わりに、命名規約に則りさえすれば、楽にモデルのコードを書くことができます テーブル名とモデルクラス名の関係は、 - テーブル名：複数形 - モデルクラス名：単数形 とする必要がありますいくつか具体例を挙げます | テーブル名 | 単数形 | モデルクラス名 | | --- | --- | --- | | `users` | `user` | `Model_User` | | `companies` | `company` | `Model_Company` | | `people` | `person` | `Model_Person` | この対応関係を作るために、内部でFuelPHPの`Inflector::pluralize`メソッド2を使用しています 単数形の単語を与えると、複数形にした単語を返すメソッドです そのため、`oil console`コマンドで手軽に対応関係を確認することができます ```bash $ cd /path/to/sample-fuelphp $ php oil console Fuel 1.7.1 - PHP 5.4.28 (cli) (Jun 19 2014 14:31:57) [Darwin][] >>> Inflector::pluralize('man') men # この場合テーブル名は`Model_Men`とする >>> Inflector::pluralize('monky') monkies # この場合テーブル名は`Model_Monkies`とする >>> Inflector::pluralize('person') people # この場合テーブル名は`Model_People`とする ``` しかし、`oil generate model`コマンドで生成されたマイグレーションが生成するテーブルは、 モデルクラス名の複数形になるため、さほど意識する必要はありません ※ Moel_Baseクラス自身をインスタンス化する必要がないため、abstractにしています #### 2. プロパティ名とカラム名の命名規約 **DBのカラム名と、モデルクラスのプロパティ名にも命名規約があります** ##### カラム名とプロパティ名は一致させる モデルの設定や、Model_Baseの継承クラスの処理を簡潔するための規約です **DBのカラム名と、モデルクラスのプロパティ名は一致させる必要があります** また、モデルで定義されたプロパティは、`public`で、かつDBに存在する必要があります ``` class Model_User extends Model_Base { public $company_id = null; public $uid = null; public $next_engine_id = null; public $email = null; public $access_token = null; public $refresh_token = null; } ``` 例えば、はじめに3で説明した`users`テーブルを使用した`Model_User`の場合ですと、 以下の様な定義になります なお、`id`, `created_at`, `updated_at`はModel_Baseに定義されているため、再定義する必要はありません これら３つのカラムは、全てのテーブルが持っていると制約しています しかし、全てのプロパティが強制的に保存されてしまうと柔軟性に欠けるため、 保存対象から除外するカラムを指定する設定を設けています ##### 保存処理から除外したいプロパティはignoreSaveKeyへ 保存対象から除外するカラムを指定する、`ignoreSaveKey`というプロパティがあります ``` class Model_Hoge extends Model_Base { public $hoge = null; public $foo = null; public $bar = null; protected $ignoreSaveKey = array('hoge', 'foo'); } $model = new Model_Hoge(); $model->bar = 'fizz'; // hogeとfooは除外指定されているため、barのみが保存される $model->save(); // INSERT INTO `hoges` SET `bar`='fizz' ``` 上記のように、プロパティ名の配列を指定します - DBに存在しないカラムをプロパティとして使用したい、 - PHPからDBに保存したくないプロパティ などを保存対象から除外することができます ##### DBに存在するカラムとモデルのみに存在するプロパティを分ける DBに存在しないカラムをプロパティとして定義することができるため、 第三者がコードを見た際に、DBに存在するプロパティなのか見間違うリスクが生まれました そのため、DBに保存するカラム名（プロパティ名）と、 DBに保存しない、モデルクラスにのみ記述されたプロパティ名を分けるための命名規約を設けます | 種類 | 命名規則 | | --- | --- | | DBに保存するプロパティ | スネークケース(hoge, hoge_foo_bar) | | モデルにのみ存在するプロパティ | キャメルケース(hoge, hogeFooBar) | 上記の表のように、命名を分けて下さい Model_Baseで言えば、`id`, `created_at`, `updated_at`がカラム名（スネークケース） `validationErrors`, `primaryKey`, `ignoreSaveKey`がモデルのプロパティ（キャメルケース）です --- ## 主キーの変更 主キーは、`primaryKey`プロパティで指定します デフォルトでは`id`と指定されていますが、任意の値へ変更することができます ``` // 主キーを変更するには$primaryKeyプロパティの値を変更する class Model_Map extends Model_Base { public $foo_id = null; public $hoge_id = null; protected static $primaryKey = 'foo_id'; } // idではなく、カラムfoo_idの値で検索をかけることができる $map = Model_Map::find('hoge-foo-bar'); ``` 現状、主キーは単一の指定のみ対応しております **複合主キーには対応しておりません** --- ## 基本的な機能 次は、Model_Baseで使える基本的な機能について説明いたします ※ **このドキュメントには、細かな仕様を記述しておりません** 細かい挙動や仕様については、`fuel/app/classes/model/base.php`を御覧下さい ### インスタンスの生成 `__construct(array $data = array())` 引数 `array` $data プロパティに与える初期値を連想配列で指定 ``` class Model_Test extends Model_Base { public $hoge = null; } $model = new Model_Test(); $model->hoge; // null $model = new Model_Test(array('hoge' => 1)); $model->hoge; // 1 ``` --- ### 読み取り データの読み取りには、`find`, `findAll`, `findBy`, `findLike`を用意しています #### find($id) findは、主キーを用いて検索を行います 引数 mixed $id 取得したいモデルのIDを指定（文字列か数値を想定） 戻り値 指定されたIDに対応するデータが有れば、自身のインスタンス、なければnull ```bash $model = Model_Test::find(1); // id値で検索 $exist = is_null($model) ? 'ない' : 'ある'; ``` --- #### findAll() 引数 なし 戻り値 モデルクラスと対応するテーブル内の全件のデータ ```bash $models = Model_Test::findAll(); // 全件取得 $found = (count($models) > 0) ? '1件以上ある' : '1件もない' ``` --- #### findBy($column, $value, $operator = '=') 引数 string $column 比較するカラム名 mixed $value 比較する値 string $operator 比較に用いる演算子（デフォルトは`=`） 戻り値 比較条件にマッチしたモデルのインスタンスの配列、１件もマッチしなければ空配列 ```bash $models = Model_Test::findBy('hoge', 'foo'); // カラムhogeの値がfooなモデルを取得 $models = Model_Test::findBy('age' 10, '>='); // 比較に>=を使用 $found = (count($models) > 0) ? '1件以上ある' : '1件もない' ``` --- #### findLike($column, $value) 引数 string $column 検索に使用するカラム mixed $value 検索に使用する値 戻り値 比較条件にマッチしたモデルのインスタンスの配列、１件もマッチしなければ空配列 ```bash $models = Model_Test::findLike('description', 'Geek'); // LIKEを使用して部分一致を検索 $found = (count($models) > 0) ? '1件以上ある' : '1件もない' ``` --- 上記のような、汎用的で簡素な検索・取得メソッドしか用意しておりません 複雑な検索クエリを書かなければならない場合は、検索用のメソッドを実装して下さい また、件数のカウントには`count`を用意しています countについてはModel_Crudのcountメソッドをそのまま移植しています 使い方はそちらを御覧下さい Model_Crud - クラス - FuelPHP ドキュメント [http://fuelphp.jp/docs/1.7/classes/model_crud/methods.html#/method_count](http://fuelphp.jp/docs/1.7/classes/model_crud/methods.html#/method_count) ```bash $row_count = Model_Test::count(); // テーブルの全行数をカウント ``` --- ### 保存処理 保存系の処理には、`insert`, `update`, `save`, `create`を用意しています #### insert($insert_ignore = false) insertメソッドは、第一引数に`INSERT IGNORE...`を使用するか否かのフラグを受け取ります しかし、INSERT IGNOREを使用するとINSERTに使用する処理時間が若干増えます デフォルトの動作はなるべく早く軽くしておきたいため、引数を省略した場合は通常のINSERTを行います 引数 boolean $insert_ignore trueが渡されるとINSERT IGNORE句を使用する（デフォルトは使用しない） 戻り値 挿入に成功すればtrue 挿入に失敗（INSERT IGNOREで挿入が起きなかった場合も）したらfalse また、保存に成功した場合、挿入されたidがidプロパティに反映されます ``` // まだDBに未挿入のデータはinsertを用いる $model = new Model_Test(array('hoge' => 'foo')); $model->insert(); // DBに挿入される $model->id; // 挿入されたIDが格納されている $model->insert(); // そのまま再INSERTしようとするとキー重複で例外発生 $model->insert(true); // trueを渡すとINSERT IGNOREになり、キー重複の例外が発生しない ``` --- #### update() 引数 なし 戻り値 更新に成功したらtrue、更新に失敗したらfalse ``` // DBから取得したデータならupdateを用いる $model = Model_Test::find(1); $model->content = 'rewrite from PHP'; $model->update(); // DBの値が更新される ``` --- #### save() 引数 なし 戻り値 保存に成功すればtrue、失敗すればfalse saveメソッドは`INSERT ... ON DUPLICATE KEY UPDATE ...`を使用します DBにUNIQUE等の制約がかかっているカラムがあるとしたときに、 重複する値がDBに存在している場合は、モデルの値でDBを更新します 重複する値がDBに存在していない場合は、挿入を行います ``` // fuel/packages/nextengine/classes/nextengine/api/client/router.phpの内部 private function _createUser($company_id) { $user_info = parent::apiExecute('/api_v1_login_user/info'); $user_info = $user_info['data'][0]; $user = new \Model_User(); $user->company_id = $company_id; $user->uid = $user_info['uid']; $user->next_engine_id = $user_info['pic_ne_id']; $user->email = $user_info['pic_mail_address']; $user->access_token = $this->_access_token; $user->refresh_token = $this->_refresh_token; $user->created_at = \DB::expr('NOW()'); $user->save(); // INSERT or UPDATE return $user; } ``` --- #### create(array $columns, array $values) { `create`メソッドはstaticメソッドとして提供されており、 引数に特定の形式で配列を与えると、DBに挿入を行い、そのデータをモデルクラスのインスタンスとして返します 引数 string[] $columns 挿入するカラム名の配列 array[] $values 値の配列、指定する順序は$columnsの順序と対応している必要がある 戻り値 挿入されたデータのインスタンスの配列 ``` Model_Test::create( array( 'username', 'password', ), array( array('hogehoge', 'hugahuga', 'foooooooooo'), // usernameに挿入する値の配列 array('foobar', 'hige', 'fizzbuzz'), // passwordに挿入する値の配列 )); ``` --- ### 削除処理 削除処理は、`delete`を用意しています #### delete() deleteメソッドは物理削除を行います 論理削除は今のところ実装していません 引数 なし 戻り値 削除に成功すればtrue、失敗したらfalse ```bash $models = Model_Test::findAll(); foreach($models as $model) { $model->delete(); // DBから物理削除する（findAllと組み合わせて全件削除） } ``` --- ### バルクインサート 大量のデータを外部から取得し、素早く一度にDBへ挿入する際に便利ですが、 現状、実装する予定はありません --- ## モデルを扱う上での注意点 ### created_atとupdated_atについて #### MySQLの仕様 ネクストエンジンアプリ基盤では`created_at`のデフォルト値に`CURRENT_TIMESTAMP`、 `updated_at`のデフォルト値に`CURRENT_TIMESTAMP on UPDATE CURRENT_TIMESTAMP`が指定されています これらの指定が前提となっているため、ネクストエンジンアプリ基盤（PHPコード）からこれらのカラムについて一切操作を行いません ここで気をつけるべき事項は、 **既存のDBの内容と全く同じ内容でupdateを実行した場合、成功はするが`updated_at`は更新されない**ことです 何か値を変更して更新した場合にはupdated_atは更新されます この挙動にご注意下さい #### insert, update, save時のプロパティの更新 挿入や保存をした際に、 DBにはその日時が反映されていますが、 モデルのプロパティの`created_at`と`updated_at`**は更新されません** これらの情報をモデルのプロパティにも反映させたい場合、 挿入や更新後に、一度SELECT文を発行せざるを得ないため、パフォーマンスの観点から実装していません 具体的なコードを上げます ``` hoge = 1; $model->save(); $model->updated_at; // 更新されてない ///////////////////////////////////////// $model = new Model_Hoge(); $model->hoge = 1; $model->save(); $model->created_at; // 更新されてない $model->updated_at; // 更新されてない ``` `created_at`や`updated_at`を処理に使用したい場合には、挿入および保存の挙動にご注意下さい これら日時に関するプロパティを更新したいケースのためにフックを用意しています そちらに日付更新の処理を実装して下さい --- ## フック 各種DBとの通信するメソッドの前後に挟める各種フックを用意しています | フック名 | フックが呼び出されるタイミング | メソッドに渡される引数 | | --- | --- | --- | | `before_save` | save(), insert(), update() | before_save() | | `after_save` | save(), insert(), update() | after_save(boolean $success) | | `before_insert` | insert() | before_insert() | | `after_insert` | insert() | after_insert(boolean $success) | | `before_update` | update() | before_update() | | `after_update` | update() | after_update(boolean $success) | | `before_delete` | delete() | before_delete() | | `after_delete` | delete() | after_delete(boolean $success) | | `before_validate` | validate() | before_validate() | | `after_validate` | validate() | after_validate(boolean $success) | | `after_find` | find(), findAll(), findBy(), findLike() | after_find(array $record) | ほぼすべてのメソッドがインスタンスメソッドです メソッド内部で`$this`を用いればインスタンスにアクセスすることができます ですが、find系のメソッドは全てstaticメソッドです そのため**after_findのみstaticメソッドとなっています**ご注意下さい 具体的なコードを挙げます ``` class Model_Admin extends Model_Base { public $username; public $password; // 挿入前にパスワードをハッシュ化 // @override public function before_insert($query) { $this->password = password_hash($this->password); } // ユーザ名とパスワードを渡し、それにマッチするユーザが居ればtrueを、いなければfalseを返す public static function verify($username, $raw_password) { $admin = self::findBy('username', $username); if(is_null($admin)) return false; $admin = $admin[0]; if(password_verify($raw_password, $admin->password)) { return true; } else { return false; } } } ``` --- ##### 更新履歴 - 2015/02/17: モデル - Model_Baseクラスページ作成 --- 1. [ベンチマーク - マジックメソッドを使用したプロパティアクセス](./benchmarks/magic-method) ↩ 2. Inflector - クラス - FuelPHP ドキュメント [http://fuelphp.jp/docs/1.7/classes/inflector.html#/method_pluralize](http://fuelphp.jp/docs/1.7/classes/inflector.html#/method_pluralize) ↩ 3. [はじめに](./model-beginning) ↩ --- # モデル - はじめに URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/model-beginning/ ### モデル - はじめに ここでは、データベースの構造の説明や意図について説明いたします モデルクラスのドキュメントについては、個別ページを御覧下さい1 --- ## データベースの構造 ネクストエンジンアプリ基盤は、下記のER図ようなDB構造を生成するマイグレーションを提供しています ![ER図](/images/c41a438cc257.png) マイグレーションファイルは、 - `fuel/packages/base/migrations/001_create_companies.php` - `fuel/packages/base/migrations/002_create_users.php` を御覧下さい 次に、各テーブルのカラムについて説明いたします --- ## usersテーブル 対応するモデルは`Model_User`です uid, next_engine_idについてはAPIドキュメントを御覧下さい2 | カラム名 | 説明 | | --- | --- | | `company_id` | companiesテーブルのIDデータの整合性のために外部キー制約をかけていますユーザデータを削除する頻度がほぼないため、実装の手間などのデメリットは少ないと考えています | | uid | アプリ内で一意になるIDこのカラムの値が重複することはないため、UNIQUEにしています | | `next_engine_id` | ネクストエンジンのユーザIDAPIのレスポンス内のpic_ne_idというフィールドと対応します | | `email` | 管理者やユーザに何らかのメールを送るケースがあると判断し、カラムとして追加しました | | `access_token` | ネクストエンジンAPIのアクセストークンこの値を保存しておかないとバッチ処理が行えないためカラムとして追加しました | | `refresh_token` | アクセストークンと同様の理由でカラムとして追加しました | ## companiesテーブル 対応するモデルは`Model_Company`です main_function_id, platform_idについてはAPIドキュメントを御覧下さい3 | カラム名 | 説明 | | --- | --- | | `main_function_id` | APIのレスポンス内のcompany_idというフィールドと対応しますこのカラムの値が重複することはないため、UNIQUEにしています | | `platform_id` | APIのレスポンス内のcompany_ne_idというフィールドと対応します | --- ##### 更新履歴 - 2015/02/17: モデル - はじめに作成 --- 1. 個別ページを御覧下さい [モデル - Model_Base](./model-base) [モデル - Model_User, Model_Company](./model-user-company) ↩ 2. [ログインユーザー - ネクストエンジンAPIドキュメント](/api/fields/login_pic) ↩ 3. [企業 - ネクストエンジンAPIドキュメント](/api/fields/login_company) ↩ --- # モデル - FuelPHPのモデルクラスを利用する URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/model-fuel/ ### モデル - FuelPHPのモデルクラスを利用する FuelPHPのモデル（`Model_Crud`や`Orm\Model`etc）を継承したモデルクラスの作成方法の説明をいたします --- ### FuelPHPのモデルを継承したクラスを新たに作成する 新規クラスであれば問題はありません FuelPHPのドキュメント1を参考に、モデルクラスを生成して下さい --- ### Model_User, Model_CompanyはFuelのモデルクラスを継承させたい デフォルトですと、 Model_UserもModel_Companyも[Model_Base](./model-base)クラスを継承しています しかし、Model_Baseクラスが不要であり、通常のFuelPHPのモデルクラスを継承させたい際には、 `oil`コマンドで再生成すると、ミスなく確実に置き換えができます #### oilコマンドで再生成 マイグレーションファイルは既に作成済みのため、`--no-migration`オプションを指定します また、MySQLのTIMESTAMP型を使用するため、`--mysql-timestamp`オプションも指定します 更に、既にモデルクラスが存在しているため、強制的に上書きする`--force`オプションを指定します Model_UserをFuelPHPのモデルクラスで再生成する際には、 ```bash $ cd /path/to/sample-fuelphp $ php oil g model user company_id:int uid:varchar[128] next_engine_id:varchar[128] email:varchar[255] access_token:varchar[128] refresh_token:varchar[128] --no-migration --mysql-timestamp --force ``` Model_CompanyをFuelPHPのモデルクラスで再生成する際には、 ```bash $ cd /path/to/sample-fuelphp $ php oil g model company main_function_id:varchar[128] platform_id:varchar[128] --no-migration --mysql-timestamp --force ``` とコマンドを入力して下さい --- ##### 更新履歴 - 2015/02/17: モデル - FuelPHPのモデルクラスを利用するページ作成 --- 1. Generate - Oil パッケージ - FuelPHP ドキュメント [http://fuelphp.jp/docs/1.7/packages/oil/generate.html](http://fuelphp.jp/docs/1.7/packages/oil/generate.html) ↩ --- # モデル - モデルクラスを追加する URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/model-rule/ ### モデル - モデルクラスを追加する これまで、Model_Base, Model_User, Model_Companyの使い方を説明致しました 次は、Model_Baseを継承したクラスの具体的な作成方法について記述します --- `Base\Model_Base`を継承したクラスを定義する際にすべきことは 1. `Base\Model_Base`を継承する 2. DBのカラムをプロパティとして定義する の２点です 文字のみの説明では伝わりにくいため、 この先の説明は、具体例とコードを挙げて補足していきます 例として、日記を書き記すために、 - id - slug: (URLになるアルファベット、記号のみの文字列) - tags: (日記につけるタグ、カンマ区切り) - title: (日記タイトル) - content: (日記の内容、Markdownで記述) - created_at - updated_at といったカラムを持つ、`diaries`テーブルをモデルクラス化するとします --- ## 必要なファイルを生成 マイグレーションとモデルを同時に生成できる`oil`コマンドを使用します ```bash $ php oil g model diary slug:string tags:string title:string content:text Creating model: /Users/SYS-INOUE/work/noob/tmp/fuel/app/classes/model/diary.php Creating migration: /Users/SYS-INOUE/work/noob/tmp/fuel/app/migrations/003_create_diaries.php ``` マイグレーションとクラス定義ファイルが生成されました しかし、**Model_Baseを継承する際には、このままでは使用できません** Model_Baseを継承できるように、マイグレーションファイルとクラス定義ファイルを修正していきます --- #### 1. マイグレーションファイルを修正 マイグレーションファイルで修正しなければならない項目は、 - `created_at` - `updated_at` の２点ですこの２点が下記の表のような構造になるように、マイグレーションを修正します | カラム名 | 型 | NULL許可 | デフォルト | 追加情報 | | --- | --- | --- | --- | --- | | `created_at` | `TIMESTAMP` | しない | `CURRENT_TIMESTAMP` | | | `updated_at` | `TIMESTAMP` | しない | `CURRENT_TIMESTAMP` | on update CURRENT_TIMESTAMP | 以下は、修正後のマイグレーションファイルです ``` array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true), 'slug' => array('constraint' => 255, 'type' => 'varchar'), 'tags' => array('constraint' => 255, 'type' => 'varchar'), 'title' => array('constraint' => 255, 'type' => 'varchar'), 'content' => array('type' => 'text'), 'updated_at' => array('type' => 'timestamp', 'default' => \DB::expr('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP')), 'created_at' => array('type' => 'timestamp', 'default' => \DB::expr('CURRENT_TIMESTAMP')), ), array('id'), true, 'InnoDB'); } public function down() { \DBUtil::drop_table('diaries'); } } ``` --- #### 2. クラス定義ファイルを修正 モデルクラスのクラス定義は、以下のようになります ``` class Model_Diary extends \Base\Model_Base { public $slug = null; public $tags = null; public $title = null; public $content = null; } ``` Model_Baseを継承し、 FuelPHPが生成したプロパティを削除し、DBに存在するカラムをプロパティとして追加しました `id`, `created_at`, `updated_at`はModel_Baseで既に定義されているため再定義の必要はありません それら以外の`slug`, `tags`, `title`, `content`をプロパティに追加しました --- ## フックを追加 フックは、Model_Baseの説明1でも１つ具体例を挙げましたが、 Model_Diaryを用いた例を説明いたします 日記につけられたタグを表すtagsプロパティは、カンマで区切られた文字列です これをDB上はカンマ区切りの文字列、PHP上では文字列の配列として扱えるように、フックを実装した例が以下です ``` class Model_Diary extends \Base\Model_Base { public $slug = null; public $tags = null; public $title = null; public $content = null; const DELIMITER = ','; // 保存前：配列をカンマ区切りの文字列へ戻す public function before_save() { $this->tags = implode(self::DELIMITER, $this->tags); } // 保存後：カンマ区切りの文字列を配列へ分割する public function after_save($success) { $this->tags = explode(self::DELIMITER, $this->tags); } // 取得後：after_saveと同様に処理する public static function after_find($records) { foreach($records as &$record) { $record->after_save(true); } return $records; } } ``` まず、区切り文字を表す`DELIMITER`を定義しました `before_save`メソッドで、 DBに保存する前に`tags`プロパティの値を文字列へ戻す処理を記述しました `after_save`, `after_find`メソッドでは、 カンマ区切りの文字列となった`tags`プロパティの値を、配列へ分割しています このように、フックでプロパティを書き換える場合には、 保存時の変換と、保存後（取得後）の復元ができるように記述します --- フックによる変換処理が正しく記述できているか、 `oil console`を用いて動作確認を行います ```bash $ oil console Fuel 1.7.1 - PHP 5.4.28 (cli) (Jun 19 2014 14:31:57) [Darwin] >>> $model = new Model_Diary(); >>> $model->slug = 'this-is-a-first-diary'; >>> $model->title = 'This is a first diary!!'; >>> $model->content = 'Hoge hoge foo bar **buzz**'; >>> $model->tags = ['abc', 'def', 'ghi']; >>> $model->created_at = DB::expr('NOW()'); >>> $model->insert(); true >>> $model = Model_Diary::find(3); >>> $model->tags[] = 'xxxxx'; >>> $model->update(); true ``` DBの中身を確認しても、正しく値の挿入、更新が行われています --- ## メソッドを追加 次に、複雑な検索条件でのSELECTやJOINを利用するクエリなど、 Model_Baseが提供していないメソッドを実装します メソッドを追加する際に重要なのは、`_getTableName()`メソッドです このメソッドは、メソッドを呼んだクラス名を取得し、テーブル名に変換して返します 引数はなく、メソッドを呼ぶだけで自分自身のクラス名と対応するテーブル名を入手できます ※ _getTableName()はstaticメソッドにすると期待通りに動作しないため、インスタンスメソッドにしております ``` class Model_Diary extends \Base\Model_Base { public $slug = null; public $title = null; public $content = null; // カラム名の配列を返す（$ignoreSaveKeyに登録されたプロパティは返却されない） public function columns() { return array_keys($this->toArray()); } // 検索条件を用いず、テーブルに格納されている先頭の１件だけを取得する public static function findFirst($order_by = 'id') { $table_name = static::_getTableName(); $query = DB::select($table_name) ->order_by($order_by) ->limit(1); $result = $query->execute(); if(is_null($result)) { return array(); } else { $models = $result->as_array(); return $models[0]; } } } ``` `static::_getTableName()`でテーブル名を取得することができます Model_Baseのfindなどは実際にこれを使用し、テーブル名を取得しています テーブル名が取得できれば、 あとは任意のクエリをFuelPHPが提供するクエリビルダ2から生成することができます また、columnsメソッドで登場しているtoArray()メソッドは、 自分自身のインスタンスを、プロパティ => 値の連想配列へ変換するメソッドです updateやinsertのクエリビルダに`$query->set($this->toArray())`とすれば、カラムと値を一度にセットすることができます --- ##### 更新履歴 - 2015/02/17: モデル - モデルクラスを追加するページ作成 --- 1. [フック - Model_Base](./model-base#hooks) ↩ 2. [Query Builder - クラス - FuelPHP ドキュメント](http://fuelphp.jp/docs/1.7/classes/database/qb.html) ↩ --- # モデル - Model_Userクラス、Model_Companyクラス URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/model-user-company/ ### モデル - Model_Userクラス、Model_Companyクラス [Model_Base](./model-base)で基本的な使い方は説明したため、 Model_UserとModel_Companyのコードを載せて説明いたします DBの構造とモデルクラスのプロパティが一致させているため、 **明確な理由がない限りプロパティ名を変更しないで下さい** また、DBのカラムを増減、カラム名を変更した際には、必ずDBのカラムとモデルクラスのプロパティを一致させて下さい メソッドの使いなどの具体的な拡張方法については[こちら](./model-rule#hooks)を御覧下さい また、Model_Baseクラスではなく、 FuelPHPが提供する`Model_Crud`などを継承したい場合には、[こちら](./model-fuel)を御覧下さい --- ## Model_User `Base\Model_User`のコードは以下の通りです ``` class Model_User extends Model_Base { public $company_id = null; public $uid = null; public $next_engine_id = null; public $email = null; public $access_token = null; public $refresh_token = null; } ``` --- ## Model_Company `Base\Model_Company`のコードは以下の通りです ``` class Model_Company extends Model_Base { public $main_function_id = null; public $platform_id = null; } ``` これらのクラスを拡張する際には、 `fuel/app/classes/model`の中にこれらを継承したクラスが定義されているため、そちらを拡張して下さい --- ##### 更新履歴 - 2015/02/17: モデル - Model_Userクラス、Model_Companyクラスページ作成 --- # はじめに - クラス構造 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/structure-class/ ### はじめに - クラス構造 ## 名前空間 ネクストエンジンアプリ基盤として提供している`base`パッケージは、`Base`という名前空間を取ります しかし、この名前空間を意識することは特にありません `fuel/app/classes`の中に、`base`パッケージの各クラスを継承した空クラスが定義されており、 ネクストエンジンアプリ基盤の処理はそのクラスを使用しているためです 例えば`fuel/app/classes/model/user.php`はこのような記述になっております ``` > ドキュメントへ） | | Nextengine\Api\Client | SDKの癖や汎用処理を吸収するためのラッパーです（>> ドキュメントへ） | ##### モデル関連 | クラス名 | 概要 | | --- | --- | | Base\Model_Base | ネクストエンジンアプリ基盤が提供する、モデルの基底クラスです（>> ドキュメントへ） | | Base\Model_Company | ネクストエンジンを利用する企業様の情報をモデル化したクラスです（>> ドキュメントへ） | | Base\Model_User | ネクストエンジンを利用するユーザ様の情報をモデル化したクラスです（>> ドキュメントへ） | ##### コントローラ関連 | クラス名 | 概要 | | --- | --- | | Base\Controller_Base | ネクストエンジンアプリ基盤が提供するコントローラの基底クラスです（>> ドキュメントへ） | | Base\Controller_Neapi | ネクストエンジンAPIを使用するコントローラの基底クラスです（>> ドキュメントへ） | | Base\Controller_Auth | ネクストエンジンAPIを利用してログインをするクラスです（>> ドキュメントへ） | | Base\Controller_Error | ネクストエンジンAPIを利用中にエラーが発生した時に使用するクラスです | ##### 更新履歴 - 2015/02/17: はじめに - クラス構造ページ作成 --- # はじめに - ディレクトリ構成 URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/structure-directory/ ### はじめに - ディレクトリ構成 ネクストエンジンアプリ基盤とデフォルトのFuelPHPのプロジェクトとの差異は、以下の通りです ※ 差異が分かりやすいよう、FuelPHPが自動生成した、かつ変更していないファイルは除外しています 完全なディレクトリ構成は実際のネクストエンジンアプリ基盤のファイルを御覧下さい ``` fuel/ ├── app >>> - - - アプリケーションファイル - - - │   ├── classes │   │   ├── controller │   │   │   ├── auth.php >>> 認証処理のコントローラ │   │   │   ├── error.php >>> エラー画面のコントローラ │   │   │   └── neapi.php >>> NE APIを使用するためのコントローラ │   │   └── model │   │      ├── company.php >>> 企業モデル │   │      └── user.php >>> ユーザーモデル │   ├── config │   │   ├── development/ >>> 開発環境用の設定はここに │   │   ├── production/ >>> 本番環境用の設定はここに │   │   ├── staging/ >>> ステージング環境用の設定はここに │   │   ├── test/ >>> テスト環境用の設定はここに │   │   └── nextengine.php >>> ネクストエンジンAPIの設定 │   ├── lang │   │   ├── en │   │   └── ja │   │      ├── common.yml >>> アプリ内で共通の文言 │   │      ├── message.yml >>> エラーメッセージや通知メッセージの文言 │   │      ├── model.yml >>> モデルに関する文言 │   │      └── page.yml >>> ビューでのみ使用する文言 │   ├── modules │   │   └── demo │   │   └── classes │   │      └── controller │   │         └── api.php >>> NE APIのデモ用コントローラ │   ├── tasks │   │   └── user.php >>> アクセストークンのリフレッシュバッチ │   └── views │      ├── template-error.php >>> エラー画面のテンプレート │      └── template.php >>> 汎用的なテンプレート └── packages    ├── base >>> - - - ネクストエンジンアプリ基盤が提供するパッケージ - - -    │   ├── classes    │   │   ├── controller    │   │   │   ├── base.php >>> コントローラの基底クラス    │   │   │   ├── auth.php >>> 認証処理のコントローラ    │   │   │   ├── error.php >>> エラー画面のコントローラ    │   │   │   └── neapi.php >>> NE APIを使用するためのコントローラ    │   │   ├── model    │   │   │   ├── base.php >>> モデルの基底クラス    │   │   │   ├── company.php >>> 企業モデル    │   │   │   └── user.php >>> ユーザモデル    │   │   └── logger.php >>> 企業ID別にログを吐くためのユーティリティ    │   ├── config    │   │   └── base.php >>> baseパッケージの設定    │   └── migrations >>> ネクストエンジンアプリ基盤が提供するマイグレーション    └── nextengine >>> - - - ネクストエンジンAPIクライアント - - -       ├── classes       │   ├── nextengine       │   │   └── api       │   │   ├── client       │   │   │   └── router.php       │   │   ├── client.php       │   │   └── nextengineapiexception.php       │   └── neApiClient.php       ├── config       │   └── nextengine.php       ├── tests       └── bootstrap.php ``` ##### 更新履歴 - 2015/02/17: はじめに - ディレクトリ構成ページ作成 --- # サンプル（FuelPHP） URL: https://developer.next-engine.com/guides/tutorial/sample-fuelphp/ ## はじめに NEがネクストエンジンAPIを使用したFuelPHP製のアプリを作成する際に使用している基盤のドキュメントです。 一般のアプリを制作する方へ向けてこの基盤を「ネクストエンジンアプリ基盤」として公開致しました。 ## 概要 ネクストエンジンアプリ基盤は、ネクストエンジンAPIを用いたアプリを作成するための基盤です ### ネクストエンジンアプリ基盤が主に提供すること - アプリに最低限必要なDBの構造（企業、ユーザ）を作成するマイグレーション - そのデータ扱うためのモデルクラス - ネクストエンジンAPIの認証処理 - ネクストエンジンAPIのリフレッシュトークン更新バッチ - ネクストエンジンAPIの癖を吸収するAPIクライアント ### 主な更新履歴 - 2015/02/17: サンプル（FuelPHP）ページ作成 --- # 単独機能のサブメニューについて URL: https://developer.next-engine.com/guides/tutorial/single-function-sample/app_sub_menus/ ## 単独機能のサブメニューについて ![拡張機能とは](/images/f1774a28ca10.png) サブメニューを追加すると下の画像のようにメイン機能や、ネクストエンジンのランチャーから選択して起動することができるようになります。その際の起動パスは 「Redirect URI」 + 「サブメニューの起動パス」のようになります。例えばRedirect URIが"[https://example.com/](https://example.com/)"で起動パスが"init"のときは"[https://example.com/init](https://example.com/init)"がアクセスされるパスになります。 ![サブメニュー表示](/images/60601db6d32e.png) ![ランチャー起動モーダル](/images/76489ac443c5.png) --- # 単独機能の機能分類について URL: https://developer.next-engine.com/guides/tutorial/single-function-sample/function_types/ 特定企業のみアプリの場合にかぎり機能分類を変更することができます。 ![機能分類の設定](/images/abcc81f7eaea.png) こちらが「分類無し」以外に選択されていると、下の画像のようにメイン機能のメニューに表示されそこから起動することが可能になります。 ※ 「分類なし」の場合でもアプリメニューには表示されます。 ![機能分類メニュー差し込み](/images/ee7c1e688b84.png) --- # 単独機能の作り方 URL: https://developer.next-engine.com/guides/tutorial/single-function-sample/how_to_make/ アプリを作るのAPIタブを開きます。 ![アプリを作るAPIタブ](/images/1494ad3c5e4e.png) 「実行方法」を「単独機能として実行」にチェックを入れると単独機能関連の設定項目が表示されます。 ![単独機能の作り方](/images/acc22b6dc78b.png) --- # 注意事項 URL: https://developer.next-engine.com/guides/tutorial/single-function-sample/warning/ - レスポンスヘッダーでiframeの読み込みを禁止している場合「起動した画面で開く」は使用できません - X-Frame-Options HTTPの設定をヘッダーにしているとiframeの読み込みができません - 詳しくは[こちらのドキュメント](https://developer.mozilla.org/ja/docs/Web/HTTP/X-Frame-Options)をご参照ください --- # 単独機能とは URL: https://developer.next-engine.com/guides/tutorial/single-function-sample/ 下の画像のようにネクストエンジンの下部アプリランチャーや、ヘッダーメニューのアプリ一覧に表示され、利用ユーザはクリックすることでアプリを起動できます。 弊社アプリ「カスタムデータ作成」などがこれにあたります。 ![ランチャー起動](/images/43565347166b.png) ![ヘッダーメニュー起動](/images/c532c87f895b.png) メイン機能のアプリメニューに表示され、そちらからも起動することが可能です。 ![メニュー差し込み](/images/a813611c098e.png) --- # 【アプリ開発】楽天スーパーロジ出荷実績反映の自動化について URL: https://developer.next-engine.com/questions/1000/ **投稿者:** 江川 賢　**日時:** 2018/11/08 **カテゴリ:** その他 アプリ開発について、どうするのが良いかお伺いしたく質問です。 楽天スーパーロジ（以下RSL）を配送に利用しているのですが 出荷反映（②③）を自動化したく考えております。 ----- フロー ①RSLへ出荷依頼 ②メールにて出荷完了通知 ③NE上で出荷反映 補足 ② メールは件名でフィルタが掛けられる状態です。 そのメール受信が③のトリガーとなればOKです。 ③ ページ：NEメイン機能＞出荷＞倉庫連携＞楽天スーパーロジ 出荷処理 「出荷実績を反映」ボタンを押し、RSL→NEにデータを取得後、 「結果をダウンロード」ボタンを押し、NE内各伝票に発送伝票番号を反映 ----- 私自身は言語に疎いため、コーディングする際は社内SEに依頼したく考えているのですが どうやって実現するのが良いかテクニックをご教示頂けますと幸甚です。 どうぞよろしくお願い致します。 --- ## 回答 (6件) ### hamee_sys — 2018/11/09 具体的な実装方法に関しては、要件によって解決方法が異なるかと存じますので、回答は控えさせていただきますが、アプリで利用する主なAPIは以下になるかと思われます。 出荷実績を反映:受注伝票出荷確定処理API [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) NE内各伝票に発送伝票番号を反映:受注伝票更新API(または受注伝票一括更新API) [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) ### 江川 賢（質問者） — 2018/11/09 ご確認頂きありがとうございます！ ご案内頂いたリファレンスは、NEへの反映をする際のものであり 【※楽天ロジから配送番号を取得する方法】では無い、という認識で良かったでしょうか。 ※の手法について、どのように取得すれば良いか ご教示頂けますと幸いです。 どうぞよろしくお願い致します。 ### hamee_sys — 2018/11/14 はい、さようでございます。 【※楽天ロジから配送番号を取得する方法】につきましては、こちらではわかりかねます。 お手数をおかけしますが、楽天スーパーロジ様にご確認いただけますでしょうか。 ### 江川 賢（質問者） — 2018/11/14 ページ：NEメイン機能＞出荷＞倉庫連携＞楽天スーパーロジ 出荷処理の「出荷実績を反映」ボタン、および「結果をダウンロード」ボタンは 【※楽天ロジから配送番号を取得する方法】ではないのでしょうか。 つまり、取得する方法は既にご存知ではないでしょうか。 これを自動で実行する処理をコールセンターに訪ねた所、アプリ化をすれば可能性はある。 また、手法についてはデベロッパーコミュニティに相談してほしい。とのことでしたので投稿させて頂いた次第です。 ご確認のほど、よろしくお願い致します。 ### hamee_sys — 2018/11/14 おっしゃる通りでございます。 しかし私どもはあくまでネクストエンジンが提供しているAPIや仕様の回答しか公式には差し上げられません。 ネクストエンジンのAPIでは楽天スーパーロジから直接取得することが出来ません。 また、ネクストエンジンメインからスーパーロジのデータを取得するための仕様については回答いたしかねますので 、 恐れいりますが、取得の方法については楽天スーパーロジにお問い合わせください。 よろしくお願い申し上げます。 ### 江川 賢（質問者） — 2018/11/14 ご確認および詳細ご説明頂きありがとうございます。 よく理解できました。 御社の機能を利用できれば簡易的なもので済むのではと甘く考えておりました。 回答頂きありがとうございました。 --- # sdk.java.jar の入手方法 URL: https://developer.next-engine.com/questions/1001/ **投稿者:** cam　**日時:** 2018/11/12 **カテゴリ:** 開発環境・SDKについて [https://developer.next-engine.com/sdk](https://developer.next-engine.com/sdk)　の　jar(SDK)の入手につきまして Java SDKマニュアル　に書いてある sdk.java.jar は [https://github.com/hamee-dev/sdk-java](https://github.com/hamee-dev/sdk-java) を gitcloneし ./gradlew build で生成される " build/libs/ne-java-sdk-1.1.jar " でしょうか --- ## 回答 (1件) ### hamee_sys — 2018/11/13 ご質問ありがとうございます。 本件、ご認識の通りです。 --- # アプリの開発言語に制限はありますか URL: https://developer.next-engine.com/questions/1007/ **投稿者:** ゆう　**日時:** 2018/11/24 **カテゴリ:** その他 ※サポートへ問合せを行った所、こちらを案内されましたので記載致します。 アプリの開発をしようと思っておりますが、審査基準について質問をさせて頂けないでしょうか。 マニュアルを確認しておりました所、アプリは開発後公開・非公開設定は出来るものの、 セキュリティや内容について審査がされると記載がありました。 Google Apps Scriptを活用して、GoogleスプレッドシートからAPIを利用することは、 審査基準上、問題はありませんでしょうか。 認証はGoogleの認証を利用し、あくまでも非公開とする予定です。 どうぞ宜しくお願い致します。 ※基本的にはJAVA,PHP,Rubyのみでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2018/11/28 ご投稿ありがとうございます。 審査は開発環境ではなく、アプリの内容にて判断させていただいております。 従ってGoogle App Scriptのご利用は問題ございません。 --- # 受注キャンセル区分にあるid11、"保留期間満了の為キャンセル"の保留期間とは？ URL: https://developer.next-engine.com/questions/1009/ **投稿者:** inouema　**日時:** 2018/11/27 **カテゴリ:** ネクストエンジンAPIについて 受注キャンセル区分 [https://developer.next-engine.com/api/sample_api_v1_system_canceltype_in...](https://developer.next-engine.com/api/sample_api_v1_system_canceltype_info/sample) に以下の値があります。 "cancel_type_id":"11", "cancel_type_name":"保留期間満了の為キャンセル" ”保留期間”をキーワードに検索しても、2件しかヒットせず。 ・何を保留している期間なのかの情報 ・保留期間の意味 ・その設定方法について APIリファレンスには情報がありません。 ”出荷を保留している”状態の管理について、ネクストエンジン上でどう扱えるかについて疑問をもっています。 上記の情報が疑問解決の糸口になる可能性があるため質問をしました。 --- ## 回答 (2件) ### hamee_sys — 2018/11/29 ご投稿ありがとうございます。 こちらの値は、メイン機能にて受注キャンセル時、”保留期間満了の為キャンセル”を選んだ際に保持される値でございます。 またAPIにて保留期間を設定する機能は提供しておりません。 保留期間の詳細な説明と設定方法等につきましては、 大変お手数ではございますが、下記よりネクストエンジンのサポートセンターへお問い合わせくださいませ。 [https://base.next-engine.org/inquiries/](https://base.next-engine.org/inquiries/) ### inouema（質問者） — 2018/12/07 保留期間 は 受注のキャンセルを行うかどうかの判定のために、運営上決めておく必要があるものと理解しました。 ネクストエンジンには ”保留期間満了しているかどうか”をチェックする様な機能を持っているわけでは無い。 その機能の為の設定値を設定として、保留期間を設定するAPIも用意されていない。 という事ですね。 --- # ネクストエンジン提供の商品マスタアップロードAPIで商品が登録できない。商品画像がアップロードできない。 URL: https://developer.next-engine.com/questions/1011/ **投稿者:** 富士ソフト株式会社　**日時:** 2018/12/03 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンご担当者様 いつもお世話になっております。 別のネクストエンジンサイトからお問い合わせを実施しておりましたが、 『誠に恐れ入りますが、担当者へ確認をいたしましたところ、 　こちらの部門では調査出来かねる内容でございました。 　お手数ではございますが、 　内容よりネクストエンジンAPIの専用窓口での調査が必要でございますため、 　貴社環境より、以下にお問合せをいただきたく存じます。』 とのことですので、こちらから質問させていただきます。 商品アップロードAPIを使用して950件程度のデータをアップロードしてみたのですが、 アップロードキューも正常に終了してはいるのですが、ネクストエンジン側に商品が反映されない異常事態が発生しています。 検証環境では問題なく、商品アップロード登録、および画像登録も完了しております。 本番環境では商品登録も画像アップロードもできません。 ◇商品アップロードAPIを利用されているアプリ名称 　商品データ連携バッチ(EC⇒ネクストエンジン) 　リダイレクトURL：[https://210.149.143.106/api/ne_updatetoken.aspx](https://210.149.143.106/api/ne_updatetoken.aspx) ◇反映されていない商品コード 　APIでは、以下の項目をCSV形式でリクエストパラメータとして付与しております。 　全部で965件のデータを連携していますが、連携データの最初の2件のみ反映されております。 　3件目以降のデータが反映されていない状況です。 　 　■反映された商品の商品コード 　　AC000743 　　AC000744 　■反映されていない商品の商品コード 　　件数が多いため、冒頭の5件を以下に記載いたします。 　　　AC000745 　　　AI002239 　　　AI002612 　　　BV000837 　　　BV001268 ◇アップロードを実行された日時 　2018/11/28 17:05頃 ◇リクエストURL 　商品マスタアップロード(/api_v1_master_goods/upload) 　アップロードキュー検索(/api_v1_system_que/search) 　 ◇レスポンス結果 　■キューの登録 　　商品マスタアップロード(/api_v1_master_goods/upload)で 　　以下のレスポンスが返ってきております。 　　　result:success 　　　que_id:51227 　■キューのアップロード確認 　　アップロードキュー検索(/api_v1_system_que/search)で 　　上記のque_id=51227でステータス(que_status_id)が、2(全て処理成功)の場合の検索を実施して、 　　以下のレスポンスが返ってきております。 　　　result:success 　　　count:1 申し訳ありませんが、本番リリースを間近に控えているため、早急なご対応をお願いいたします。 以上、よろしくお願いいたします。 --- ## 回答 (11件) ### hamee_sys — 2018/12/04 こちら調査させていただいております。 恐れ入りますが、調査が完了するまでもう少々お待ちくださいませ。 ### hamee_sys — 2018/12/05 海野様、お世話になっております。 恐れ入りますが、企業IDをお教え願えますでしょうか。 ### 富士ソフト株式会社（質問者） — 2018/12/07 ネクストエンジン　デベロッパーネットワーク様 お世話になっております。 企業ID: 以上、よろしくお願いいたします。 ### hamee_sys — 2018/12/06 お待たせいたしました。調査結果を申し上げます。 メイン機能側では、先頭から「ス,,,,,,,,,,,02,," ... 中略 ... ミッソーニ カシミヤ」ここまでしか登録されておりませんでした。 リクエストデータを見ると「 [#215;シルク_セーター_レディース_マルチカラー」とあり、「 [#215;」が特殊文字(絵文字など)になっていて取り込まれていないと思われます。 文字から察するに「×」を使いたいのではないかと存じます。 「ミッソーニ カシミヤ×シルク セーター」でしたら取り込めていますので「×」を利用いただいて再度試して頂けますでしょうか。 該当のリクエストに、他にも「 [#215;」がついている箇所がありますので、合わせて修正をお願いいたします。 ### 富士ソフト株式会社（質問者） — 2018/12/06 >特殊文字(絵文字など)になっていて取り込まれていないと思われます。 以下、２点につきまして、ご回答をお願い致します。 ①特殊文字による取込エラーが起こっているのであれば、何故アップロードキューのレスポンスが成功で帰ってきているのでしょうか。 ②御社には検証環境と本番環境が存在しますが、検証環境では同じデータが正常にアップロードされてしまっているのですが、その理由をご回答願えますでしょうか。 検証環境でできたことが、本番環境でできない事が問題となっております。 恐れ入りますが、再度、ご回答いただきたくお願い致します。 ### 富士ソフト株式会社（質問者） — 2018/12/06 度々恐れ入ります。 こちらの質問が非公開となり一般の方達から閲覧できないと連絡をいただきました。 ユーザ様もこちらの質問をご注視なさっておりますので、公開状態に戻していただけますようお願い致します。 ### hamee_sys — 2018/12/07 事象については調査中でございます。 今しばらくお待ち下さい。 ### 富士ソフト株式会社（質問者） — 2018/12/07 未ログイン状態では閲覧できません。 他の方の質問と同じ扱いにしていただきたいのですが、 「コミュニティ」や「アクティブ」に表示されるように お願いできますでしょうか。 ### 富士ソフト株式会社（質問者） — 2018/12/10 お世話になっております。 ご指摘いただいた商品名に含まれていた「×」は環境依存文字ではない認識です。 また、特殊文字により取込が行えないとの事ですが、 こちらで対象文字を取り除く必要がございますので、 商品マスタアップロードAPIで使用できない全文字をご提示いただけますでしょうか。 ちなみに以下が利用できない文字というのは認識しております。 「機種（環境）依存文字、半角カタカナ、半角コロン（:）、半角カンマ（,）、半角ハテナ（?）」 参考：[https://developer.next-engine.com/questions/674](https://developer.next-engine.com/questions/674) ### hamee_sys — 2018/12/10 サポートよりメールにて一旦回答させて頂いた内容ですが こちらにも記載させて頂きます。 恐れ入りますが、以下の内容をご確認いただきたく存じます。 【ご質問内容①】 特殊文字による取込エラーが起こっているのであれば、 何故アップロードキューのレスポンスが成功で帰ってきているのでしょうか。 【ご回答①】 ネクストエンジンAPIのレスポンスはメイン機能側にリクエストデータを 渡せた時点で成功を返しております。 今回、特殊文字以降のデータが欠落したのは、 メイン機能側でリクエストデータを受けとった後でございます。 レスポンスはメイン機能側にリクエストデータを渡した時点で 成功・失敗の判断を行うため、 特殊文字を含んだデータ自体は渡せたことで、 成功と判断しています。 【ご質問内容②】 御社には検証環境と本番環境が存在しますが、 検証環境では同じデータが正常にアップロードされてしまっているのですが、 その理由をご回答願えますでしょうか。 【ご回答②】 検証環境にアップロードした時間と、 その際にアップロードしたCSVファイルがあれば頂戴したく存じます。 何卒、よろしくお願い申し上げます。 ### 富士ソフト株式会社（質問者） — 2018/12/12 >【ご回答①】 こちらから説明するまでもないとは思いますが、商品を登録するためには以下の２つのAPIを発行する必要があります。 A．商品マスタアップロードAPI（レスポンスにキューIDが返る） B．アップロードキュー件数取得API（A．のキューIDのアップロード結果の件数を検索する） 【ご回答①】によりますと、「リクエストデータを渡せた時点で成功」とされておりますので、 A．のお話をされていると想定します。 私共は当初からB．のレスポンスで正常件数：1（＝正常にアップロードされた件数は1件）を確認しており、 A．のアップロードキューへの登録の成否ではなく、商品マスタに登録できた件数に1とある個所でお話ししております。 【ご回答①】のご回答はやはりB．のお話ではなく、A．のお話だと判断せざるを得ません。 B.が成功(2)件数＝1と帰ってきているのはなぜですかと再質問させていただきます。 ＞【ご回答②】 検証環境にアップロードした時間：2018-12-01 13:53:44 その際にアップロードしたCSVファイル：test.csv ファイルはメールベースでお渡ししました。 --- # 伝票検索でのAND条件検索の方法について URL: https://developer.next-engine.com/questions/1013/ **投稿者:** inouema　**日時:** 2018/12/04 **カテゴリ:** ネクストエンジンAPIについて 受注状態区分が "出荷確定済"(50) の伝票について最新の伝票情報を取得するために、 出荷確定日（receive_order_send_date）に対しても条件指定を行って検索する事は可能でしょうか？ フィールド名-比較演算子　を2つ、リクエストパラメータに指定 すると AND として扱われるでしょうか？ 回答＞　　検索条件を複数指定した場合、全ての条件がかつ(AND)となります --- ## 回答 (1件) ### inouema（質問者） — 2018/12/07 APIリファレンスにしっかり書いていたのを見つけて、回答＞　を書き込んだ後 誤って公開で投稿してしまっておりました。 --- # Steteの更新方法について URL: https://developer.next-engine.com/questions/1023/ **投稿者:** ゆう　**日時:** 2018/12/10 **カテゴリ:** ネクストエンジンAPIについて Steteの更新方法について教えて頂けますでしょうか。 【開発環境】 言語：Google Apps Script 実行環境：上記Google apps script内 上記環境ではuid/stete取得の為のAPIを叩いた際のRedirect uriを受けられない為、 ローカルの環境でphpを立て、uid/stateを取得し、その値をコピーしてGoogle apps script側でAPI呼び出しを試みました。 上記環境の場合、常にアクセストークンを更新し続けなければならないと理解しております。 しかし、以下APIでアクセストークンを呼ぶ為にはuid/Stateが必須パラメーターになっており、 かつ、stateは一度APIを呼ぶ度に失効してしまっているようでした。 [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) uid/stateのAPIを呼ばないような構成にしたいのですが、 そういった仕組みはできないでしょうか。 お手数ですがどうぞ宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2018/12/11 任意のAPIのパラメータにリフレッシュトークンを渡しますと、 アクセストークンの有効機嫌が切れた場合に、新しいアクセストークン、リフレッシュトークンがレスポンスされます。 その新しいトークンを使う事によりuid/stateのAPIを呼ぶ事なくAPIを利用することができます。 下記のサイトをご参考にしていただければ幸いです。 [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) --- # 受注明細追加について URL: https://developer.next-engine.com/questions/1024/ **投稿者:** JAMSHOP WEBコンテンツ・チーム　**日時:** 2018/12/10 **カテゴリ:** ネクストエンジンAPIについて 下記のxml情報と伝票ID、更新日時を/api_v1_receiveorder_base/update に渡しているのですが、「更新フィールドが1つも設定されておりません」というエラーになってしまいます。 xmlの内容に問題があるということだと思うのですが、どこに問題がありますでしょうか？ 1811303856008 【予約プレゼント】OZZY OSBOURNE - BLIZZARD OF OZZ (LOOSE) 2 0 0 1811303857005 【予約プレゼント】FENDER - STRATOCASTER PLAYING CARDS 1 0 0 --- ## 回答 (1件) ### hamee_sys — 2018/12/11 調査させていただきますので、 こちらタグも含めて、全てのデータをお送りいただけませんでしょうか。 --- # 商品マスタアップロードAPI 006005：”内部エラー（原因不明）が発生しました。お手数ですがサポートまでご連絡下さい。”について URL: https://developer.next-engine.com/questions/1025/ **投稿者:** 富士ソフト株式会社　**日時:** 2018/12/12 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 商品マスタアップロードAPIにて3330件の商品をアップロードしようとしましたが、 キューに取り込まれず、レスポンスに以下の情報が返ってきました。 result:error code:006005 message:内部エラー（原因不明）が発生しました。お手数ですがサポートまでご連絡下さい。 サポート連絡はこちらでよろしいでしょうか。 リクエスト中に"&#xx;”等の特殊文字列が混入していないことは確認しております。 実行日：2018/12/12 09:53:40.955 ~ 10:22:45.622 以上、よろしくお願いいたします。 --- ## 回答 (5件) ### hamee_sys — 2018/12/12 調査させていただきます。 調査のため、企業IDをお教え願えますでしょうか。 ### 富士ソフト株式会社（質問者） — 2018/12/12 お世話になっております。 企業ID:XXXXXXX 公開状態のままでお願いします。 以上、よろしくお願いいたします。 ### 富士ソフト株式会社（質問者） — 2018/12/12 3330件を500件ずつ小出しで連携してみましたところ、何の異常もなく取り込めました。 どうやらデータに問題があるわけではないようです。 以下のQAで件数制限はないと回答されていますが、制限があるのではないでしょうか。 [https://developer.next-engine.com/questions/857](https://developer.next-engine.com/questions/857) また、006005のコード値で異なるエラー内容が多すぎると思います。 ひとつの事象はひとつのコード値をとるような仕組みにしていただきたいと思います。 ### hamee_sys — 2018/12/14 公開の件、承知いたしました。 企業IDは非表示とさせていただきます。 ### hamee_sys — 2018/12/17 お世話になっております。 >以下のQAで件数制限はないと回答されていますが、制限があるのではないでしょうか。 件数に関しての制限はございません。しかしデータサイズが大きい場合はエラーとなる可能性がございますので、データを圧縮してのリクエストを推奨しております。 >また、006005のコード値で異なるエラー内容が多すぎると思います。 ご指摘ありがとうございます。この度のご意見につきましては、大変貴重なご意見として、今後の検討課題とさせていただきます。 何卒よろしくお願いいたします。 --- # 受注伝票更新時のエラーメッセージについて URL: https://developer.next-engine.com/questions/1026/ **投稿者:** jac_matsuoka　**日時:** 2018/12/13 **カテゴリ:** ネクストエンジンAPIについて 受注伝票更新（/api_v1_receiveorder_base/update）にて、 下記エラーメッセージが出るのはどういう時でしょうか？ エラーコード：011007 エラーメッセージ：受注取込中のため、更新出来ません。 以下の処理を行っていますが、３にて上記のエラーが発生します。 受注伝票の検索条件は更新日が本日、オプション１０がブランク、受注状態区分が50のデータを取得しています。 この条件のデータが受注取込された後のデータになると思うのですが、原因を教えてください。 １．受注伝票検索する。 ２．取得した受注伝票を他システムに連携する。 ３．受注伝票のオプション１０を更新 --- ## 回答 (1件) ### hamee_sys — 2018/12/17 ご投稿ありがとうございます。 恐れ入りますが、こちらをページをご参照くださいませ。 [https://developer.next-engine.com/questions/471](https://developer.next-engine.com/questions/471) --- # 購入回数 URL: https://developer.next-engine.com/questions/1027/ **投稿者:** yuki naito　**日時:** 2018/12/13 **カテゴリ:** ネクストエンジンAPIについて 受注伝票管理の伝票番号を押した時の別ウィンドウに、 購入者情報のエリアがありますが、　購入者情報　購入回数：3と表示されています。 この「購入回数：3」の3をapiで取得したいのですが、可能でしょうか？ カスタマイズして、表示するという事が可能であれば、 どの項目なのかを、どうやって調べたらよいのか困っています。 受注明細検索のapiで取得したいです。 ご回答よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/12/17 ご投稿ありがとうございます。 大変恐縮ですが、購入回数はAPIにて取得することができません。 よろしくお願いいたします。 --- # ゲストアプリの開発について URL: https://developer.next-engine.com/questions/1028/ **投稿者:** ゆう　**日時:** 2018/12/16 **カテゴリ:** ネクストエンジンAPIについて アプリを開発を依頼頂き、構築を進めております。 以下について教えて頂けないでしょうか。 アプリの開発環境として、私のアカウントに対してゲストアプリにてアプリを共有頂きました。 現在以下の通り設定を行っております。 【ゲストアプリ内の現在の設定】 アプリの種類選択：機能と連携するアプリ 販売形態選択：特定の企業に公開 接続先メイン機能：「選択してください」のまま（何も表示がされない為。） Redirect uri：[https://Localhost](https://Localhost)を指定。 ※バッチファイルとして動かしたい為、一旦ローカル環境でSDKを起動し、取得したアクセストークンでバッチファイルを動かしたい為。 アクセス情報：全て許可 この状態にてSDK（PHP）を手元のPCに入れ、 サンプルとして提供されている「api_find.php」を実行致しましたが、 ログインした後に「アプリの連携に失敗しました。指定したアプリが見つかりませんでした」と表示がされます。 現在は上記の状況なのですが以下教えて頂けないでしょうか。 ①　ゲストアプリに対して開発を行う事は可能でしょうか。 ②　接続先メイン機能は未選択なのですが、ここは開発時も必須でしょうか。 ③　②が必須の場合、この接続先メイン機能を表示させる為には、依頼元の管理画面で何をしてもらうべきでしょうか。 上記教えて頂きたい次第です。 どうぞ宜しくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2018/12/19 お問い合わせありがとうございます。 以下回答させて頂きます。 ①　ゲストアプリに対して開発を行う事は可能でしょうか。 ー＞はい可能です。 ②　接続先メイン機能は未選択なのですが、ここは開発時も必須でしょうか。 ー＞必要ございません。 依頼先にアプリとメイン機能の利用権限の正しく設定がされているかご確認お願いします。 ### ゆう（質問者） — 2018/12/23 承知しました。 利用権限の設定は管理画面のなんという項目か、等教えて頂く事は可能でしょうか。 依頼先にどこの設定値を確認すればよいか伝えたく。 もしくはわからない場合はサポートに聞くよう伝えた方が良いでしょうか。 どうぞ宜しくお願い致します ### hamee_sys — 2018/12/27 管理画面より「設定」->「アプリ」->対象のアプリの「利用者設定」にて利用権限を許可していただくよう、 まずはお伝えいただければと存じます。 それでもわからないようでしたら、サポートまでお問い合わせいただけますと幸いです。 --- # 受注伝票件数取得API　フィールド一覧について URL: https://developer.next-engine.com/questions/1029/ **投稿者:** ゆう　**日時:** 2018/12/16 **カテゴリ:** ネクストエンジンAPIについて APIの利用方法について教えて下さい。 現在、以下の形式でリクエストが成功することは確認しました。 【以下のパラメーターでリクエスト】 API：＊＊＊/api_v1_receiveorder_base/count method：POST { 'access_token':（アクセストークン） 'refresh_token':（リフレッシュトークン） } リクエストは成功した為、実際にデータを取得していきたいのですが、 以下のフィールドを例に使い方を確認させて頂けないでしょうか。 receive_order_confirm_check_id 使い方は以下の通り記述されておりますが、 「フィールド名-比較演算子」 上記のフィールドは特に当日の確認チェック区分があるかないかだけにつき、 特にパラメーターとして指定するものがないと思っている為、 以下で相違ないかと思っているのですが、使い方としてあっておりますでしょうか。 API：＊＊＊/api_v1_receiveorder_base/count method：POST { 'access_token':'（アクセストークン）', 'refresh_token':'（リフレッシュトークン）', 'receive_order_confirm_check_id-eq':''　※パラメーターとして何も入れていない } 上記でリクエストすることで、 以下パラメーターの何れかが返ってくると思っております。 0:確認不要 1:確認必要 2:確認済み 上記で認識としてあっておりますでしょうか。 教えて頂きたく、どうぞ宜しくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2018/12/19 お問い合わせありがとうございます。 receiveorder_base/count こちらのAPIは件数を取得するだけのAPIになります。 データを取得するには/api_v1_receiveorder_base/search（受注検索API）をご利用くださいませ。 fieldsに取得したいフィールド名を設定していただけますでしょうか。 詳しいご利用方法は以下をご参照ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) ### ゆう（質問者） — 2018/12/23 ご回答ありがとうございます。 APIを変更します。 なお、現在テスト環境に接続し開発を行っているのですが、 接続先メイン機能を選択していなくとも、Fieldsの値は何か疑似的に返してくれる仕様でしょうか。 理由としては以下の通りパラメーターをセットし、APIをCallしてみたのですが、空の配列が返ってきた為です。 【呼んだ内容】 エンドポイント：/api_v1_receiveorder_base/search payload = { 'method' : 'post', 'payload' : { 'access_token':XXXXXXXXXXXXXXXXXX, 'refresh_token':XXXXXXXXXXXXXXXXXX, 'wait_flag':'1', 'fields':'receive_order_confirm_check_id' } } 【結果】 { 　"result":"success", 　"count":"0", 　"data：[], 　"access_token":"XX", 　"access_token_end_date":”", 　"refresh_token":"XX", 　"refresh_token_end_date":"" } ### hamee_sys — 2018/12/27 擬似的にということではなく、 対象となるデータがない場合に空で返ってまいります。 --- # ステータスによる検索条件の指定 URL: https://developer.next-engine.com/questions/1035/ **投稿者:** ryo　**日時:** 2018/12/20 **カテゴリ:** ネクストエンジンAPIについて 急ぎで確認です。 /api_v1_receiveorder_row/search を実行した際、上限（limit）が1000件までと表示されました。 リファレンス（[https://developer.next-engine.com/api/api_v1_receiveorder_row/search](https://developer.next-engine.com/api/api_v1_receiveorder_row/search)）には10000件とありますが、1000件なのでしょうか？ /api_v1_receiveorder_base/searchを用いてAPIで伝票を取得する際、伝票番号1番から取得されます。ステータスが印刷待ち、印刷済みの状態のもののみを抜き出す方法は、受注状態区分 receive_order_order_status_idを確認して抜き出すしかないのでしょうか。 ステータスを指定してAPIで取得する方法はございませんでしょうか？ よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/12/21 ＞リファレンス（[https://developer.next-engine.com/api/api_v1_receiveorder_row/search](https://developer.next-engine.com/api/api_v1_receiveorder_row/search)）には10000件とありますが、1000件なのでしょうか？ 10000件で間違いございません。恐れ入りますが、1000件はどのような状況で表示されましたか。 ＞ステータスを指定してAPIで取得する方法はございませんでしょうか？ 印刷待ち、印刷済みを取得していただく場合は 受注伝票検索APIにて、リクエストパラメーターに receive_order_order_status_id-eq=20 receive_order_order_status_id-eq=40 のように条件を追加していただければ、取得可能でございます。 受注状態区分の詳細に関しましては、こちらのページのサンプルをご参照くださいませ。 [https://developer.next-engine.com/api/api_v1_system_orderstatus/info](https://developer.next-engine.com/api/api_v1_system_orderstatus/info) --- # 発注伝票につきまして URL: https://developer.next-engine.com/questions/1039/ **投稿者:** ysk　**日時:** 2018/12/25 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 ネクストエンジンAPIにて、発注伝票管理の情報はAPIから取得することは可能でしょうか。 仕入伝票検索APIから取得ができる認識でおりましたが、ネクストエンジン上の発注伝票管理の内容と仕入伝票検索APIの内容と同様ではないように感じました。 お忙しいところ恐縮ですが、ご教示の程よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/12/27 大変恐縮ですが、発注伝票のAPIは提供しておりません。 そのため発注伝票管理の情報をAPIより取得できない仕様となっております。 ### ysk（質問者） — 2018/12/28 発注伝票のAPIは提供されていない旨、承知いたしました。 ご回答ありがとうございました。 --- # 発注伝票の登録について URL: https://developer.next-engine.com/questions/1042/ **投稿者:** ハイジ　**日時:** 2018/12/26 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 発注伝票の登録が非常に手間がかかり、CSVでの登録等の方法が ないとの事ですので、可能なら API で登録したいと思いますが、 発注伝票登録を行うことが可能な API はありますでしょうか？ 以上、よろしくお願い申し上げます。 --- ## 回答 (1件) ### hamee_sys — 2018/12/27 恐れ入りますが、発注伝票登録のAPIは現在提供しておりません。 ご理解のほど、よろしくお願いします。 --- # APIからの情報取得順に関してまして URL: https://developer.next-engine.com/questions/1043/ **投稿者:** ネクストエンジン設定代行　**日時:** 2018/12/26 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 現在下記のAPIエンドポイントよりデータの取得を試みております。 APIから取得できる上限が10,000件と有りましたが、上限範囲内（伝票番号1->9999）の昇順での取得のみになりますでしょうか。 データ取得時に降順で受け取れたらと考えております。 また、比較演算子を使用して絞り込みをかけた場合も、上限範囲内での検索となりますでしょうか。 エンドポイント /api_v1_receiveorder_base/search [ fields ] 伝票番号　: receive_order_id お忙しい中大変恐縮ではございますが、 ご教授いただけましたら幸いでございます。 --- ## 回答 (1件) ### hamee_sys — 2019/01/07 左様でございます。絞り込みの有無に関わらず、receive_order_idの昇順にて自動でソートされます。 またAPIから取得できる上限が10,000件というのは、検索結果の最大１万件となります。 またoffsetをお使いいただければ、10,001件目以降も取得可能でございます。 --- # APIからの情報取得範囲と検索条件に関してまして URL: https://developer.next-engine.com/questions/1045/ **投稿者:** ネクストエンジン設定代行　**日時:** 2019/01/07 **カテゴリ:** ネクストエンジンAPIについて 平素よりお世話になっております。 表題に関しまして質問がございます。 現在受注伝票検索を使用したアプリを作成しております。 フィールドへ検索条件の比較演算子を追加したところ、伝票番号が10,000を超えているものに関して 情報の取得をすることが出来ませんでした。 検索範囲、取得範囲は伝票番号(登録順)1～10,000までのものに限定されるのでしょうか？ 他の方が質問している内容を拝見する限り、取得順は登録順だと把握しておりますが、 伝票番号10000を超えた情報を取得する場合の検索条件などご教授いただけましたら幸いでございます。 --- ## 回答 (1件) ### hamee_sys — 2019/01/08 下記の投稿にて回答させていただきましたので、こちらを参照くださいませ。 [https://developer.next-engine.com/questions/1043](https://developer.next-engine.com/questions/1043) --- # アプリ認証方式変更について URL: https://developer.next-engine.com/questions/1047/ **投稿者:** 磯　孝之　**日時:** 2019/01/08 **カテゴリ:** ネクストエンジンAPIについて アプリ認証方式変更に関しての対応方法についてのご確認となります。 ネクストエンジンAPIの「NEログイン」を用いて、access_tokenを取得し、 SDKを用いず、アプリから直接HTTP(S)通信を用いて認証する形式に 変更しようと考えております。問題はないでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/01/09 はい、NEログインをご利用いただければ、 SDKを使用せずにアプリより認証していただくことが可能でございます。 --- # クレジットカード注文の取込値についてご質問となります。 URL: https://developer.next-engine.com/questions/1048/ **投稿者:** にし　**日時:** 2019/01/08 **カテゴリ:** ネクストエンジンAPIについて サポートに問い合わせたところ、サポートではわかりかねるのでこちらで質問してくださいとのことでしたので、質問させていただきます。 楽天PAYにてクレジットカードで注文された際 ・（与信OK） ・（与信NG） ・（不正検知） というパターンがあるかと思われます。 それぞれのパターンが、ネクストエンジンに取り込みされた場合、 ネクストエンジン側の項目が以下になるかをご確認させていただきたい次第にございます。 （受注検索APIにて以下項目を条件として、与信OKか与信NGを判断して取り込む際に、ステータスを変更したいというも目的があります） ①「与信OK」がネクストエンジンに取り込まれた場合 ネクストエンジンの項目値は以下で登録されますでしょうか ・入金状況区分(receive_order_deposit_type_id)： 　「2:入金済み」 ・クレジット承認区分(receive_order_credit_approval_type_id)： 　「30;承認済み」 ・クレジット承認日(receive_order_credit_approval_date)： 　　入力済み ②「与信NG」がネクストエンジンに取り込まれた場合 ネクストエンジンの項目値は以下で登録されますでしょうか ・入金状況区分　(receive_order_deposit_type_id) 　「0:未入金」 ・クレジット承認区分　(receive_order_credit_approval_type_id) 　「10; 未承認」であるため ・クレジット承認日　(receive_order_credit_approval_date) 　　空欄 ③「不正検知」がネクストエンジンに取り込まれた場合 ネクストエンジンの項目値は以下で登録されますでしょうか ・入金状況区分　(receive_order_deposit_type_id) 　「0:未入金」 ・クレジット承認区分　(receive_order_credit_approval_type_id) 　「10; 未承認」であるため ・クレジット承認日　(receive_order_credit_approval_date) 　　空欄 --- ## 回答 (1件) ### hamee_sys — 2019/01/09 おっしゃるとおり、APIではネクストエンジンメインの各項目が、 入金状況：receive_order_deposit_type_id、 承認状況：receive_order_credit_approval_type_id、 入金日：receive_order_credit_approval_date で取得されます。 楽天PAYによるネクストエンジンの承認状況、入金状況、入金日への更新仕様は下記のURLを参考にしていただければ幸いです。 不正検知では「要注意注文」と「審査NG」で分かれております。 --不正検知-- [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu__rakuten/21453/) --与信OKと与信NG-- [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu__rakuten/20977/) こちらを参考になされた上でご不明な点がありましたら、メイン側の仕様となりますので、 お手数ですが、もう一度サポートまでご連絡いただけますでしょうか。 --- # 開発環境、トークンを取得できませんでした URL: https://developer.next-engine.com/questions/1050/ **投稿者:** 湯　文明　**日時:** 2019/01/08 **カテゴリ:** 開発環境・SDKについて お世話になります。 私はちょうどアプリに申し込みました、それはまだ検討中です、私はテスト環境のclient_id、client_secretを使いました。 POST : [https://api.next-engine.org/api_neauth](https://api.next-engine.org/api_neauth) { "uid":"XXXXXXX", "state":"XXXXXXX", "client_id":"XXXXXXX", "client_secret":"XXXXXXX" } しかし、私はいつも以下のエラーが出ます？ { code: "001001" message: "POSTパラメータにuidが指定されていません。" result: "redirect" } --- ## 回答 (1件) ### hamee_sys — 2019/01/10 CURLコマンドにて、一度試していただいてよろしいでしょうか。 その際、uidはNEログインuid・state取得APIで取得したuidを使用されているか再度ご確認お願いいたします。 --- # 在庫を監視する方法？ URL: https://developer.next-engine.com/questions/1051/ **投稿者:** 湯　文明　**日時:** 2019/01/08 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 Next-Engineのインベントリが変わったとき、私は自分のアプリケーションに通知したいのですが、Next-Engineがそのような機能をサポートしているかどうかわかりませんか？ それとも、私はタイミングの仕事を通して、絶えず在庫を調べて、在庫の監視の目的を実現することしかできませんか？ --- ## 回答 (1件) ### hamee_sys — 2019/01/10 アプリ側にて在庫数の変動を確認する必要がございます。 在庫数の変動は下記のAPIにて確認いただけます。 [https://developer.next-engine.com/api/api_v1_master_stockiohistory/search](https://developer.next-engine.com/api/api_v1_master_stockiohistory/search) --- # APIからの情報取得について URL: https://developer.next-engine.com/questions/1052/ **投稿者:** しんや　**日時:** 2019/01/09 **カテゴリ:** ネクストエンジンAPIについて クレジットカードの名義人と有効期限は取得できるのでしょうか。 また、取得できる場合フィールド名はあるのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/01/10 申し訳ございません。クレジットカードの名義人と有効期限は取得できない仕様となっております。 --- # 納期連携について URL: https://developer.next-engine.com/questions/1054/ **投稿者:** 植野　真之介　**日時:** 2019/01/15 **カテゴリ:** ネクストエンジンAPIについて 現在汎用設定で利用しているショップで、楽天と同様の値を汎用設定しているサイトに飛ばしたいのですが、アプリ開発で納期は連携可能なのでしょうか？ --- # 楽天市場・Amazonとネクストエンジンの連携動作確認を行う方法 URL: https://developer.next-engine.com/questions/1056/ **投稿者:** birdiemobile　**日時:** 2019/01/15 **カテゴリ:** 開発環境・SDKについて ネクストエンジンのAPIを用いてアプリを開発を行います。 楽天市場とAmazonの連携を想定しているのですが、弊社はショップの運営をしていないためアカウントの取得が困難です。 上記2店舗との連携開発を行なっている方に、どのようにデバッグを行なっているか伺いたく存じます。 --- ## 回答 (1件) ### hamee_sys — 2019/01/21 ネクストエンジンのAPIを利用することは可能でございます。 各モールの受注データや商品マスタを手動で作成していただき、 そのデータをネクストエンジンに取り込んだ上で開発をしていただけます。 ネクストエンジンと各モールの連携仕様は、ネクストエンジンのマニュアルを参照くださいませ。 参考例を下記に記載いたします。 各モールの取り込み形式： [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/7625/) 楽天の受注情報のフォーマット： [http://manual.ec-doc.net/operation/jyuchu/jyuchulist/rakuten/ee003/](http://manual.ec-doc.net/operation/jyuchu/jyuchulist/rakuten/ee003/) --- # 無料期間終了に関して URL: https://developer.next-engine.com/questions/1057/ **投稿者:** 新木章一朗　**日時:** 2019/01/19 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンも無料期間が過ぎてメイン機能が利用停止中です。 本契約の手続き中なのですが、契約完了後に無料期間に設定した内容を引継いで再開可能でしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/01/21 こちらでは開発の質問のみ受け付けております。 大変お手数ですが、本質問に関しましては、サポートへご連絡くださいませ。 --- # モール商品一括登録の自動化 URL: https://developer.next-engine.com/questions/1058/ **投稿者:** Maekawa　**日時:** 2019/01/21 **カテゴリ:** ネクストエンジンAPIについて 日常的に各モールからダウンロードした商品情報をネクストエンジンにアップロードしています。 アップロード作業を自動化したいのですが、FTPを使ったアップロードや情報を受け付けるAPIなどあるでしょうか？ よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/01/21 大変恐縮ですが、 モール商品登録用APIおよびFTPの提供はございません。 よろしくお願いいたします。 --- # 出荷確定後の発送伝票番号の更新方法について URL: https://developer.next-engine.com/questions/1062/ **投稿者:** ゴン太　**日時:** 2019/01/28 **カテゴリ:** ネクストエンジンAPIについて 現在、 ・受注伝票出荷確定処理 [https://api.next-engine.org](https://api.next-engine.org) /api_v1_receiveorder_base/shipped にて出荷確定を連携しているのですが 合わせて「発送伝票番号：receive_order_delivery_cut_form_id」も反映したいと考えております。 （ネクストエンジンに出荷確定日は反映されるが、発送伝票番号が反映されておらず、出荷メールや楽天への出荷連携がされていないため） そのために、以下ご質問とさせていただきますため、何卒ご回答の程いただけますでしょうか。 （基本的なことかも知れませんがご回答いただきたくよろしくお願い申し上げます。） ■質問１、 ②の「受注伝票出荷確定」リクエスト時に パラメータとして「&receive_order_delivery_cut_form_id=***」を追記してもネクストエンジンには反映されないのでしょうか（フィールド一覧に記載されている項目） ■質問２ 上記質問１で「発送伝票番号」反映ができないとなると、 ②の「受注伝票出荷確定」が終わった後に、以下③、④のAPIを追加利用しなければ反映できない形でしょうか。 ******************** ①受注伝票検索 [https://api.next-engine.org](https://api.next-engine.org) /api_v1_receiveorder_base/search ②受注伝票出荷確定処理 [https://api.next-engine.org](https://api.next-engine.org) /api_v1_receiveorder_base/shipped ↓↓↓ここから追加↓↓↓ ③受注伝票検索 [https://api.next-engine.org](https://api.next-engine.org) /api_v1_receiveorder_base/search ⇒④で渡す最終更新日を取得するためだけにリクエスト ④受注伝票一括更新 [https://api.next-engine.org](https://api.next-engine.org) /api_v1_receiveorder_base/bulkupdate ⇒対象オーダーID、最終更新日、発送伝票番号のみをリクエスト ↑↑↑ここまで追加↑↑↑ ******************** ■質問３（dataとして渡す値形式について） 上記、④受注伝票一括更新を利用するとした場合 POST時、dataパラメータにxml形式を値として渡す際は以下の記載方法でよろしいのでしょうか。 （xml内の改行等があるがそのままわたしてしまってよいかの確認となります。） （例：パラメータの渡し方） ・・・・access_token=xxx&refresh_token=xxx&data_type=xxx&data= &receive_order_shipped_update_flag=1・・・・ 以上となります。お手数をおかけしてしまい申し訳ございませんが何卒よろしくお願い申し上げます。 --- ## 回答 (1件) ### hamee_sys — 2019/01/29 ■質問１ -> できない仕様でございます。 ■質問２ ->おっしゃるとおりでございます。 ■質問３ ->改行が入っていても問題ございません。 以上よろしくお願いいたします。 --- # 商品画像登録について URL: https://developer.next-engine.com/questions/1068/ **投稿者:** CS平井　**日時:** 2019/02/06 **カテゴリ:** ネクストエンジンAPIについて 下記APIの解説に商品画像登録について詳しい記載がないため、以下質問への回答をいただけますと幸いです。 [商品マスタアップロード](https://developer.next-engine.com/api/api_v1_master_goods/upload) 1.複数の画像ダウンロード元URLの指定方法 商品マスターAPI経由での商品登録の際、 商品画像は画像ダウンロード元URL（image_url_http）の値をdataに指定すれば、 画像URLから自動で取り込まれるかと思いますが、 商品登録時に **商品画像を複数登録したい**際はどのようにリクエストすればいいでしょうか？ 2.画像分類タグの設定 管理画面上（商品マスタ管理）では商品画像に**「画像分類タグ」**が設定できますが、 商品マスターAPI経由での商品登録で、商品画像に対する画像分類タグ指定はどのように行えばよいでしょうか？ 以上よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2019/02/07 1.複数の画像ダウンロード元URLの指定方法 ＞CSVにおいて、改行で区切ることで、複数設定していただくことができます。下記のページを参照くださいませ。 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) 2.画像分類タグの設定 ＞おそれいりますが、画像分類タグを設定するAPIの提供はございません。 以上よろしくお願いいたします。 ### CS平井（質問者） — 2019/02/07 諸々承知いたしました。 ご回答、誠にありがとうございました。 --- # 「ページ情報」API ありますか URL: https://developer.next-engine.com/questions/1069/ **投稿者:** 湯　文明　**日時:** 2019/02/08 **カテゴリ:** ネクストエンジンAPIについて プログラムで商品を掲載したいのですが、関連するAPIが見つかりません。 --- ## 回答 (1件) ### hamee_sys — 2019/02/13 大変恐縮ですが、ページ情報更新用のAPIはございません。 よろしくお願いいたします。 --- # ネクストエンジン側の在庫数を絶対値で更新する方法 URL: https://developer.next-engine.com/questions/1070/ **投稿者:** sai　**日時:** 2019/02/08 **カテゴリ:** ネクストエンジンAPIについて 基幹システムなどの外部システムで保持している在庫数で、 ネクストエンジン側の在庫数を更新できればと思っています。 APIのリファレンスを確認したところ、 増減による更新は可能のように思えたのですが、 絶対値での更新は出来ますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/02/13 恐縮ではございますが、商品在庫数の更新は相対値のみとなります。 下記の質問もご参考にしていただければ幸いです。 [https://developer.next-engine.com/questions/549](https://developer.next-engine.com/questions/549) --- # 在庫連携対象となる商品データの取込について URL: https://developer.next-engine.com/questions/1071/ **投稿者:** 湯　文明　**日時:** 2019/02/08 **カテゴリ:** ネクストエンジンAPIについて 在庫連携対象となる商品データの取込について、2つの問題があります： 1）この操作を置き換えるためのAPIはありますか？ 2）もしNextEngineで掲載された商品の場合、それでもこの操作が必要ですか？ --- ## 回答 (1件) ### hamee_sys — 2019/02/13 1)モール商品一括登録用のAPIは存在しません。 2) モール商品一括登録の機能はメイン機能になりますので、質問はサポートセンターまでお問い合わせくださいませ。 --- # アクセストークンのリフレッシュについて URL: https://developer.next-engine.com/questions/1085/ **投稿者:** umi　**日時:** 2019/02/20 **カテゴリ:** ネクストエンジンAPIについて 毎日、同様の処理(リフレッシュトークン)をしてアクセストークンがリフレッシュされる場合と されない場合があります。リフレッシュトークンの有効期限は問題なかったです。 コード：002002　アクセストークンが不正です。 と返却され、stateを取得し直さないといけない事になるのですが リフレッシュトークンを一緒に入れる以外でなにか判定しているのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/02/22 アクセストークンが期限切れかつリフレッシュトークンが有効期限内の場合、初回API実行時に新しいアクセストークンとリフレッシュトークンが返されます。 こちらを保持していただければエラーになることを防ぐことができます。 下記の質問を参考にしていただければ幸いです。 [https://developer.next-engine.com/questions/578](https://developer.next-engine.com/questions/578) --- # 各種の検索APIのデータ取得順について URL: https://developer.next-engine.com/questions/1087/ **投稿者:** inouema　**日時:** 2019/02/25 **カテゴリ:** ネクストエンジンAPIについて Q1. 受注伝票は、 伝票番号の昇順 でデータ取得される仕様が 質問 1043 への回答に記載がされておりました。 これは、Java PHP共通仕様という理解でよろしいでしょうか？ Q2. javaのSDKについて、以下の検索APIについて、データ取得順についての仕様を教えてください。 1） 受注明細検索API 　[https://api.next-engine.org/api_v1_receiveorder_row/search](https://api.next-engine.org/api_v1_receiveorder_row/search) 2） 受注オプション検索API 　[https://api.next-engine.org/api_v1_receiveorder_option/search](https://api.next-engine.org/api_v1_receiveorder_option/search) 3）在庫検索API 　[https://api.next-engine.org/api_v1_master_stock/search](https://api.next-engine.org/api_v1_master_stock/search) 4）商品マスターAPI 　[https://api.next-engine.org/api_v1_master_goods/search](https://api.next-engine.org/api_v1_master_goods/search) 5）アップロードキュー検索 　[https://api.next-engine.org/api_v1_system_que/search](https://api.next-engine.org/api_v1_system_que/search) 以上、よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/02/27 Q1.共通でございます。 Q2.下記の通りです。 1） 受注明細検索API [https://api.next-engine.org/api_v1_receiveorder_row/search](https://api.next-engine.org/api_v1_receiveorder_row/search) 昇順：receive_order_row_receive_order_id （優先度１） 昇順：receive_order_row_no (優先度２) 2） 受注オプション検索API [https://api.next-engine.org/api_v1_receiveorder_option/search](https://api.next-engine.org/api_v1_receiveorder_option/search) 昇順：receive_order_id 3）在庫検索API [https://api.next-engine.org/api_v1_master_stock/search](https://api.next-engine.org/api_v1_master_stock/search) 昇順：stock_goods_id 4）商品マスターAPI [https://api.next-engine.org/api_v1_master_goods/search](https://api.next-engine.org/api_v1_master_goods/search) 昇順：goods_id 5）アップロードキュー検索 [https://api.next-engine.org/api_v1_system_que/search](https://api.next-engine.org/api_v1_system_que/search) 昇順：que_id 以上、よろしくお願いいたします。 --- # 受注CSV自動アップロードについて URL: https://developer.next-engine.com/questions/1089/ **投稿者:** ECBB.H　**日時:** 2019/03/01 **カテゴリ:** その他 汎用ECサイトを利用しているんですが、受注CSVを自動でアップロードする機構を作ろうと考えてます。 サイトに関してはPHPを使用しています。 なにか、仕様書等ありましたら、確認をしたいです。 --- ## 回答 (4件) ### hamee_sys — 2019/03/01 仕様書の用意はございませんが、開発に必要なSDKおよびAPI仕様を当サイトで提供しております。 下記のリンクが参考になれば幸いです。 SDK情報 [https://developer.next-engine.com/api/sdk](https://developer.next-engine.com/api/sdk) 受注伝票アップロードAPI [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) よろしくお願いいたします。 ### ECBB.H（質問者） — 2019/03/01 こちらですが、作成自体は可能という認識でよろしいでしょうか？ ### ECBB.H（質問者） — 2019/03/01 こちらですが、作成自体は可能という認識でよろしいでしょうか？ ### hamee_sys — 2019/03/05 はい、アプリの作成自体は可能でございます。 --- # APIによる楽ロジの出荷実績反映について URL: https://developer.next-engine.com/questions/1092/ **投稿者:** ハイジ　**日時:** 2019/03/06 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 ネクストエンジンメイン画面にて、楽ロジの出荷実績を取得するためだけに 担当者の残業が発生して困っており、処理を自動化したいと思っております。 自動化したい部分の処理の現在の運用は以下の通りです。 1) メニューで　出荷＞倉庫連携＞[楽天スーパーロジ]出荷処理　をクリック 2) [出荷実績を反映]「楽天スーパーロジの出荷実績を反映」ボタンをクリック 3) 「出荷実績を取得しシステムに反映させます。よろしいですか？」のダイアログで OK をクリック 4) 少し待ってから、[出荷実績を反映]「結果をダウンロード」ボタンをクリック 5) 問い合わせ番号*** の結果を取得します。よろしいですか？」のダイアログで OK をクリック 以上です。 要するに楽ロジの出荷実績をネクストエンジンが取得し、受注伝票に反映をさせる処理を 行いたいのですが、対応する API がございましたら、ご教示ください。 以上、よろしくお願い申し上げます。 --- ## 回答 (3件) ### hamee_sys — 2019/03/08 今回の処理は楽ロジ様との連携が必要となってまいります。 そのため楽ロジ様に直接お問い合わせいただく必要がございます。 よろしくお願いいたします。 ### ハイジ（質問者） — 2019/03/12 ネクストエンジンのメイン画面上で行う処理ですので、ユーザーは楽ロジさんとは 直接やり取りをしていないと思います。 「ネクストエンジンさん、楽ロジさんから出荷実績を取ってきて！」という API はないという事でしょうか？ 以上、よろしくお願い致します。 ### hamee_sys — 2019/03/13 左様でございます。楽ロジ様のデータを取得する際は、 楽ロジ様が提供するAPIとの連携が必要となってまいります。 今回のケースでは、楽ロジ出荷実績を取得できるAPIが必要となると考えられます。 --- # 商品管理の入出庫履歴について URL: https://developer.next-engine.com/questions/1093/ **投稿者:** jac_matsuoka　**日時:** 2019/03/07 **カテゴリ:** その他 お世話になっております。 ネクストエンジンの商品管理の入出庫履歴について質問があります。 初歩的な質問になるのですが、商品管理の入出庫履歴で表示されている処理の項目をある特定の人物・会社に設定したいと考えております。 例えば、処理【他勘定入庫】を担当者名【株式会社A】に設定したい場合、 どこの画面で設定が可能でしょうか？ そもそもそのような設定が可能なのでしょうか？ ご教授のほどよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/03/08 こちらでは開発およびAPIの質問を受け付けております。 メイン機能の質問につきましては、サポートまでご連絡いただきますよう、お願い申し上げます。 --- # 商品ページエンドポイントについて URL: https://developer.next-engine.com/questions/1097/ **投稿者:** k.n　**日時:** 2019/03/08 **カテゴリ:** ネクストエンジンAPIについて 商品ページエンドポイントについてです。 [https://developer.next-engine.com/api/api_v1_master_pagebase/search](https://developer.next-engine.com/api/api_v1_master_pagebase/search) ネクストエンジンの商品管理画面（β）上には 表示順位の項目がありますが上の APIのフィールド一覧に存在しないようです。 この項目はAPIから取得できないものでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2019/03/13 こちらのAPIは商品マスタ管理用のAPIでございます。したがってβ版商品管理上の項目とはフィールドが一致しません。 またβ版のページ情報の内容を取得するAPIは提供がございませんので、ご了承くださいませ。 ### 菅原隼人 — 2021/08/04 > またβ版のページ情報の内容を取得するAPIは提供がございませんので、ご了承くださいませ。 お世話になります。 β版のページ情報の内容を取得するAPIについては、現状も提供されてないでしょうか？ --- # メイン機能の発注計算に関する機能について URL: https://developer.next-engine.com/questions/1099/ **投稿者:** YNN　**日時:** 2019/03/11 **カテゴリ:** ネクストエンジンAPIについて メイン機能の発注計算ページにある 欠品数を最新に更新 注残数を最新に更新 の機能はAPIで提供されていますか？ もし提供されていない場合は正確な欠品数や注残数を取得する方法を教えてください。 --- ## 回答 (1件) ### hamee_sys — 2019/03/13 大変恐縮ですが、現状のAPIでは欠品数、注残数を最新に更新していただくことができかねます。 メイン画面より手動での更新をお願いしております。 --- # ネクストエンジンアプリ認証方式変更に伴うSDK更新について URL: https://developer.next-engine.com/questions/1112/ **投稿者:** Maekawa　**日時:** 2019/03/16 **カテゴリ:** 開発環境・SDKについて お世話になります。 新しい認証方式に対応したSDKが配布されておりますが、SDKを入れ替えずに旧SDK（2015年版）を修正することで対応することはできないのでしょうか？ よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/03/18 旧SDKと比較の上、差分を修正していただくことで対応いただけます。 --- # 受注伝票の"受注内容確認”の条件に関わるフィールドをAPIで更新した後に、ネクストエンジンに再評価させることはできますか？ URL: https://developer.next-engine.com/questions/1119/ **投稿者:** inouema　**日時:** 2019/03/20 **カテゴリ:** ネクストエンジンAPIについて 汎用カートCSV受注一括取込で取り込んだ後、メイン画面上の”確認待ち”に振り分けられた受注伝票について "受注確認内容IDS"のフィールド値を API（受注伝票更新）で書き換えて、修正をしました。 その受注伝票をネクストエンジンに再評価させる方法はあるでしょうか？ 再評価をさせた後の期待値は、APIで書き換えた内容が ”受注確認内容”の条件に非該当になっていれば、先の状態に進む。 一方、書き換えた内容が不十分で、未だ”受注確認内容”の条件に該当していれば、"確認待ち"にとどまっているという動作です。 --- ## 回答 (6件) ### hamee_sys — 2019/03/25 大変恐縮ですが、自動で再評価をすることはできません。 確認チェック区分を更新いただき、遷移していただく必要がございます。 ### inouema（質問者） — 2019/03/26 ・ 再評価させることはできるんですね。（ただし、自動的ではない。） 　方法→「確認チェック区分を更新いただき、遷移していただく必要がございます。」 　　更新するという事は、確認チェック区分に "0" を書き込む。 という事になりますでしょうか？ ・また、以下の理解で正しいでしょうか？ 　- 確認チェック区分の値を更新しても直ちに 再評価されるのではなく、状態遷移が処理されるまで待たなければならない。 　- "受注内容確認”の条件に関わるフィールドと共に、確認チェック区分に適切な値を書き込んで受注伝票を更新すれば、やがて 受注伝票は遷移する。 ### hamee_sys — 2019/03/27 -更新するという事は、確認チェック区分に "0" を書き込む。 という事になりますでしょうか？ 左様でございます。 - 確認チェック区分の値を更新しても直ちに 再評価されるのではなく、状態遷移が処理されるまで待たなければならない。 - "受注内容確認”の条件に関わるフィールドと共に、確認チェック区分に適切な値を書き込んで受注伝票を更新すれば、やがて 受注伝票は遷移する。 NE側が再評価を行うことはございません。そのためAPIで書き換えた内容が ”受注確認内容”の条件に該当するか否かを条件式に書いていただき、該当する場合に確認チェック区分を"0"に更新するような処理を記述していただくと、一定時間後に状態を遷移させることができます。ただし一部において、遷移自体が行われないこともございますのでご了承ください。（商品マスタにない商品が買われたという場合など） ### inouema（質問者） — 2019/03/29 > （APIで書き換えた内容が ”受注確認内容”の条件に）該当する場合に確認チェック区分を"0"に更新するような処理を記述していただくと、一定時間後に状態を遷移させることができます。 上記の文は、 ネクストエンジンメイン機能の受注管理画面上の”確認待ち” より先に状態が進んでる（例えば "納品書印刷待ち"の）受注伝票の内容を APIで更新した場合に、一定時間後に状態が（例えば、"納品書印刷待ち"から"確認待ち"に）遷移するという事を説明いただいていると存じます。 その通りだとすると、 確認チェック区分を"0"以外から"0"に書き換える事をきっかけに、ネクストエンジンは伝票内容を再処理して「”受注確認内容”の条件に該当するか否か」を判定するので状態が遷移するのではないでしょうか？ すなわち、 ネクストエンジンに再評価（再処理）させる方法は、 『受注伝票の"確認チェック区分"フィールドの値を "0"以外からを"0"に書き換えること』であり、 ”再評価させる手段は存在する”と言えるのではないのでしょうか？ ### inouema（質問者） — 2019/03/29 > （APIで書き換えた内容が ”受注確認内容”の条件に）該当する場合に確認チェック区分を"0"に更新するような処理を記述していただくと、一定時間後に状態を遷移させることができます。 上記の文は、 ネクストエンジンメイン機能の受注管理画面上の”確認待ち” より先に状態が進んでる（例えば "納品書印刷待ち"の）受注伝票の内容を APIで更新した場合に、一定時間後に状態が（例えば、"納品書印刷待ち"から"確認待ち"に）遷移するという事を説明いただいていると存じます。 その通りだとすると、 確認チェック区分を"0"以外から"0"に書き換える事をきっかけに、ネクストエンジンは伝票内容を再処理して「”受注確認内容”の条件に該当するか否か」を判定するので状態が遷移するのではないでしょうか？ すなわち、 ネクストエンジンに再評価（再処理）させる方法は、 『受注伝票の"確認チェック区分"フィールドの値を "0"以外からを"0"に書き換えること』であり、 ”再評価させる手段は存在する”と言えるのではないのでしょうか？ ### hamee_sys — 2019/04/01 まず評価の定義についてですが、 「”受注確認内容”の条件に該当か非該当なのかをネクストエンジンが判断し、確認区分を更新、その値を基に状態遷移をさせるか否か」だと解釈しております。 ネクストエンジンにて一度”評価”後の伝票を再度”受注確認内容”に照らし合わすことはございません。 そのため再評価をさせるためには、伝票が受注確認内容に当てはまるか否かを質問者様で手動で振り分けていただく必要がございます。その後非該当であればAPIにて確認チェック区分を０にしていただく処理を入れていただくとその伝票は先の状態に進めることができます。 確認チェック区分の値をみて、”ネクストエンジンが状態遷移を判断する”ということを”評価”と定義とするのであれば、再評価はされるという認識でございます。 わかりづらい回答になってしまいましたが、何卒よろしくお願いします。 --- # 受注伝票の状態について、メイン画面上の状態と受注伝票のフィールド値との対応関係表が欲しいです URL: https://developer.next-engine.com/questions/1120/ **投稿者:** inouema　**日時:** 2019/03/20 **カテゴリ:** ネクストエンジンAPIについて メイン画面上の状態と、受注伝票のフィールドである受注状態区分の値は１対１対応になっていません、 メイン画面の受注伝票管理画面上に表示される　状態に対して、受注伝票の複数のフィールド値の組み合わせで状態遷移するものと考えています。 対応関係表というものはございますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/04/12 大変恐縮ですが、１対１の対応表はございません。 以下のマニュアルに受注ステータスごとの操作内容について記載がございますので、お役立ていただければ幸いです ・受注処理の流れ [https://manual.next-engine.net/main/orders/ord_overview/12709/](https://manual.next-engine.net/main/orders/ord_overview/12709/) ・受注ステータスごとの操作内容 [https://manual.next-engine.net/main/orders/ord_overview/12201/](https://manual.next-engine.net/main/orders/ord_overview/12201/) --- # ネクストエンジンアプリの販売について URL: https://developer.next-engine.com/questions/1121/ **投稿者:** jhchoi03　**日時:** 2019/03/25 **カテゴリ:** その他 こんにちは。 御社のアプリ開発および販売についてお問い合わせ致します。 ECカートとネクストエンジンを連携する場合のプロセスについて教えて頂けますでしょうか。 (参考までに、弊社はECカート会社です。) [https://developer.next-engine.com/api/start](https://developer.next-engine.com/api/start)の内容を確認したところ、 アプリを作る→ ネクストエンジンページのアプリ一覧で販売しているように見られますが、正しく理解できたのでしょうか。 １）ネクストエンジンのAPIを利用しアプリを作り、その後に審査を通ったらアプリを販売することができるのか、 ２）ECカート会社と提携し、(アプリを販売するのでは無く)ECカート内にアプリを制作・インストールし、ネクストエンジンとはAPIで通信するのか、 １番もしくは２番と理解しておりますが、いかがでしょうか。 ECカート会社と提携するプロセスなどについて教えて頂けたら幸いです。 ご確認のほど、よろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/03/27 アプリの販売形態は下記の２種類です。 1) すべての企業に公開 2) 特定の企業に公開 一般的なアプリを販売する場合は1を、 自社内での利用をお考えの場合は2をお選びください。 アプリ内より弊社提供のAPIをご利用いただけます。 ＞ECカート会社と提携するプロセスなどについて教えて頂けたら幸いです。 ECカート会社との連携におきましても、販売用、自社内での利用によって、販売形態は変わってまいります。 公開までは、 テスト環境にてアプリ作成→審査→審査通過後、本番環境にてアプリをご利用、販売 という流れになります。 --- # ネクストエンジンアプリの販売について URL: https://developer.next-engine.com/questions/1122/ **投稿者:** jhchoi03　**日時:** 2019/03/25 **カテゴリ:** ネクストエンジンAPIについて こんにちは。 御社のアプリ開発および販売についてお問い合わせ致します。 ECカートとネクストエンジンを連携する場合のプロセスについて教えて頂けますでしょうか。 (参考までに、弊社はECカート会社です。) [https://developer.next-engine.com/api/start](https://developer.next-engine.com/api/start)の内容を確認したところ、 アプリを作る→ ネクストエンジンページのアプリ一覧で販売しているように見られますが、正しく理解できたのでしょうか。 １）ネクストエンジンのAPIを利用しアプリを作り、その後に審査を通ったらアプリを販売することができるのか、 ２）ECカート会社と提携し、(アプリを販売するのでは無く)ECカート内にアプリを制作・インストールし、ネクストエンジンとはAPIで通信するのか、 １番もしくは２番と理解しておりますが、いかがでしょうか。 ECカート会社と提携するプロセスなどについて教えて頂けたら幸いです。 ご確認のほど、よろしくお願い致します。 --- # 複数税率対応について URL: https://developer.next-engine.com/questions/1132/ **投稿者:** inouema　**日時:** 2019/03/29 **カテゴリ:** その他 2019年10月1日より消費税１０％が導入され、税率の移行措置の対象商品を扱うECにおいては「複数税率」への対応が必要になると存じます。 - ネクストエンジンとして、複数税率対応の仕様変更、追加をなにか予定されておりますでしょうか？ - 仕様変更、追加の予定が無い場合、現在のネクストエンジンの機能を使って複数税率に対応するには、どのような設定と運用をすれば可能なのでしょうか？ 税率が異なる商品の明細を複数保持する受注伝票の税額を正しく再計算するには、商品毎に注文時に適用した税率を保持しておく必要があるのではないかと考えております。 --- ## 回答 (3件) ### hamee_sys — 2019/04/01 複数税率に関しては、ネクストエンジンでも対応予定ですが、仕様についてはまだ確定しておりませんので、現時点では回答できません。 正式な仕様に関しては、ネクストエンジンからご案内させていただく予定となっております。 よろしくお願いいたします。 ### mototo — 2019/05/09 仕様についての正式な決定、および公開は成されておりましたでしょうか。 当方、APIによる受注連携を行っておりますため、仕様が公開されているようでしたら詳細情報が確認できるURL等を教えていただけると助かります。 宜しくお願いいたします。 ### hamee_sys — 2019/05/17 >仕様についての正式な決定、および公開は成されておりましたでしょうか。 仕様についての正式な決定はまだ行われておりません。 決定次第告知いたしますので、今しばらくおまちくださいませ。 --- # 受注分類タグを受注一括登録（汎用CSVアップロード)で受注伝票に取り込む事はできますか？ URL: https://developer.next-engine.com/questions/1133/ **投稿者:** inouema　**日時:** 2019/03/29 **カテゴリ:** ネクストエンジンAPIについて 当方で調べた範囲では出来ないようですが、実現方法はございますでしょうか？ 汎用CSVの列には、受注分類タグ の列がありません。 →　[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_hanyo/5552/) 備考欄の変換機能には、 項目に変換する 機能に 「受注分類タグに追記」という選択項目がありません。 →　[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_benr...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_benri/10220/) --- ## 回答 (4件) ### hamee_sys — 2019/04/01 大変恐縮ですが、アップロードのタイミングでの取り込みはできませんので、 アップロードいただいた伝票に対して、 受注更新APIまたは受注一括更新APIにて値を入れていただく必要がございます。 ### inouema（質問者） — 2019/04/02 受注分類タグ　を APIで 受注伝票に 反映（取り込む）する方法については分かりました。 一方、受注内容確認設定として任意の分類タグについて 条件設定することができます。 　（補足）ネクストエンジンのメイン機能にある [設定-受注-受注確認内容設定]メニューから開く画面（受注確認内容設定）で、特定の受注分類タグについての”【確認待ち】にする条件”を選択して、指定することができます。 　上記を踏まえての質問です。 １．実現したいこと 　あらかじめ 店舗の設定にて”【確認待ち】にする条件”に、"受注分類タグ"の値に[○○タグ]を指定し、且つ、　受注一括登録（汎用CSVアップロード)　を行って、○○タグが設定されている受注伝票を【確認待ち】にさせたい。 ２． 質問 どうすれば、上記のように受注伝票を取り込む事ができるのでしょうか？ 単純に、受注一括登録を行った後に受注一括更新APIにて伝票に”受注分類タグ”を書き込むという手続きをすると、"受注分類タグ"が受注伝票に書き込まれる前にネクストエンジンが"受注確認内容の条件に該当しない"と判定して受注伝票を遷移させてしまう可能性が考えられます。 確実に、特定の"受注分類タグ"を持つ受注伝票を 【確認待ち】にする方法はございますでしょうか？ ### hamee_sys — 2019/04/04 ＞（補足）ネクストエンジンのメイン機能にある [設定-受注-受注確認内容設定]メニューから開く画面（受注確認内容設定）で、 ＞特定の受注分類タグについての”【確認待ち】にする条件”を選択して、指定することができます。 恐れ入りますが、特定の受注分類タグを条件に指定していただくことはできかねます。 代替案としてまして、「備考欄」を条件に指定していただくことができます。 1. 備考欄の確認待ち条件を設定 2. データの備考欄に１で設定した内容追加し、受注一括登録（汎用CSVアップロード)で登録する という流れでございます。 ### inouema（質問者） — 2019/04/04 ご回答ありがとうございました。 --- # クローズドな環境で本番を運用できますか URL: https://developer.next-engine.com/questions/1134/ **投稿者:** atsushi0843　**日時:** 2019/04/01 **カテゴリ:** ネクストエンジンAPIについて 初歩的かつ根本的な質問で大変恐縮ですが、社内にクローズドな環境にアプリを置くことはできるのでしょうか。 開発環境はクローズドな環境にありますが、本番環境もクローズドで審査に通るのか不安になってしまいました。 何卒よろしくお願い申し上げます。 --- ## 回答 (1件) ### hamee_sys — 2019/04/03 そちらは「特定企業にのみ公開」されるアプリでしょうか。 NEとの連携に問題がないのであれば、審査自体は通常通り行われます。 --- # 商品以外の受注明細作成について URL: https://developer.next-engine.com/questions/1142/ **投稿者:** inouema　**日時:** 2019/04/03 **カテゴリ:** ネクストエンジンAPIについて 受注情報のCSV一括取込を行う際、商品コードが商品マスターに登録されていないとエラーになるため、めあらかじめ商品以外の明細を表す商品コードを商品マスターに登録する必要があると考えています。 商品マスターに登録する価格はダミーとし、"手数料"を明細として取り込む事はできました。 この際、手数料 として登録されている商品の在庫引き当ての対象なので、自動引当されると商品と共に出荷される様に見受けられます。 一方、"値引き"については、金額の表現で問題がありそうです。（以下について実際に動かして試しておりません） 受注情報の汎用CSV明細フィールドの説明では、 受注明細の金額フィールドは全て　0以上の値を保持すると記載されております。（[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_hanyo/5552/)） 汎用店舗用CSVの説明で 負の値を保持出来るフィールドは、受注伝票の　”その他費用”列だけです。 従って、値引きとして負の値を指定する事ができないようです。 ネクストエンジンでは、値引き明細などの商品以外の明細を作成、運用することはできないのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/04/08 大変恐縮ですが、こちらはメイン機能のお問い合わせとなりますので、 サポートまでご連絡くださいませ。 --- # 同一ユーザーで複数アプリを利用する時のトークン情報の取り扱いについて URL: https://developer.next-engine.com/questions/1148/ **投稿者:** imada　**日時:** 2019/04/17 **カテゴリ:** ネクストエンジンAPIについて 一人のユーザーが複数の同じメイン機能に接続する自社アプリを使用する場合、 アクセストークンは各自社アプリ毎に発行されますでしょうか？ 片方の自社アプリのアクセストークンを取得すると、 もう一方のアクセストークンが使用できなくなるといったことはありえますでしょうか？ 【具体例】 - メイン機能1 - 自社アプリA(メイン機能1に接続) - 自社アプリB(メイン機能1に接続) - ユーザーa 1. ユーザーaでログインし、自社アプリAのアクセストークンを取得(この時点ではAPIにアクセスできる) 2. 自社アプリBのアクセストークンを取得 3. 自社アプリAのアクセストークンを使ってAPIにアクセスすると、アクセストークンが不正と言われる --- ## 回答 (2件) ### hamee_sys — 2019/04/19 >もう一方のアクセストークンが使用できなくなるといったことはありえますでしょうか？ アクセストークンは同じユーザであってもアプリごとの管理となります。 そのためもう一方のアプリへの影響はございません。 ### imada（質問者） — 2019/04/23 ご回答ありがとうございます。 承知いたしました。 --- # 楽天ペイ キャンセル連携後の受注伝票の更新日について URL: https://developer.next-engine.com/questions/1149/ **投稿者:** NnA4bBhpKDR　**日時:** 2019/04/17 **カテゴリ:** ネクストエンジンAPIについて 楽天ペイとNEとAPI連携しているのですが、 楽天側でキャンセルとなった場合、NE側も連携されキャンセルとなります。 この場合の伝票自体の「更新日」は更新されないのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/04/19 楽天のキャンセル注文がNEに取り込まれた日時で更新されます。 よろしくお願いします。 --- # 開発言語を教えてください URL: https://developer.next-engine.com/questions/1151/ **投稿者:** 草野　由華　**日時:** 2019/04/22 **カテゴリ:** ネクストエンジンAPIについて APIプログラムは貴社のアプリケーションサーバー上で 動作するプログラムを作成する必要があると認識いたしました。 その上で以下確認させてください。 ・開発言語を教えてください サンプルコードは JAVA、PHP の記述がありましたが それ以外で可能な範囲を教えていただけますでしょうか？ （開発会社は基幹系システムベンダのため、C＃、VB.Netが使えると助かります。） --- ## 回答 (1件) ### hamee_sys — 2019/04/22 >APIプログラムは貴社のアプリケーションサーバー上で >動作するプログラムを作成する必要があると認識いたしました。 弊社のサーバ上ではなく、貴社のサーバーにて動作いたします。 そのためHTTPSの通信ができる環境であれば、言語を問わずアプリの作成が可能でございます。 --- # 受注伝票有効化の自動化について URL: https://developer.next-engine.com/questions/1155/ **投稿者:** 田村　のぞみ　**日時:** 2019/04/23 **カテゴリ:** ネクストエンジンAPIについて サポートのほうに、汎用店舗で受注データを自動で有効化する機能はないか問い合わせたところ、 公式ではそのような機能はないということだったので、アプリ開発を検討しています。 下記不明点なのですが、ご回答頂けますでしょうか？ =========================================== ・メイン機能で「受注伝票有効化」を行ったときと同じ処理をアプリで実現したい場合、 　方針は下記であっておりますでしょうか？ 　　　1. 受注伝票検索APIを叩き、受注状態区分が「1.受注メール取込済」であるもののみ、取得する 　　　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 　　　2. 受注伝票一括更新APIを叩き、↑で取得したデータの受注状態区分を「20.納品書印刷待ち」に変更する 　　　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) ・（方針があっている場合）変更対象の受注状態区分は「20.納品書印刷待ち」であってますでしょうか？ ・（方針があっている場合）受注状態区分を変更した時、在庫不足等があった場合は適切な区分（確認待ちや引当待ち）で止まってくれるのでしょうか？ 　それとも、エラーが返ってくるのでしょうか？ =========================================== 以上になります。 お忙しいところお手数ですが、お力添え頂けますようお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/04/26 受注伝票有効化を自動で処理していただくためには、下記のような実装が想定されます。 1. 受注伝票検索APIを叩き、受注状態区分が「1.受注メール取込済」であるもののみ、取得する。 2.1で取得した受注伝票を基に取り込み用のcsvファイルを作成し、受注伝票アップロードAPIでcsvをアップロードする。 ※作成の際には、メイン機能の受注一括登録と同様に必要な項目を設定する必要がございます。 更新後、伝票の状態によって確認待ち〜印刷待ちのいずれかに遷移されます。 --- # APIによる受注一括登録で「存在しない受注一括登録パターン」エラーが発生する URL: https://developer.next-engine.com/questions/1156/ **投稿者:** d-lion　**日時:** 2019/04/23 **カテゴリ:** ネクストエンジンAPIについて APIによる受注一括登録で「存在しない受注一括登録パターン[xx]です。」というエラーが返ってきます。 管理画面で見る限り、xx番の登録パターンは存在しており、何も変更を加えていないのに突然エラーが 返ってくるようになりました。 原因として何か考えられることはございますでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/05/16 [https://developer.next-engine.com/questions/574](https://developer.next-engine.com/questions/574) --- # 受注担当者IDについて URL: https://developer.next-engine.com/questions/1159/ **投稿者:** NSN　**日時:** 2019/04/24 **カテゴリ:** ネクストエンジンAPIについて 受注担当者IDはAPIからは変更できないように見受けられましたが、間違いないでしょうか。 また、受注担当者はNextEngine上でどのように定義されているか教えてください。 --- ## 回答 (1件) ### hamee_sys — 2019/04/25 はい、受注担当者IDの変更はできません。 受注担当者とはNextEngineにおいて、受注伝票を作成および取り込みを行なった人を指します。 --- # 特定の企業に公開のアプリを複数作成した場合の料金 URL: https://developer.next-engine.com/questions/1160/ **投稿者:** 西田太郎　**日時:** 2019/04/30 **カテゴリ:** ネクストエンジンAPIについて 特定の企業に公開でアプリを複数作成した場合は その数分の料金が発生するとのことですが、 料金表にあるように、リクエスト回数や通信データ量によって料金が違いますが 仮に３つのアプリを作成した場合は、３つの合計のリクエスト回数になりますか？ それとも、下記の例のように１つ１つのアプリのリクエスト回数で、それによってそれぞれに料金が発生するということになりますか？ 例 アプリA：リクエスト回数 500/月→0円 アプリB：リクエスト回数 1500/月→5,000円 アプリC：リクエスト回数 30/月→0円 合計 5,000円 --- ## 回答 (1件) ### hamee_sys — 2019/05/09 >それとも、下記の例のように１つ１つのアプリのリクエスト回数で、それによってそれぞれに料金が発生するということになりますか？ 左様でございます。それぞれのアプリは別々に料金が計算されます。 --- # 独自販売管理システム間のCSVデータのダウンロード・アップロード URL: https://developer.next-engine.com/questions/1161/ **投稿者:** 草野　由華　**日時:** 2019/05/08 **カテゴリ:** その他 サーバーサイドアプリケーションを開発すれば、自動反映可能かと思いますが、 手動にて独自の販売管理システムへのデータ（CSV）アップロードとダウンロードが出来る環境を整えたいと考えておりますが、 可能でしょうか。 ＜やりたい事＞ ①ネクストエンジンから売上データを販管システムへ戻す（売上データをCSVデータでダウンロード） ②販管システムの在庫をネクストエンジン側へ反映（販管システムからCSVデータで在庫情報をアップロード） ③商品等各種マスタ情報をネクストエンジン側へ反映（販管システムからCSVデータで在庫情報をアップロード） 方法としては、簡単に出来ますでしょうか。 --- ## 回答 (4件) ### hamee_sys — 2019/05/08 >手動にて独自の販売管理システムへのデータ（CSV）アップロードとダウンロードが出来る環境を整えたいと考えておりますが、可能でしょうか。 １点確認がございます。 この環境とは、アプリケーションの開発を指していらっしゃいますでしょうか。それともメイン側の環境を指していらっしゃいますでしょうか。 ### 草野　由華（質問者） — 2019/05/09 メイン側の環境をさしております。 ### 草野　由華（質問者） — 2019/05/09 メイン側の環境をさしております。 ### hamee_sys — 2019/05/09 メイン機能に関してましては、弊社サポートにて問い合わせを受け付けております。 よろしくお願いいたします。 --- # モールでの付与ポイント数について URL: https://developer.next-engine.com/questions/1163/ **投稿者:** KamiyaRAIRAI　**日時:** 2019/05/11 **カテゴリ:** その他 楽天やヤフーショッピングなど、モールでお客様に付与したポイント数を１商品単位（１注文単位ではなく）NE伝票で表示したり、カスタムデータで出力したりできないのでしょうか。 楽天だと「ポイント倍率」という項目で出てくるそうですが、（[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu__rakuten/20637/) ）によると取り込まないようになっているようです。 NEでできないとなればどのようにみなさん付与ポイントを算出されているのでしょうか。 楽天市場の場合だと、 NEのカスタムデータで受注番号・商品コード・小計金額を出力し、楽天の通常購入データから受注番号と商品番号・ポイント倍率のデータをcsvで引っ張り出し、 NEデータの「受注番号＆商品コード」楽天データの「受注番号＆商品番号」として文字列を繋げ、VLOOKUP関数で引っ掛けてかなりの部分の付与したポイントは導き出せるのですが、セット商品連携しているものは商品番号とNEの商品コードが一致しなかったり、NEの商品コード紐付けを使っているものなどの注文に付与したポイントはこの方法では出せません。 自分が思いつく方法はこのくらいです・・・ 何かいいアイデアお持ちの方いらっしゃいましたらお教えいただけると幸いです。 --- # Next EngineからECカートに情報送信時にどうなるのですか。 URL: https://developer.next-engine.com/questions/1164/ **投稿者:** jhbok　**日時:** 2019/05/14 **カテゴリ:** ネクストエンジンAPIについて 注文登録、発注(配送処理)、商品登録、在庫登録をNext Engine側からECカート側に送信するためにはNext Engine側での開発が必要ですか。 まだ、Next Engineで提供していないECカートです。 --- ## 回答 (3件) ### hamee_sys — 2019/05/17 未対応のECカートに関して、カート側へデータを連携をする場合はアプリでの開発が必要となります。 ### jhbok（質問者） — 2019/06/12 上述のようにするには、 ネクストエンジン側でECカートの仕様に合わせて商品登録フォームを作成して頂き、 ネクストエンジン側からECカート側にデータ送って頂かないと不可能だと存じますが、 どの方法でどのAPIを利用して開発するのかガイド頂けますでしょうか。 ご検討宜しくお願い致します。 ### hamee_sys — 2019/06/19 連絡が遅くなり、申し訳ありません。 EC側よりネクストエンジンのAPIを呼んでいただき、ECカートに合わせたデータ加工をしていただく必要がございます。下記にAPIの一例をを記載しておきます。 注文管理：/api_v1_receiveorder_base/search 商品登録：/api_v1_master_goods/search 在庫登録：/api_v1_master_stock/search 配送処理：/api_v1_receiveorder_base/shipped --- # 在庫管理の基準 URL: https://developer.next-engine.com/questions/1165/ **投稿者:** jhbok　**日時:** 2019/05/14 **カテゴリ:** ネクストエンジンAPIについて 在庫管理は注文基準、入金基準でも管理が可能ですか。 --- ## 回答 (3件) ### hamee_sys — 2019/05/17 下記のAPIが参考になるかと存じます。 商品マスタアップロード（/api_v1_master_goods/upload）： 商品マスタおよび在庫を更新 在庫マスタ検索（/api_v1_master_stock/search）： 検索条件により詳細な在庫の状況を把握することが可能 注文基準、入金基準というのは、具体的にどのようなことをおっしゃっていますか。 ### jhbok（質問者） — 2019/06/12 注文基準: 決済手段とは関係なく[新規受付]に注文が入った基準 入金基準: 銀行振込、コンビニ決済などの入金処理が必要な注文の場合、入金が処理される基準 注文基準であれば、入金有無とは関係なく注文が登録されたら在庫がマイナスになって、 入金基準であれば、注文が登録されても入金済みになるまでは在庫がマイナスにならないと存じます。 再度、ご検討宜しくお願い致します。 ### hamee_sys — 2019/06/19 連絡が遅くなり、申し訳ありません。 在庫の引き当ては注文後に行われます。 --- # テストアカウントの提供？ URL: https://developer.next-engine.com/questions/1166/ **投稿者:** jhbok　**日時:** 2019/05/14 **カテゴリ:** ネクストエンジンAPIについて API連動開発テストのためのNext Engineのテストアカウントはどのプロセスで確保できますか。 --- ## 回答 (1件) ### hamee_sys — 2019/05/17 アプリ開発の一連の流れは下記のページを参照くださいませ。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) --- # 配送会社情報のAPI情報 URL: https://developer.next-engine.com/questions/1167/ **投稿者:** jhbok　**日時:** 2019/05/14 **カテゴリ:** ネクストエンジンAPIについて 配送会社と送り状番号はどのAPIのどのテーブルを通して収集できますか。 --- ## 回答 (1件) ### hamee_sys — 2019/05/17 下記の通りでございます。 API名：受注伝票検索　/api_v1_receiveorder_base/search 配送先：receive_order_delivery_name 送り状：receive_order_invoice_name --- # Next EngineからECカートに情報送信時にどうなるのですか。 URL: https://developer.next-engine.com/questions/1168/ **投稿者:** jhbok　**日時:** 2019/05/15 **カテゴリ:** ネクストエンジンAPIについて 受注登録、発注(配送処理)、商品登録、在庫登録情報をNext Engine側からECカート側に送信するにはNext Engine側での開発が必要ですか。 まだ、連動されてないカートです。 --- ## 回答 (1件) ### user1125 — 2019/05/17 受注 商品 　APIを経由して入力及び出力を行う必要があります。 　ネクストエンジンからECモールへ更新されるようにするにはネクストエンジンのメイン機能側で開発する必要があります。 在庫 　APIを経由して在庫数をIN/OUTする事も可能ですし、汎用形式の店舗であれば、 　[https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5174/) 　ECカート側を上記の仕様で機能実装する事でネクストエンジンからECカートへ在庫が送信されるようになります。 --- # 過去受注の検索について URL: https://developer.next-engine.com/questions/1169/ **投稿者:** 沼尻　淳　**日時:** 2019/05/15 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIにて、過去受注の検索を行う場合、現在日時からどの程度過去の注文日まで遡り検索ができるのでしょうか？ よろしくお願いいたします。 【対象API】 受注伝票件数取得：/api_v1_receiveorder_base/count 受注伝票検索：/api_v1_receiveorder_base/search 受注明細件数取得：/api_v1_receiveorder_row/count 受注明細検索：/api_v1_receiveorder_row/search --- ## 回答 (1件) ### hamee_sys — 2019/05/30 経過年数による制限は特に設けておりませんので、 受注伝票が存在する限り、遡って取得していただくことができます。 --- # アプリの開発方法について URL: https://developer.next-engine.com/questions/1173/ **投稿者:** jhbok　**日時:** 2019/05/22 **カテゴリ:** ネクストエンジンAPIについて 弊社ではNext Engineアプリストアでアプリを登録して販売するのではなく弊社でサービスしているECカートとNext Engineの注文、商品、在庫連動の開発をして弊社のお客様にNext Engineのサービスを提供する予定でございます。 開発するアプリは弊社側で設置して使用するようになります。 この場合、どのように行うのかお教えいただけますでしょうか。 例) 1．Next EngineのAPIを利用して弊社側で開発し、別途の審査やアップロードせずに提供する。 2．Next Engineにアプリを登録して審査を頂き、アプリストアにはアップロード(表示)せずにサービスを提供する。 上記の例以外に別途の方法があれば、お教え頂ければ幸いです。 宜しくお願い致します。 --- ## 回答 (7件) ### hamee_sys — 2019/05/27 アプリの利用の際は必ず審査が必要となってまいります。 今回の場合は下記の流れとなります。 1.アプリの開発（開発の際、アプリのタイプにて「特定企業にのみ公開」を選択ください。アプリストアへ表示されなくなります） 2.アプリの審査 3.アプリの利用 注意点としまして、「特定企業にのみ公開」はリクエスト量に応じた料金が発生いたします。詳しくは下記のページを参照くださいませ。 [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) ### jhbok（質問者） — 2019/05/27 ご回答ありがとうございます。 追加のご質問がございます。 発生する料金をお支払いする側は開発するECカートなのでしょうか。それとも、アプリを利用する加盟店でしょうか。 再度ご確認お願い致します。 ### hamee_sys — 2019/06/03 アプリの登録がECカート、利用者様のどちらで行われるかによって変わってまいります。 利用者側様のネクストエンジンと連携する場合、利用者様へ請求。 ECカート側のメイン機能と連携する場合は、ECカートを運営の事業者様へ請求が行きます。 ### jhbok（質問者） — 2019/06/03 追加のご回答ありがとうございます。 その認識ですと、 ECカート側でAPI利用料金を支払って、 ショップ運営者様はNext Engineの利用料金を支払って どちらも利用料金を支払うようになるとのことでしょうか。 ECカートとNext Engineを連携して 別途の利用料金を払わずにショップがNext Engine利用料金のみ支払うようにする方法はございますでしょうか。 弊社が考えている方式は ECカート側にアプリを設置後、ECカートとNext Engineの間で注文・配送・在庫連携して 費用はショップからNext Engine側に月額をお支払いする([https://next-engine.net/price](https://next-engine.net/price)) となります。 追加で、 アプリを作成してNext Engineのアプリストアに登録して、利用者様がそのアプリを設置した場合、 そのアプリはNext Engine側に設置され、Next EngineからECカート側にアップデート又は検索する方法のみ可能になると考えております。 ECカートからNext Engine側にアップデートや検索ができるようにするには ECカートにもアプリが設置されるようにならないといけない認識で問題ないでしょうか。 長くなってしまいましたが、ご回答の方、宜しくお願い致します。 ### hamee_sys — 2019/06/05 通常、「特定企業にのみ公開」ではアプリを登録し、申請をしたネクストエンジンとメイン機能が連携されます。 その際、API利用料金は登録された企業様に請求されます。 ＞アプリを作成してNext Engineのアプリストアに登録して、利用者様がそのアプリを設置した場合、 ＞そのアプリはNext Engine側に設置され、Next EngineからECカート側にアップデート又は検索する方法のみ可能になると考えております。 「特定企業にのみ公開」の場合、様々な利用者様がそのアプリを設置するには、利用者様が利用しているネクストエンジンで個別にアプリを登録し、申請を行う必要があります。 APIの料金、ネクストエンジンの利用料金は利用者様（ショップ様）に請求されます。 ただその場合、ショップ様ごとにアプリを登録、申請していただかなくてはならないため、あまり現実な方法ではないかと存じます。 ショップ様ごとにそれぞれのネクストエンジンのメイン機能とECカートの連携を考えていらっしゃる場合、 「すべての企業に公開」タイプを選んでいただき、ECカート企業様がアプリを登録いただきますと、 ショップ様はAPI通信料金なしに、自らのネクストエンジン環境とECカートとの連携をすることが可能でございます。 ただしこの場合は、Next Engineアプリストアに公開されることになり、どなたでも利用ができるアプリとなります。 ### jhbok（質問者） — 2019/06/05 ご回答ありがとうございます。 つきましてご質問がございます。 「特定企業にのみ公開」タイプでECカート企業からネクストエンジンのアプリストアにアプリを登録して、 ショップ様が該当アプリを設置した場合、下記の項目がすべて利用可能でしょうか。 1.特定アクション(商品登録、注文登録など)についてネクストエンジンからECカート側にAPIで情報転送OK ex) ネクストエンジン側でECカート側のAPIを利用して開発して頂ける場合、利用可能 2.特定アクション(注文登録、アップデート、商品登録など)についてECカートからネクストエンジン側にAPIを利用して情報転送OK ex) ECカートから注文の発生時に「受注伝票アップロードAPI」を利用して、ネクストエンジン側に注文情報を転送して注文登録 3. ECカートからネクストエンジン側にAPIを利用して特定情報(注文状態など)について内容を検索して情報の収集OK ex) ECカートから「受注伝票検索API」を利用してネクストエンジン側に注文情報を検索した後、注文データ収集 ECカートから「配送情報出力済みAPI」を利用してネクストエンジン側に配送情報を検索した後、配送データ収集 ECカートから「在庫マスタ検索API」を利用してネクストエンジン側に在庫情報を検索した後、在庫データ収集 少し長くなりましたが、再度ご確認の方宜しくお願い致します。 ### hamee_sys — 2019/06/19 NEのAPI、ECカート側のAPIを利用してアプリを開発することが大前提となります。 APIは全てネクストエンジンのアプリ上で行う必要がございます。 NE ⇆ NEアプリ ⇆ECカート というイメージです。 １、NEアプリよりネクストエンジンのAPIを利用して、開発いただいた場合、可能です。 ２、NEアプリより特定アクションに必要なAPIを利用していただくことで、情報の更新が可能です。 ３、NEアプリより特定の情報検索に必要なAPIを利用していただくことで、情報の検索が可能です。 --- # Next EngineからECカート側に商品情報や在庫情報を転送する方法について URL: https://developer.next-engine.com/questions/1174/ **投稿者:** jhbok　**日時:** 2019/05/22 **カテゴリ:** ネクストエンジンAPIについて 一般的に最初注文と商品登録はECカートからNext Engine側にデータを転送して登録(アップデート)して、 Next Engineに保存されている注文情報と在庫情報はECカートから検索してきてECカート側にアップデートするようになっていることと認識しております。 もし、注文情報のアップデート、商品登録、在庫情報アップデートをNext Engineから特定の状況によりECカート側にデータを転送するには、 アプリを開発してNext Engineのアプリストアに登録すればできるのでしょうか。 それとも、Next Engine側で別途開発が必要になってくるのでしょうか。 ご回答宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/05/27 上述の３つの機能 1.注文情報のアップデート 2.商品登録 3.在庫情報アップデート であれば、アプリ開発にて実現していただくことが可能でございます。 --- # キャンセルや返品について URL: https://developer.next-engine.com/questions/1175/ **投稿者:** jhbok　**日時:** 2019/05/22 **カテゴリ:** ネクストエンジンAPIについて キャンセルと返品が発生した場合、Next Engineの管理ページではキャンセル完了、返品完了のみ可能だと認識しております。 「キャンセル受付」、「返品受付」のように受け付けているということを表示する方法はございますでしょうか。 ECカートにキャンセルのお問い合わせが入ってきた時、Next Engine側でステータスをアップデートしないとキャンセルの受け付けている注文が発送されてしまう事故を防げると思います。 ご回答宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/05/27 こちら、メイン機能の質問になりますので、 お手数ですが、 サポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 --- # 受注伝票の複製について URL: https://developer.next-engine.com/questions/1177/ **投稿者:** NSN　**日時:** 2019/05/22 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注伝票の複製ができるエンドポイントはないでしょうか。 APIを用いて新規で伝票を作成するには/api_v1_receiveorder_base/uploadにアップロードするしかないでしょうか。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/06/05 連絡が遅れてしまい、申し訳ありません。 大変恐縮ですが、伝票複製用のAPIは用意はございません。 伝票アップロードAPIをご利用くださいませ。 --- # アプリ:Amazon FBA用 管理　「システムエラー」 URL: https://developer.next-engine.com/questions/1180/ **投稿者:** 山口雄大　**日時:** 2019/05/28 **カテゴリ:** その他 メニュー名：アプリ:Amazon FBA用 管理 機能名：アプリから納品 タイトル：システムエラー アイデアの詳細： 【アイデアの内容】 (1)納品数エラー内容の詳細を表示してほしい。もしくはエラー商品に関しては、 納品せずに、納品可能のものだけを登録できる仕様に変更してほしい。 表示例： 納品数エラー詳細：SKU○○はサイズエラーのため、納品登録できません。 納品数エラー登録しない：SKU○○はamazonエラーのため、納品登録できませんでした。 (2)CSVで納品数をアップロードできるようにしてほしい。 【現在はどのような点が御不便でしょうか？】 全ての商品納品数を登録した後に 「システムエラー」と表示され、修正の詳細がわからず、 最初からやりなおすことが度々発生します。 やり直すことにより、かなりの手間が発生してしまいます。 【実現するとどのような点が便利になりますでしょうか？】 1000SKU以上の販売数と在庫をチェックして、納品数を1つ1つ入力しています。 その作業に1時間前後かかります。 それをやり直す作業は倍の工数が発生してしまっており、 これを改修していただくだけで、時間のロスは大幅に改善されます。 弊社は2015年からずっと利用していますが、改修が一向にされずに困っています。 --- ## 回答 (1件) ### hamee_sys — 2019/06/05 この度、頂戴しました内容はご要望として承り、 今後の機能改善の課題として検討させていただきます。 また、ネクストエンジンAPI以外の質問につきましては、 以降下記のメールアドレスにお問い合わせ願います。 [info@next-engine.jp](mailto:info@next-engine.jp) ご不便をおかけしまして申し訳ございませんが、何とぞよろしくお願いいたします。 --- # Shopify Connection URL: https://developer.next-engine.com/questions/1182/ **投稿者:** Soumya　**日時:** 2019/05/30 **カテゴリ:** ネクストエンジンAPIについて How can I Access the Shopify products in my next-engine main function? --- ## 回答 (1件) ### hamee_sys — 2019/06/03 Thank you for your inquiry, Firstly you need to register using this app on the page below. [https://base.next-engine.org/apps/479/detail/](https://base.next-engine.org/apps/479/detail/) For more questions, you are available to contact our support team from the following page. [https://base.next-engine.org/inquiries/](https://base.next-engine.org/inquiries/) please contact them for any inquiries about main function. Sincerely yours, --- # Next-Engine Application with shopify URL: https://developer.next-engine.com/questions/1184/ **投稿者:** sowji　**日時:** 2019/05/31 **カテゴリ:** ネクストエンジンAPIについて Sample PHP SDKを使用してShopifyに接続する。 「パラメータ結合が無効です」というエラーが表示されます。 --- # リンケージパラメータの問題 URL: https://developer.next-engine.com/questions/1186/ **投稿者:** Soumya　**日時:** 2019/06/03 **カテゴリ:** ネクストエンジンAPIについて Client_IdとClient_secretを提供した後にPHP SDKを実行している間 "連携用パラメータが不正です" 問題. --- # Linkage Parameter Issue URL: https://developer.next-engine.com/questions/1188/ **投稿者:** sowji　**日時:** 2019/06/03 **カテゴリ:** 開発環境・SDKについて While running PHP SDK through Wamp Getting invalid linkage parameter issue. --- ## 回答 (8件) ### hamee_sys — 2019/06/07 Check your setting according to the following items - Client id & Client secret's value are correct - SDK’s version is up-to-date - Login account has the access to main function - Login account has the access to application - Callback url has set correctly When you are troubled accessing application, please contact application operating company. Sincerely yours, ### Soumya — 2019/06/10 Is the Callback URL and REdirect URI are the same? If the callback URL is different the where can I set the callback URL? ### hamee_sys — 2019/06/11 Yes, they have the same meaning. ### Soumya — 2019/06/11 I have mentioned the store URL as Redirect URI. Or what can be the REdirect URI? And what will I mention as the app URL? ### Soumya — 2019/06/11 I am using the Shopify auto linkage application to connect the Shopify inventory with next-engine, After filling the details it's generating a store token, what is the use of that token. ### hamee_sys — 2019/06/19 >I am using the Shopify auto linkage application if you are talking about this application ( [https://base.next-engine.org/apps/479/detail/](https://base.next-engine.org/apps/479/detail/) ), I'm afraid i won't be able to support you. again, please contact application operating company. ### Soumya — 2019/06/20 Thank you for the support Is there any mail ID to contact the application operating company? ### hamee_sys — 2019/06/21 I’m happy to help See the link below for the contact info [https://base.next-engine.org/apps/479/detail/](https://base.next-engine.org/apps/479/detail/) Sincerely yours, --- # リフレッシュトークンについて URL: https://developer.next-engine.com/questions/1189/ **投稿者:** k.n　**日時:** 2019/06/05 **カテゴリ:** ネクストエンジンAPIについて [https://developer.next-engine.com/questions/1085](https://developer.next-engine.com/questions/1085) 上の質問にて 各APIのリクエスト時に 『アクセストークンが有効期限切れ』、『リフレッシュトークンが有効期限内』だった 場合新しいアクセストークンとリフレッシュトークンが返却されると返答されています。 上のリクエストの際に使用した古いリフレッシュトークンは無効化されるのでしょうか。 新しいリフレッシュトークン、古いリフレッシュトークン共に有効期限内なら使えるのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/06/11 古いリフレッシュトークンは新しいリフレッシュトークンが発行されますと無効となります。 --- # POSTで取得した商品IDでマスタ更新できない URL: https://developer.next-engine.com/questions/1190/ **投稿者:** アップリ開発中　**日時:** 2019/06/05 **カテゴリ:** ネクストエンジンAPIについて 経験が浅く初歩的な質問になります。 現在、入力フォームから受け取ったPOST値、GET値の「商品ID」を 使って、商品マスタを更新したいですが、反映しないので質問させていただきます。 ・更新できる場合 ＄str = "testid-0101"; (中略） $goods_upload = $client->apiExecute('/api_v1_master_goods/upload', $str) ; であると、うまくいきます。 ・更新できない場合 if(isset($_GET['str'])){　　//or $_POST['str'] $str= $_GET['str']; }else{ $str= ''; } (中略） $goods_upload = $client->apiExecute('/api_v1_master_goods/upload', $str) ; GET,POST値で実行するとうまくいきません。 GET,POSTで受け取ったデータがおかしいのかと思い strcmp( $str , "testid-0101") をすると等しく、 原因がわかりません。 文字コードも確認しております。 よろしくお願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2019/06/06 具体的にどのようなエラーが返ってまいりますでしょうか。 レスポンスのアップロードキューを検索していただくことで、 どのようなエラーが返ってくるかを知ることができます。 まずはそちらをご確認くださいませ。 ### アップリ開発中（質問者） — 2019/06/10 返信ありがとうございます アップロードキューを検索し、que_status_id)　= "" que_message = "" となにもはいってきません ちなみに更新ができた場合もできなかった場合も同じで、 エラー内容を確認することができない状態です。 更新するデータの内容は、[syouhin_cd,zaiko_su\n商品ID,-1] というデータを作成し /api_v1_master_goods/upload　を実行しています。 上記の質問で更新できる場合は、 /api_v1_master_goods/upload　を実行した後のデータは、[syouhin_cd,zaiko_su\n商品ID,-1]　とそのままですが、 POSTの値（商品ID）を使って作成したデータで実行すると、[syouhin_cd,zaiko_su\n,-1]　となり、 POSTの値だけなくなってしまう現象です。 それが原因で更新できないと考えております。 よろしくお願いいたします ### hamee_sys — 2019/06/18 通常アップロードキューには何かしらのメッセージが戻ってきます。 またフォーム値でのAPIコール時にリクエストパラメータが空欄になるという事象も他では見受けられません。 大変お手数ですが、再度プログラム側の見直しをお願いいたします。 --- # access tokenの更新失敗 URL: https://developer.next-engine.com/questions/1191/ **投稿者:** atsushi0843　**日時:** 2019/06/06 **カテゴリ:** ネクストエンジンAPIについて 既存の質問への追加として [https://developer.next-engine.com/questions/578#comment-1787](https://developer.next-engine.com/questions/578#comment-1787) に書き込んだのですが、埋もれてしまっているかも知れませんので、新規の質問として改めて書き込みますことをご了承ください。 バッチでAPIを実行する際、 「access tokenが有効期限切れ、refresh tokenが期限内という状態になった場合、初回のAPI実行のみエラーにはならず新しいaccess tokenとrefresh tokenが発行されます」 とのことですが、 上記条件に該当する初回API実行時にも、たまにエラー(002002: access_token[xxxxx]が不正です。)が発生することがあります。 その場合、バッチでは二度と新しいaccess_tokenはもらえないので、アプリにアクセスしてaccess_tokenをもらうしかありません。 一時間おきにバッチ実行した場合も、一日に一回実行した場合も、数日から二週間に一回くらいのペースでエラーになりました。 何かやり方に問題があるか確認すべき点があればご助言願えませんでしょうか。 何卒よろしくお願い申し上げます。 --- ## 回答 (8件) ### hamee_sys — 2019/06/06 下記の点のご確認をお願いいたします。 -新しく発行されたaccess_token & refresh_tokenがアプリ側で正しく保持されているか -バッチ処理が並列で行われていないか ※並列にて処理されている場合、access_tokenの更新が走った際に後続のバッチにてエラーが発生します。 ### atsushi0843（質問者） — 2019/06/06 早速のご返信ありがとうございます。 -新しく発行されたaccess_token & refresh_tokenがアプリ側で正しく保持されているか ⇒保持したaccess_token&refresh_tokenで通常は正しくAPIにアクセスできており、access_tokenが切れた際も、通常は新しいaccess_tokenをもらえています。 　エラーが発生する際も、同じaccess_token&refresh_tokenで一回前にはアクセスに成功しています。 -バッチ処理が並列で行われていないか ※並列にて処理されている場合、access_tokenの更新が走った際に後続のバッチにてエラーが発生します。 ⇒一台のサーバで一日おきにcronで実行しているだけであり、並列処理はされていないはずです。 一日おき(以前は一時間おき)に実行しており、ちょうどaccess_tokenが切れる瞬間にアクセスすることになるのですが、それは良く無かったりしますでしょうか。 ### hamee_sys — 2019/06/07 >一日おき(以前は一時間おき)に実行しており、ちょうどaccess_tokenが切れる瞬間にアクセスすることになるのですが、それは良く無かったりしますでしょうか。 トークンが更新されるタイミングであったとしても、新しく発行されたアクセストークンおよびリフレッシュトークンを確実に保持していれば、まったく問題はございません。 記載されている内容からは、問題となるような仕様は特に見つかりません。 恐れ入りますが、ソースコードに不備がないか再度ご確認いただけますでしょうか。 ### atsushi0843（質問者） — 2019/06/10 ソースを確認いたしましたが、今のところ特に不備は見つけられませんでした。 例えば時系列で書きますと、 ・2019-06-02 00:00:01 　　古いaccess_tokenは2019-06-01 00:00:02で切れており、 　　access_token[A](期限2019-06-03 00:00:01) 　　refresh_token[B](期限2019-06-05 00:00:01)を取得 ・2019-06-03 00:00:01 　　access_token[A](期限2019-06-03 00:00:01) 　　refresh_token[B](期限2019-06-05 00:00:01)で認証 ・2019-06-04 00:00:01 　　access_token[A]は切れているがrefresh_token[B]は有効のはずだが、 　　エラーコード002002[access_token[A]が不正です。]が発生 　　 となることがあります。 refresh_tokenが間違っているとこうなるのかもと思いますが、 通常は同じパターンで新しいaccess_tokenが発行されているので、 refresh_tokenも正しく渡せているはずなのですが・・・ クローズドでID等お伝えすれば、ログから原因等調査してもらうことは可能でしょうか。 ### wingbell — 2019/06/11 相乗り失礼いたします。 私も全く同様の症状で困っており、投稿しようとしたところこのスレッドを見つけました。 Google Apps Scriptで1日1回APIにアクセスしてアクセストークンとリフレッシュトークンを受け取り、 その値を保持して翌日のアクセスに保持した値を使用しているのですが atsushi0843様の昨日の投稿と同様の事象が起きております。 まだn=2ではありますが、調査いただければ幸いです。 何卒よろしくお願い致します。 ### hamee_sys — 2019/06/11 atsushi0843様　wingbell様 承知いたしました。こちら調査させていただきますので、お手数ですが下記の情報を非公開投稿にて、頂戴できますでしょうか。 -７桁の企業ID -トークン情報を含むエラー発生時のリクエストおよびレスポンス 何卒よろしくお願いいたします。 ### atsushi0843（質問者） — 2019/06/18 非公開投稿にてご対応いただき(恐らく)解決いたしましたので、情報共有させていただきます。 一回のスクリプト実行で「/api_v1_receiveorder_base/search」で対象伝票を検索した後 「 /api_v1_receiveorder_base/search」で伝票詳細を取得していましたが、 トークンの更新を「/api_v1_receiveorder_base/search」でしか行っていなかったのが原因でした。 アクセストークンの期限切れギリギリのタイミングでのアクセスでしたので、 ほぼ同時に二回APIを叩いて一回目は有効期限内、二回目は有効期限切れで新しいトークンが発行されるケースが稀にありましたが、 一回目しかトークン更新の処理を入れていなかったため、二回目の新しいトークンを取りこぼしていたということです。 初歩的なミスでお恥ずかしい限りですが、情報共有まで。。。 ### wingbell — 2019/06/18 >atsushi0843様 officialに調査いただきこちらは解決しましたので、 同じケースかわかりませんが他の方も参照できるようこちらに記載させていただきます。 投稿を引用させていただき説明します。 //////////////////////////////////////////////////////// ・2019-06-02 00:00:01 　　古いaccess_tokenは2019-06-01 00:00:02で切れており、 　　access_token[A](期限2019-06-03 00:00:01) 　　refresh_token[B](期限2019-06-05 00:00:01)を取得 ・2019-06-03 00:00:01 　　access_token[A](期限2019-06-03 00:00:01) 　　refresh_token[B](期限2019-06-05 00:00:01)で認証 ・2019-06-04 00:00:01 　　access_token[A]は切れているがrefresh_token[B]は有効のはずだが、 　　エラーコード002002[access_token[A]が不正です。]が発生 //////////////////////////////////////////////////////// 6/3の認証が有効期限と全く同時刻な点はこちらでは未検証ですが 仮にaccess_tokenの期限は切れていたとします。 このとき、access_token、refresh_tokenが共に更新されます。 私も勘違いしていたのですが、refresh_tokenも更新されて値も有効期限も変わっています。 よって、以前のrefresh_tokenが有効期限内だったとしても 6/4にアクセスした際にはエラーになります。 仮に6/3の認証時にはaccess_tokenは有効期限内だった場合で、 6/4にエラーになるということであれば 6/3の認証から6/4までの間にAPIにアクセスするプログラムはなかったでしょうか。 一度でもアクセスがあればaccess_tokenは期限切れのためtokenの更新が走ってしまい 上記と同じ理由で6/4にアクセスした際にエラーになります。 APIにアクセスするすべてのプログラムで毎回tokenの戻り値を取得するようにして どこか1箇所に常に最新の値を保持しておき、その値を使用することで回避できるかと思います。 [追記] コメントされているのに気づかず投稿してしまいました。 やはりお互い原因は同じだったようですね。 初回投稿いただいたおかげでこちらも解決につながりました。 ありがとうございました。 --- # PHP新SDKの使い方 URL: https://developer.next-engine.com/questions/1192/ **投稿者:** 齊藤 勇也　**日時:** 2019/06/07 **カテゴリ:** 開発環境・SDKについて [https://developer.next-engine.com/tutorial/sample-fuelphp/api-beginning](https://developer.next-engine.com/tutorial/sample-fuelphp/api-beginning)内の指示に従ってvagrantをインストールし、 クライアントIDとクライアントシークレットをfuel/app/config/nextengine.phpに記述してauth/loginを実行してもエラーが帰ってきてしまいます。 おそらくSDKのバージョンが古いのが原因だと思うのですか、vagrant内に新SDKを展開する方法を教えていただきたいです。 または新SDKのインストールマニュアルを頂きたいです。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/06/18 連絡が遅れてしまい申し訳ありません。 PHP新SDKは下記のリンクを参照くださいませ。 [https://github.com/hamee-dev/sdk-php](https://github.com/hamee-dev/sdk-php) --- # 汎用店舗のPayPay対応について URL: https://developer.next-engine.com/questions/1193/ **投稿者:** 村山　大　**日時:** 2019/06/07 **カテゴリ:** その他 お世話になります。 汎用店舗のPayPay対応について、ご確認させて下さい。 汎用店舗の支払方法に、「PayPay全額払い」の対応予定はありますでしょうか？ また、対応予定が無い場合、別システムから「PayPay全額払い」で連携されるようなデータについては「PayPay残高払い」で対応するのが妥当でしょうか？ ※運用面を含めてのご質問になりますので、問い合わせ先として妥当でない場合はご教示頂きたくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 恐れ入りますが、こちらはメイン機能の質問ですので、サポートまでご連絡いただけますでしょうか。 よろしくお願いいたします。 --- # 店舗・販売チャネル別ご対応について URL: https://developer.next-engine.com/questions/1194/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 店舗別在庫管理のご対応は可能でしょうか。 また、販売チャネル別に個別割り当ては可能でしょうか。(例：楽天市場、ECカートA、ECカートB、ヤフーショッピングなど) もしできないのであれば、すべての販売チャネルの在庫を管理するような認識でしょうか。 ご回答の方、宜しくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2019/06/11 店舗ごとに指定在庫数の設定をしていただくことができます。 メイン機能に関して、ご不明な部分がございましたら、サポートまでご連絡お願いいたします。 ### jhbok（質問者） — 2019/06/12 ご返信ありがとうございます。 恐れ入りますが、サポートのURLなどの情報を頂けますでしょうか。 ### hamee_sys — 2019/06/18 ログイン後にトップ画面左の「お問い合わせ」より、お問い合わせいただけます。 [https://base.next-engine.org/inquiries/](https://base.next-engine.org/inquiries/) --- # ネクストエンジンへアクセスするIP制限 URL: https://developer.next-engine.com/questions/1195/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンにアクセスできるIP登録を事前に登録するような形でしょうか。 ネクストエンジン側からECカートへデータ転送時に決まったIPはありますでしょうか。 ご回答の方、宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 IPを登録する必要はございません。 またデータ転送時のIPも限定されません。 --- # 連動コード URL: https://developer.next-engine.com/questions/1196/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンとの連動のために必要なコードはどのようになりますでしょうか。 例)ログインID、パスワード、店舗番号など ご回答の方、宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 認証のために、IDとパスワード、そしてAPI連携のためにクライアントID、クライアントシークレットは最低限必要となります。 クライアントID、クライアントシークレットはアプリを作成されたときに発行されます。下記の記事を参照ください。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) [https://developer.next-engine.com/api/auth](https://developer.next-engine.com/api/auth) --- # 最大呼び出し件数について URL: https://developer.next-engine.com/questions/1197/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 一回に検索呼び出しできる最大件数はどのようになりますでしょうか。 例)注文〇件など ご回答の方、宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 10000件でございます。 --- # 法人・個人に対しての利用有無について URL: https://developer.next-engine.com/questions/1198/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて アプリの開発するのに法人ではないといけないとかという制限はありますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 ございません。個人の方でもアプリ開発はしていただけます。 --- # ネクストエンジン側のご相談受付ページについて URL: https://developer.next-engine.com/questions/1199/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** その他 ネクストエンジンを利用したいお客様のための別途のご相談受付ページは別途にありますでしょうか。 (お客様からお問合せが入った場合、ご案内できるページなど) --- ## 回答 (1件) ### hamee_sys — 2019/06/11 下記のリンクを参照くださいませ。 [https://next-engine.net/anything-consulting](https://next-engine.net/anything-consulting) --- # ネクストエンジン利用者の確認について URL: https://developer.next-engine.com/questions/1200/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンの利用中のショップ様に対して認証するのは可能でしょうか。 (ECカートから特定のショップ様がネクストエンジンに登録しているのかを確認できるAPIがありますでしょうか。) --- ## 回答 (1件) ### hamee_sys — 2019/06/11 ショップ様がネクストエンジン へ登録しているかを確認できるAPIはございません。 しかしネクストエンジン連携アプリでは、利用時に認証が必須であり、ネクストエンジンサーバーにて認証がおこなわれます。 --- # 注文データ登録時に受注状態区分について URL: https://developer.next-engine.com/questions/1201/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 注文ステータスを空欄にしておく場合、どのようになりますでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2019/06/11 こちらはメイン機能の質問となりますので、恐れ入りますがサポートまでご連絡お願いいたします。 ### jhbok（質問者） — 2019/06/12 CSVなどの登録ではなくAPIを通しての注文登録時についてのお問い合わせです。 注文状態が空欄の場合、エラーが発生するのでしょうか。 再度、ご確認お願い致します。 ### hamee_sys — 2019/06/19 注文状態が空欄の場合、エラーは発生しません。 --- # 注文が入った場合の注文ステータスについて URL: https://developer.next-engine.com/questions/1202/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 注文が入って在庫がある商品は次の条件に合わない場合(確認待ち・在庫待ち・発売日時待ち)、別途の処理なしに印刷日待ステータスに変更になりますでしょうか。 また、確認待ち・在庫待ち・発売日時待ちステータスになっていて、各条件が処理されたら自動的に印刷日待ステータスに変更されるのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 こちらはメイン機能の質問なりますので、恐れ入りますがサポートまでご連絡お願いいたします。 --- # 入金待ち注文ステータスについて URL: https://developer.next-engine.com/questions/1203/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 入金待ちステータスからネクストエンジンから入金登録処理をする時やAPIを通して入金処理通知をした時、一般的に印刷日待ステータスに変更されますでしょうか。 (確認待ち、在庫待ち、発売日待の条件に合わない場合) --- ## 回答 (1件) ### hamee_sys — 2019/06/11 こちらはメイン機能の質問となりますので、恐れ入りますがサポートまでご連絡お願いいたします。 --- # APIを通して注文ステータスのアップデートについて URL: https://developer.next-engine.com/questions/1204/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて APIを通して注文ステータスのアップデートは可能でしょうか。 例）印刷完了→確認待ち 　　確認待ち→発送完了 --- ## 回答 (1件) ### hamee_sys — 2019/06/11 下記のように一部のステータスに関して更新が可能です。 受注伝票納品書印刷済み(エンドポイント /api_v1_receiveorder_base/receipted)　印刷済み状態へ 受注伝票出荷確定処理(エンドポイント /api_v1_receiveorder_base/shipped)　出荷済み状態へ 確認待ち→発送完了につきましては、受注伝票更新(エンドポイント /api_v1_receiveorder_base/update)の確認チェック区分の更新にて状態が遷移できます。 注意事項としまして、前の状態へ遡るような、APIの提供はございません。 --- # 注文ステータスの処理順番について URL: https://developer.next-engine.com/questions/1205/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 注文ステータスは必ず決まった順番で処理されますでしょうか。 例）印刷日待→印刷待ち→印刷完了 もしくは、一部のステータスをスキップしてアップデートできるのでしょうか。 例）印刷日待→印刷完了または印刷待ち→発送中 --- ## 回答 (1件) ### user1125 — 2019/06/13 自動判別でスキップもありえます。 --- # APIを通して注文ステータスのアップデートについて URL: https://developer.next-engine.com/questions/1206/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて APIを通して確認待ちステータスの注文を次のステップ(印刷日待など)に変更したい場合、注文ステータスを印刷日待にアップデートしてから転送する認識で問題ないでしょうか。 もしくは確認チェックなどの別途に送らなきゃいけないステータス値がありますでしょうか。 --- ## 回答 (2件) ### user1125 — 2019/06/13 確認チェック区分 receive_order_confirm_check_id=2（確認済み）で更新してください。 ### hamee_sys — 2019/06/20 ＞APIを通して確認待ちステータスの注文を次のステップ(印刷日待など)に変更したい場合 receive_order_confirm_check_id=1　にて更新ください。 参照時は、user 1125様がおっしゃるように、確認チェック区分 receive_order_confirm_check_id=2（確認済み)になっているかを確認していただく必要がございます。 大変恐縮ですが、参照時と更新時の仕様が違うため、ご注意くださいませ。 参照時： 0:確認不要 1:確認必要 2:確認済み 更新時： 0：確認待ちのチェックを外す　 1：確認街のチェックをつける --- # 注文商品の追加について URL: https://developer.next-engine.com/questions/1207/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 注文商品を追加する場合、受注伝票更新を通して商品を追加する認識で問題ないでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 はい、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) に明細追加のサンプルがございます。 --- # 入金完了時にデータ転送有無について URL: https://developer.next-engine.com/questions/1208/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 入金完了処理時、注文ステータス区分はどのステータスに転送するのでしょうか。 その注文は入金待ちステータスなっていると存じますが、order_status_idは入金待ちにしておいてreceive_order_deposit_dateをアップデートして転送する認識で問題ないでしょうか。 もしくはorder_status_idを別の値で転送するのでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 入金状況区分 receive_order_deposit_type_id = 2 (入金済み)で更新してください。 --- # 配送完了処理について URL: https://developer.next-engine.com/questions/1209/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 商品hが配送完了になった場合、自動的に配送完了ステータスになるのでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 はい、そうです。 --- # 交換について URL: https://developer.next-engine.com/questions/1210/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンから交換処理を行う時の流れを次のURLで確認しました。 [https://manual.next-engine.net/faq/received-order/10807/](https://manual.next-engine.net/faq/received-order/10807/) この時、「ステータスが[出荷済み]かつ商品発送済み」ステータスについて[メニュー>ドキュメント作業>コピー作業から「受注伝票情報」をコピー>]手続きをAPIで処理するには、どのAPIで処理するのでしょうか。 商品登録またはアップデートAPIを利用して、新規商品のように登録して処理するのでしょうか。 上記のようにできないのであれば、アップデートAPIを利用してその注文の注文ステータスを「印刷日待」ステータスに変更後、交換する商品を新規追加して既存商品をキャンセル処理する流れで問題ないでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 複写のAPIは無いので、こちらのAPIで新規作成して頂く必要があります。 --- # 在庫の割り当てするタイミングについて URL: https://developer.next-engine.com/questions/1211/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 注文に在庫が割り当てされるタイミングはいつでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 引き当て処理を実行するバッチ処理が一定の間隔で常に動いています。 --- # 受注伝票コピーについて URL: https://developer.next-engine.com/questions/1212/ **投稿者:** jhbok　**日時:** 2019/06/09 **カテゴリ:** ネクストエンジンAPIについて 受注伝票コピー時にコピーされる範囲はどのようになりますでしょうか。 例）注文番号、商品リストなど --- ## 回答 (2件) ### hamee_sys — 2019/06/11 受注伝票コピー時とはどのようなタイミング、形式を想定されていらっしゃいますでしょうか。 ### jhbok（質問者） — 2019/06/11 [https://manual.next-engine.net/faq/received-order/10807/](https://manual.next-engine.net/faq/received-order/10807/) 商品が出荷された後、交換を行う場合です。 既存商品を返品処理して受注伝票をコピーして処理しないといけないですが、 この際にどの情報(範囲)までコピーできるのかを確認して、それを基準に弊社のECカートシステムと連動をしようと考えております。 お手数をおかけしますが、ご回答宜しくお願い致します。 --- # 受注処理について URL: https://developer.next-engine.com/questions/1213/ **投稿者:** jhbok　**日時:** 2019/06/11 **カテゴリ:** ネクストエンジンAPIについて 受注ステータス処理についてご質問があります。 下記の内容ご確認お願いできますでしょうか。 1．注文データ登録時に受注状態区分を空欄にした時どのようになりますでしょうか。 2．注文商品が在庫のある場合、条件(確認待ち・割当待ち・発売日待ち)に合わないのであれば、別途の処理なしで印刷日待ちステータスになるのでしょうか。 また、確認待ち・割当待ち・発売日待ちステータスの注文が処理されたら自動的に印刷日待ちステータスになるのでしょうか。 3．ネクストエンジン側から入金登録([https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_stat...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_status-shori/10230/))処理をする又はAPIを通して入金処理通知をした場合、 一般的に入金待ちステータスから印刷日待ちステータスになるのでしょうか。 (確認待ち・割当待ち・発売日待ちの条件に合わない場合) 4．APIを通して受注ステータス変更の制限はないでしょうか。 例）印刷済み→確認待ち 　　確認待ち→発送済み 5．受注ステータスは必ず決まった順番に変更されるのでしょうか。 例）印刷日待ち→印刷待ち→印刷済み それとも一部ステータスをスキップして変更することも可能でしょうか。 例）印刷日待ち→印刷待ち or 印刷済み→発送中 6．APIを通して確認待ちステータスの受注を次のステップ(印刷日待など)に変更したい場合、 受注ステータスを「印刷日待」にアップデートして転送する認識で問題ないでしょうか。 それとも別途の確認チェックなどの必ず転送するステータス値が存在するのでしょうか。 少し多いですが、ご確認お願い致します。 --- ## 回答 (1件) ### user1125 — 2019/06/13 1．注文データ登録時に受注状態区分を空欄にした時どのようになりますでしょうか。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 注文登録時に受注状態を指定することはできません。 2．注文商品が在庫のある場合、条件(確認待ち・割当待ち・発売日待ち)に合わないのであれば、別途の処理なしで印刷日待ちステータスになるのでしょうか。 また、確認待ち・割当待ち・発売日待ちステータスの注文が処理されたら自動的に印刷日待ちステータスになるのでしょうか。 各条件をクリアし、印刷日の指定がなければ自動的に印刷待ちになります。 3．ネクストエンジン側から入金登録([https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_stat](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_stat)...)処理をする又はAPIを通して入金処理通知をした場合、 一般的に入金待ちステータスから印刷日待ちステータスになるのでしょうか。 (確認待ち・割当待ち・発売日待ちの条件に合わない場合) 入金済みになれば、ステータスは自動で進みます。 4．APIを通して受注ステータス変更の制限はないでしょうか。 例）印刷済み→確認待ち 　　確認待ち→発送済み ステータスは自動で進みます。 5．受注ステータスは必ず決まった順番に変更されるのでしょうか。 例）印刷日待ち→印刷待ち→印刷済み はい。条件から外れれば、戻ることもあります。 在庫の無い商品を追加すれば引き当て待ちに戻ります。 それとも一部ステータスをスキップして変更することも可能でしょうか。 例）印刷日待ち→印刷待ち or 印刷済み→発送中 自動判別ですので更新することはできません。 6．APIを通して確認待ちステータスの受注を次のステップ(印刷日待など)に変更したい場合、 受注ステータスを「印刷日待」にアップデートして転送する認識で問題ないでしょうか。 それとも別途の確認チェックなどの必ず転送するステータス値が存在するのでしょうか。 ステータスの変更は自動ですのでできません。 --- # 受注に商品追加する時について URL: https://developer.next-engine.com/questions/1214/ **投稿者:** jhbok　**日時:** 2019/06/11 **カテゴリ:** ネクストエンジンAPIについて 受注に商品を追加する時、「受注伝票更新」を通して追加する認識で問題ないでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 はい、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) こちらにサンプルがございます。 --- # 入金完了時にデータ転送について URL: https://developer.next-engine.com/questions/1215/ **投稿者:** jhbok　**日時:** 2019/06/11 **カテゴリ:** ネクストエンジンAPIについて 入金済み処理時に受注ステータス区分はどのステータスを転送しなければならないでしょうか。 回答の受注は入金待ちステータスになると思いますが、order_status_idは「入金待ち」そのままにしておいて、receive_order_deposit_dateのみアップデートして転送する認識で問題ないでしょうか。 order_status_idはどの値を転送するようになっているのでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 受注ステータスの変更はその伝票の状態に応じて自動で行われますので 入金額 receive_order_deposit_amount 入金状況区分 receive_order_deposit_type_id　こちらを入金済みにすることで受注ステータスが進みます。 入金日 receive_order_deposit_date を更新してください。 --- # 配送完了処理について URL: https://developer.next-engine.com/questions/1216/ **投稿者:** jhbok　**日時:** 2019/06/11 **カテゴリ:** ネクストエンジンAPIについて 配送完了になった時点で自動的に配送完了ステータスになるのでしょうか。 --- ## 回答 (1件) ### user1125 — 2019/06/13 はいそうです。 --- # 伝票作成。 URL: https://developer.next-engine.com/questions/1217/ **投稿者:** マルパパ　**日時:** 2019/06/11 **カテゴリ:** ネクストエンジンAPIについて お疲れ様です。 APIを利用した受注伝票の作成は可能でしょうか。 よろしくお願いします --- ## 回答 (1件) ### user1125 — 2019/06/13 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) こちらのAPIを利用することで可能です。 --- # 検索の場合のリクエスト数のカウント方法について URL: https://developer.next-engine.com/questions/1222/ **投稿者:** postec　**日時:** 2019/06/12 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIで、受注伝票の検索を行う場合で、 検索を1回行い、100件の受注情報を取得する場合、 リクエスト回数のカウントは1回ですか?　それとも100回ですか? --- ## 回答 (1件) ### user1125 — 2019/06/13 1回です。 --- # APIステータス値変更について URL: https://developer.next-engine.com/questions/1223/ **投稿者:** jhbok　**日時:** 2019/06/13 **カテゴリ:** ネクストエンジンAPIについて 1. ECカートからネクストエンジン側に登録されている注文情報を検索する時、 注文状態が変更された注文のみ検索して持ってくることは可能でしょうか。 全ての注文を持ってくることは負荷などの問題が発生するかもしらないからです。 ex) [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) で注文を検索時、 注文状態が変更になった注文のみ検索され、変更のない注文は検索できない方法 2. 「入金待ち」注文を「入金完了」にするには [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) または [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) api　を利用して receive_order_deposit_type_id = 「入金完了」にするのでしょうか。どのように送るのかガイド頂けますでしょうか。 receive_order_deposit_date は「入金完了」になった時間を送れば問題ないでしょうか。 上記2つ値を上記のようにすると「入金完了」状態に変更されるのでしょうか。 3. ECカートにある注文に送り状を採番した時、「印刷待ち」状態であってネクストエンジンに該当情報をアップデートする場合、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted](https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted) APIを利用してアップデートするようなイメージだと存じますが、 配送先：receive_order_delivery_name 送り状：receive_order_invoice_name 2つの情報を利用してアップデートする認識で問題ないでしょうか。 4. ECカートから印刷完了して카트에서 인쇄를に該当情報をアップデートして「印刷済み」状態 に変更する場合、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted](https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted) APIを利用して를アップデートするようなイメージだと存じますが、 該当APIからreceive_order_statement_delivery_instruct_printing_date 値をアップデートしないと適用されないでしょうか。 5. ECカートから商品を発送した後、ネクストエンジンに該当情報をアップデートして「出荷済み」状態に変更する場合、 상태로 변경할 경우 [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) APIを利用して를アップデートするようなイメージだと存じますが、 該当APIから에서 receive_order_send_date 値をアップデートしないと適用されないでしょうか。 6. ECカートにある注文がキャンセルになった場合、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) または [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) apiを利用して receive_order_cancel_type_id 項目をアップデートのであれば、ネクストエンジンでも注文がキャンセルになるのでしょうか。 なお、「配送中」状態ではない場合、いつでもキャンセルできるのでしょうか。 7. ネクストエンジンにある注文情報をECカートにアップデートする時、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 項目を利用してデータを検索した後、 ECカート仕様に合わせて処理する認識で問題ないでしょうか。 それでなければ、各状況に合うAPIが別途であるのでしょうか。 以上、7件ご回答いただけますよう宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/06/27 1.最終更新日を利用して伝票が変更されたかどうかを取得することは可能です。 2. こちらのチケットを参照ください [https://developer.next-engine.com/questions/1208](https://developer.next-engine.com/questions/1208) 3. 受注伝票更新API（[https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update)）をご利用ください。 その際、receive_order_invoice_nameを変更ください。 4.受注伝票納品書印刷済みAPI(/api_v1_receiveorder_base/receipted)を利用ください。 詳しくは 以下の入力パラメータを参照ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted](https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted) 5.受注伝票出荷確定処理API(/api_v1_receiveorder_base/shipped)をご利用ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) 6.>ネクストエンジンでも注文がキャンセルになるのでしょうか。 おっしゃる通りです。 >なお、「配送中」状態ではない場合、いつでもキャンセルできるのでしょうか。 いつでもできます。配送後であってもキャンセルは可能でございます。 7.受注明細検索API(/api_v1_receiveorder_row/search)をご利用ください。 伝票検索APIでは購入明細情報を取得することができません。 --- # Shopify Connection URL: https://developer.next-engine.com/questions/1226/ **投稿者:** rck　**日時:** 2019/06/14 **カテゴリ:** 開発環境・SDKについて What should be the redirect URI if connecting to Shopify? --- # Shopify Connection URL: https://developer.next-engine.com/questions/1227/ **投稿者:** rck　**日時:** 2019/06/14 **カテゴリ:** ネクストエンジンAPIについて Please explain the procedure to connect the shopify inventory with the main function? --- # Shopify Product View URL: https://developer.next-engine.com/questions/1228/ **投稿者:** rck　**日時:** 2019/06/14 **カテゴリ:** その他 Why Shopify products not reflected in the next-engine main menu?After setting up the store through Shopify auto linkage. --- # Shopify Connection URL: https://developer.next-engine.com/questions/1229/ **投稿者:** rck　**日時:** 2019/06/17 **カテゴリ:** 開発環境・SDKについて Hi, installed the Shopify auto linkage application and got the store token, When running the sample PHP SDK API_upload.php getting linkage parameter error. --- # Access Token And Refresh Token URL: https://developer.next-engine.com/questions/1232/ **投稿者:** Soumya　**日時:** 2019/06/20 **カテゴリ:** 開発環境・SDKについて How can I get the Access token and refresh token? --- ## 回答 (1件) ### hamee_sys — 2019/07/03 Theare are 2 ways to get these tokens depending on whether using SDK or not. 1.when using SDK SDK programs automatically get these tokens. Be sure to update these tokens with new one on every API calling 2.when not using SDK 1.get uid, state with the API( [https://base.next-engine.org/users/sign_in/](https://base.next-engine.org/users/sign_in/) ) 2.get tokens using those uid, state through the API( [https://api.next-engine.org/api_neauth/](https://api.next-engine.org/api_neauth/) ) For more detail, see the link below [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) Sincerely yours, --- # （再）アプリの販売形態 が「全ての企業に公開」と「特定企業に公開」の違いについて URL: https://developer.next-engine.com/questions/1240/ **投稿者:** M.Kawano　**日時:** 2019/07/05 **カテゴリ:** ネクストエンジンAPIについて お世話になっております アプリの販売形態 が「全ての企業に公開」と「特定企業に公開」の違いについて 下記事項について、相違点を教えてください。　 ・主な使用用途、 ・システム的な制約事項 ・セキュリティ面等 ※7/5　同一内容で質問していたら本件未掲載お願いします --- ## 回答 (6件) ### hamee_sys — 2019/07/10 ご連絡ありがとうございます。下記の通りです。 ・主な使用用途 特定企業に公開：自社内のシステムと連携して活用 全ての企業に公開：販売用アプリ開発 ・システム的な制約事項 「特定企業に公開」の場合、API利用料がかかってまいります。 ・セキュリティ面等 特定企業に公開：利用許可のあるユーザ・企業のみ利用可能です。 全ての企業に公開：アプリを購入した全てのユーザが利用可能です。 ### M.Kawano（質問者） — 2019/07/12 ご回答ありがとうございます ・セキュリティ面等 全ての企業に公開：アプリを購入した全てのユーザが利用可能です。 　→　アプリの販売金額の設定はどのようになりますでしょうか よろしくお願いいたします ### hamee_sys — 2019/07/18 メインページより 「アプリを作る」->「販売」より初期費用、月額費用を任意に設定していただくことができます。 ### M.Kawano（質問者） — 2019/07/18 回答ありがとうございます メインページより 「アプリを作る」->「販売」より初期費用、月額費用を任意に設定していただくことができます。 →　販売された場合の初期費用、月額費用についてのお支払いはどのようになりますでしょうか 　　　販売手数料等は引かれて、支払いされるのでしょうか ### hamee_sys — 2019/07/23 >販売手数料等は引かれて、支払いされるのでしょうか さようでございます。アプリの売り上げの30%が手数料になります。 ### M.Kawano（質問者） — 2019/07/24 ご回答ありがとうございます。 --- # 商品マスタの消費税項目の取得について URL: https://developer.next-engine.com/questions/1245/ **投稿者:** NSM山　**日時:** 2019/07/12 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 商品マスタの消費税項目のAPIでの取得ですが、商品マスタエンドポイントの検索フィールド内に 存在しないように見受けられますが、現在取得可能でしょうか？ それとも、軽減税率対応までは非公開となっているのでしょうか？ ご教示宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/07/22 軽減税率対応に伴い提供予定はございますが、リリース日などはまだ未定でございます。 リリースされましたらお知らせにも掲載予定でございます。そちらもご確認下さい。 --- # 仕入伝票APIに関して URL: https://developer.next-engine.com/questions/1247/ **投稿者:** ながお　**日時:** 2019/07/13 **カテゴリ:** ネクストエンジンAPIについて 仕入伝票の検索はAPIにて可能ですが仕入伝票管理と同等に作成や入荷数の変更をAPIで行いたいです。 現状、APIのリファレンスにはそういった記述はないですが、記述がないということはAPIでは仕入伝票管理を行うことは出来ないということでしょうか？？ また、もし出来ないのであれば実装の予定などはありますでしょうか？？ よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/07/22 大変恐縮ですが、仕入伝票に関しては検索のみ提供させていただいております。 また更新の予定は現在のところございません。 よろしくお願いいたします。 --- # APIを利用した受注のタグ付けとタグの付いた受注の検索 URL: https://developer.next-engine.com/questions/1248/ **投稿者:** IPL伊藤　**日時:** 2019/07/16 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 表題の件につきまして2点ほどご確認お願い致します。 1.APIを利用して受注番号が100,101,102の受注全てに｢家具｣タグを付与させたい場合、受注伝票更新APIを利用して受注番号に100,101,102のいずれかを持つ受注の｢受注分類タグ｣を｢家具｣に更新する形でよろしいでしょうか。 2.ネクストエンジン側で受注ステータスが｢確認待ち｣かつ｢家具｣タグが付与された受注一覧を取得したい場合、受注伝票検索APIより｢受注状態区分｣が｢確認待ち｣かつ｢受注分類タグ｣に｢家具｣を含む受注を取得する形でよろしいでしょうか。 お手数ではございますが、ご確認のほどよろしくお願い致します。 --- ## 回答 (6件) ### hamee_sys — 2019/07/18 「受注分類タグ」は受注伝票検索APIの検索条件にご使用いただけません。 1.の認識は合っていますが、2.の絞り込みができません。 取得後、プログラムにて絞り込みをかけていただけますでしょうか。 よろしくお願いいたします。 ### IPL伊藤（質問者） — 2019/09/20 上記についてご確認ありがとうございました。 本課題に付随して不明点が出て参りましたので、質問させて頂きます。 1. 「受注分類タグ」によるステータス自動遷移について 下記ページを参照し、「商品分類タグ」による絞り込みでステータスを「確認待ち」に止めることができるとわかったのですが、 「受注分類タグ」によりステータスを「確認待ち」に自動遷移させることは可能でしょうか。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_stat...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_status-shori/12711/) ※基本的には「商品分類タグ」にてステータス自動遷移を行うのが一般的でしょうか。 2. タグの付与タイミングについて 「受注分類タグ」は後から受注伝票一括更新APIで対象受注にて付与する認識ですが、 受注データはどのタイミングで生成されるのでしょうか？ ※EC-CUBE2.12系で運用する予定です。 ### IPL伊藤（質問者） — 2019/09/24 お忙しいところ恐縮ですが、もう1点ご確認お願い頂きたい点が出てまいりましたので質問させて頂きます。 購入時にオプションを選択された場合には備考欄に文言を追加する方針になっております。 そこで、備考欄に特定の文字列を含む場合にステータスを｢確認待ち｣に自動遷移させることは可能でしょうか。 お手数ではございますが、ご確認のほどよろしくお願いします。 ### hamee_sys — 2019/09/26 ＞「受注分類タグ」によりステータスを「確認待ち」に自動遷移させることは可能でしょうか。 「受注分類タグ」による自動遷移はできかねます。「商品分類タグ」をご使用ください。 ＞受注データはどのタイミングで生成されるのでしょうか？※EC-CUBE2.12系で運用する予定です。 受注メールをネクストエンジンが取り込んだタイミングです。 ＞備考欄に特定の文字列を含む場合にステータスを｢確認待ち｣に自動遷移させることは可能でしょうか。 可能です。同様の質問がございましたので、下記をご参照くださいませ。 [https://developer.next-engine.com/questions/1133](https://developer.next-engine.com/questions/1133) 本件はAPIの質問ではございませんので、以降ご不明な点がございましたらサポートまでご連絡ください。 ### IPL石川 — 2019/10/18 上記ご回答頂きありがとうございました。 追加で下記について質問させて頂けますでしょうか。 >> 2. タグの付与タイミングについて >> 「受注分類タグ」は後から受注伝票一括更新APIで対象受注にて付与する認識ですが、 >> 受注データはどのタイミングで生成されるのでしょうか？※EC-CUBE2.12系で運用する予定です。 > 受注メールをネクストエンジンが取り込んだタイミングです。 こちらについて、ネクストエンジン側で受注生成後、なるべくリアルタイムで受注分類タグを付与しようと考えておりましたが、 メールを送信してからネクストエンジン側に受注が生成されるまでにタイムラグがあることがわかり、 EC-CUBEからネクストエンジンに受注メール送信後、すぐに受注更新APIを実行して受注分類タグが付与できずにおります。 ※受注メール送信後、3秒ほどsleep処理を挟むと実行できていることが確認できました。 こちら他社様などで同様のお問い合わせなどございましたら、実装方法を参考にさせて頂きたいです。 例えば、ネクストエンジンで受注生成完了時に通知を送信する機能などはございますでしょうか。 ご確認の程、よろしくお願いいたします。 ### hamee_sys — 2019/10/30 受注メールの取り込みはあくまで在庫を引き当てるためのもので これはモール側でキャンセルの可能性がある「仮受注伝票」と考えることができます。 上記のため、受注メール取り込み後に通知する仕組みはございません。 --- # 伝票の操作履歴について URL: https://developer.next-engine.com/questions/1252/ **投稿者:** NSN　**日時:** 2019/07/23 **カテゴリ:** ネクストエンジンAPIについて 平素よりお世話になっております。 1点ご質問させてください。 伝票の操作履歴はAPIから取得することは可能でしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/07/23 伝票の操作履歴はAPIで取得することはできかねます。 よろしくお願いいたします。 --- # エラーについて URL: https://developer.next-engine.com/questions/1253/ **投稿者:** masaki　**日時:** 2019/07/23 **カテゴリ:** 開発環境・SDKについて [https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4](https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4) 上記の内容通りに進めましたがファイル読み込み時にでエラーが出てしまいます。 API通信でエラーが発生しました。以下詳細 code: 001011 message: POSTパラメータにclient_id,client_secretが指定されていません。 [https://developer.next-engine.com/api/param/message](https://developer.next-engine.com/api/param/message) こちらを確認すると古いバージョンのSDKの可能性があるとのことですが、最新版はこちら以外のところにありますでしょうか。 [https://github.com/hamee-dev/sdk-php](https://github.com/hamee-dev/sdk-php) ご教授頂ければと思います。 宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/08/08 いただきましたgithubのリンクが最新版でお間違いありません。 下記の通り進められたとのことですが、こちらはバージョンが古い可能性があります。 最新のソースコードのREADME.mdを参考に構築ください。 [https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4](https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4) --- # 入荷予定/入荷完了処理について URL: https://developer.next-engine.com/questions/1257/ **投稿者:** sh.sato　**日時:** 2019/07/26 **カテゴリ:** ネクストエンジンAPIについて (実現したいこと) 1.WMSに商品の入荷予定を渡したい。 2.WMS入荷済み情報をネクストエンジンに戻したい。 (確認したいこと) 1.について仕入伝票/仕入明細検索APIを使用することを考えています。 　supply_order_row_completed_flag="0"を入荷予定と判断でよろしいでしょうか? 　また仕入明細検索APIで検索できるようになるタイミングは発注伝票登録直後と 　なるでしょうか? 2.について仕入明細のsupply_order_row_completed_flagを"1"(完了)になる為には 　商品マスターアップロードAPIで在庫数を増やせば良いのでしょうか? 以上、よろしくお願いします。 --- ## 回答 (4件) ### hamee_sys — 2019/08/08 重複の質問のためクローズいたします。 [https://developer.next-engine.com/questions/1269](https://developer.next-engine.com/questions/1269) ### 佐藤陽一郎 — 2020/03/02 以下のURLがアクセス許可されていないので確認できません。 [https://developer.next-engine.com/questions/1269](https://developer.next-engine.com/questions/1269) お手数ですが回答は確認できませんでしょうか。 ### 佐藤陽一郎 — 2020/03/02 以下のURLがアクセス許可されていないので確認できません。 [https://developer.next-engine.com/questions/1269](https://developer.next-engine.com/questions/1269) お手数ですが回答は確認できませんでしょうか。 ### hamee_sys — 2020/03/02 大変失礼いたしました、公開設定させていただきました。 ご確認くださいませ。 --- # ＳＤＫからお客様環境への接続 URL: https://developer.next-engine.com/questions/1265/ **投稿者:** 萩原孝之　**日時:** 2019/08/01 **カテゴリ:** ネクストエンジンAPIについて ＳＤＫからお客様の本番環境へ接続する際の設定を教えてください。 client_id、client_secretは開発環境の本番ＡＰＩより転記でよろしいでしょうか。 お客様の本番環境への接続は、お客様がネクストエンジンへログインした状態でＳＤＫ（ＰＨＰ）を起動すればよいのでしょうか。 お手数をおかけいたしますが、ご回答を宜しくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/08/05 以下の２点がまず完了しているか、ご確認いただけますでしょうか。 ・アプリの本番申請 ・審査完了後、販売開始ボタンの押下 完了されている場合、本番環境のclient_id、client_secretに書き換えていただくことでご利用いただくことができます。 --- # 【出荷確定処理時】receive_order_last_modified_dateのエラー URL: https://developer.next-engine.com/questions/1267/ **投稿者:** 榊間　浩人　**日時:** 2019/08/05 **カテゴリ:** ネクストエンジンAPIについて 【対象のAPIのパス】 /api_v1_receiveorder_base/shipped 【言語・SDK使用の有無】 SDK使用なし 言語: Ruby 以下のパラメータで実行を行うとエラーが発生します。 ・INPUT receive_order_id = 10 receive_order_last_modified_date = 2019-08-05 00:00:00 ・結果 {"result"=>"error", "code"=>"009004", "message"=>"receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。", "request_id"=>"", "access_token"=>"xxx", "access_token_end_date"=>"xxx", "refresh_token"=>"xxx", "refresh_token_end_date"=>"xxx"} すでに存在する受注に対して出荷の確定処理を行いたいのですが、エラーが発生します。 どういった場合に上記のようなエラーが発生するのでしょうか。また、このエラーを回避するにはどうすれば良いでしょうか。 ご回答お願い致します。 --- ## 回答 (1件) ### hamee_sys — 2019/08/08 エラーを出さないためには受注伝票を検索いただき、最新のreceive_order_last_modified_dateを取得していただく必要があります。 取得後再度出荷処理APIを実行ください。 --- # 受注伝票出荷確定処理APIについて URL: https://developer.next-engine.com/questions/1269/ **投稿者:** sh.sato　**日時:** 2019/08/07 **カテゴリ:** ネクストエンジンAPIについて 受注伝票出荷確定処理(/api_v1_receiveorder_base/shipped)の仕様について教えて下さい。 <実現したいこと> WMS連携アプリを開発しています。WMSに受注情報を渡し、WMSで出荷が完了したらNEのデータを更新したいです。 <質問> 利用するAPIは受注伝票出荷確定処理だと思いますが、伝票番号(receive_order_id)と 最終更新日(receive_order_last_modified_date)渡すことでその伝票番号の 受注状態区分(receive_order_order_status_id)は50(出荷済み)に、伝票番号の明細商品の在庫数は減数される 仕様でしょうか? --- ## 回答 (2件) ### hamee_sys — 2019/08/08 ＞利用するAPIは受注伝票出荷確定処理だと思いますが、 さようでございます。受注伝票出荷確定処理APIをご利用ください。 ＞伝票番号(receive_order_id)と 最終更新日(receive_order_last_modified_date)渡すことでその伝票番号の 受注状態区分(receive_order_order_status_id)は50(出荷済み)に、伝票番号の明細商品の在庫数は減数される 仕様でしょうか? こちらの認識もお間違いございません。 ### sh.sato（質問者） — 2019/08/08 了解しました。 どうもありがとうございました。 --- # 楽天注文のクーポン利用金額・購入者住所情報・電話番号について URL: https://developer.next-engine.com/questions/1270/ **投稿者:** 株式会社コマース２１　**日時:** 2019/08/07 **カテゴリ:** ネクストエンジンAPIについて 以下の環境でSDKを利用し、受注の取込の開発を行っております。 環境:java(SDK利用) ネクストエンジン:メイン機能(テスト環境) 受注取込元モール:楽天RMS(テスト環境) 以下の流れでネクストエンジンに注文を取込、SDKを利用した受注伝票検索APIにて、注文を取り込みました。 ①RMSにて店舗発行型クーポンを利用して注文確定 ②ネクストエンジンメイン機能に該当注文を自動取込 ③SDKを利用した受注伝票検索APIにて、該当の伝票の情報を取得 質問1 ③で、受注伝票オプションの「receive_order_option_received_time_shop_coupon(受注時店舗原資クーポン)」か、「receive_order_option_received_time_mall_coupon(受注時モール原資クーポン)」に、 クーポン利用金額が設定されて取得出来る事を期待していたのですが、何れも「0.00」が設定されて返ってきました。 クーポンの金額が、返却されるdataのどの項目に設定されているのかが不明です。 そもそもAPIではクーポン利用金額は取得出来ないのでしょうか。 質問2 RMS注文時は、購入者情報として、購入者住所の都道府県・市区町村、及び電話番号が設定されているのですが、 ②のネクストエンジン注文自動取込の時点で、住所は「住所1」に都道府県のみしか存在せず、電話番号は取込まれておりませんでした。(ネクストエンジンメイン機能の伝票確認画面にて確認) そのため、③で、受注伝票検索の「receive_order_purchaser_address1(購入者住所1)」には都道府県しか設定されておらず、 「receive_order_purchaser_address2(購入者住所2)」と「receive_order_purchaser_tel(購入者電話番号)」には値が設定されておりませんでした。 何故、メイン機能への取込際に住所情報や電話番号の情報が欠落するのでしょうか。 ②のネクストエンジン自動取込の時点で、取り込む受注情報の項目等を設定する箇所があるのでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2019/08/08 クーポン金額は他費用（receive_order_other_amount）に入ります。 詳しくは下記のページを参照ください。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_rak) ### 株式会社コマース２１（質問者） — 2019/08/08 ご回答ありがとうございます。 >クーポン金額は他費用（receive_order_other_amount）に入ります。 確認致しましたが、「他費用（receive_order_other_amount）」にもクーポン金額は入っておりませんでした。 そもそも、メイン機能の受注伝票画面に表示されている「他費用」の項目にも値が入っていない状態でした。 使用しているクーポンはRMSの店舗発行型クーポンになります。 メイン機能のマニュアルを確認致しましたところ、店舗発行型クーポンは、「カスタムデータ作成アプリのみで出力可能」との記載がございました。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_rakuten/6298/) つまり、受注伝票APIではRMS店舗発行型クーポン金額は取得出来ず、カスタムデータ作成アプリを利用し、CSV出力する以外に方法は無いという事でしょうか。 お手数ですが、今一度ご確認をお願い致します。 >詳しくは下記のページを参照ください。 >[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori)... リンク先が404になっております。 また、質問2に関しましてもご確認頂けますと幸いです。 ### hamee_sys — 2019/08/14 ＞リンク先が404になっております。 大変失礼いたしました。正しくはこちらでございます。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_rakuten/6298/) ②に関しましては、メイン側の質問のため、こちらでは対応いたしかねます。恐れ入りますが、サポートまでご連絡くださいませ。案内が漏れていた旨お詫びもうしあげます。 --- # 在庫連携について URL: https://developer.next-engine.com/questions/1271/ **投稿者:** 西田太郎　**日時:** 2019/08/08 **カテゴリ:** ネクストエンジンAPIについて 各店舗への在庫連携はAPIからは設定できないそうですが、 指定商品が在庫連携（どの店舗に）されているかを確認するAPIはありますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/08/14 ＞おそれいりますが、在庫連携がされたかを確認するAPIの用意はございません。 --- # api呼び出し回数について URL: https://developer.next-engine.com/questions/1272/ **投稿者:** 川下　啓朗　**日時:** 2019/08/08 **カテゴリ:** ネクストエンジンAPIについて APIの1か月の呼び出し回数が5000回を超えているようです。 自動で1日に1回とあとは手動で数回/日の実行です。 呼び出し回数ののカウント方法が知りたいです。 --- ## 回答 (1件) ### hamee_sys — 2019/08/14 APIコール１回あたり１カウントです。記載の通りのコール数では5000回を超えることはありえませんので、 リトライ処理や処理の中でAPIのコールをループで回していないかをログなどを基にご確認くださいませ --- # 出荷指示データの消費税対応について URL: https://developer.next-engine.com/questions/1276/ **投稿者:** M.Kawano　**日時:** 2019/08/19 **カテゴリ:** その他 お世話になっております ①出荷指示データについては、商品毎の税率は追加されないのでしょうか？ ②税率が追加されない場合、商品の軽減税率判定はどのように行えばいいでしょうか？ よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/08/21 軽減税率については、ネクストエンジンにても対応予定でございます。 詳細についてはまだはっきりとしたことは申し上げられません。 お知らせにて告知させていただきますので、いましばらくおまちくださいませ。 --- # 商品画像のアップロードAPIについて URL: https://developer.next-engine.com/questions/1285/ **投稿者:** 森本望　**日時:** 2019/08/29 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 商品登録の際に画像も含めてAPIを経由して登録したいと思っています。 リファレンスを探した限り画像をアップロードするAPIを見つけられなかったのですが、公開されていますでしょうか？ 何か画像のアップロードをAPIを経由してやるにはどのように行えばよろしいでしょうか？ よろしくお願いします --- ## 回答 (2件) ### hamee_sys — 2019/09/04 大変恐縮ですが、APIを経由しての画像のアップロード機能の提供はございません。 ### 森本望（質問者） — 2019/09/04 ありがとうございます 外部ネットワークから見れる場所に画像を置いて、image_url_httpにそのURLを指定してネクストエンジン側にダウンロードすることでできました。 --- # 受注状態区分の「確認待ち」について URL: https://developer.next-engine.com/questions/1287/ **投稿者:** 株式会社コマース２１　**日時:** 2019/08/30 **カテゴリ:** ネクストエンジンAPIについて メイン機能の受注状態が「確認待ち」と「印刷待ち」の受注のみをAPIを利用して取込みたいです。 受注状態区分(order_status_id)は以下の区分値が用意されていますが、 メイン機能側の「確認待ち」「印刷待ち」にあたるステータスは以下のどれでしょうか。 {order_status_id=0, order_status_name=取込情報不足}, {order_status_id=1, order_status_name=受注メール取込済}, {order_status_id=2, order_status_name=起票済(CSV/手入力)}, {order_status_id=20, order_status_name=納品書印刷待ち}, {order_status_id=30, order_status_name=納品書印刷中}, {order_status_id=40, order_status_name=納品書印刷済}, {order_status_id=50, order_status_name=出荷確定済（完了）} メイン機能側の受注状態と、APIの受注状態区分に差があるため、マッピング定義等がありましたら併せてご教示下さい。 --- ## 回答 (3件) ### hamee_sys — 2019/09/04 以下の条件になります [確認待ち] receive_order_order_status_id = 2 ・・・起票済(CSV/手入力)} 　かつ receive_order_confirm_check_id = 1 ・・・確認必要 [印刷待ち] 　receive_order_order_status_id = 20 　・・・納品書印刷待ちの受注伝票 ### 株式会社コマース２１（質問者） — 2019/09/05 ご回答ありがとうございます。 「確認待ち」と「印刷待ち」の注文を一度のAPI実行で取得する事は可能でしょうか。(条件のor検索は可能でしょうか) ### hamee_sys — 2019/09/18 同じフィールドのOR検索は可能です。 参考までに同フィールドのAND検索および異なるフィールドのOR検索はできませんのでご注意くださいませ。 --- # 商品管理βについて URL: https://developer.next-engine.com/questions/1290/ **投稿者:** 福木　章了　**日時:** 2019/09/02 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 API一覧の中で見つけられなかったため無いのであろうと思いますが、確認の為質問させていただきます。 商品管理βの情報をAPIにて追加更新する事は可能でしょうか。 【背景】 現在、自社開発にて、各モールの出品用データを生成するスクリプトを組んでいます。 その中で、Amazonの出品がMWSの厳格化にてネックになってきてしまいました。 ネクストエンジンはAmazon側からの推奨商品登録システムの1つとして推奨されたため今後も『APIが使えない』事はないのだと思います。 そこで、ネクストエンジンに作成した店舗別の出品用商品情報をPOST出来ればと考えた次第です。 合わせて、楽天市場や他のモールなどへの更新作業をネクストエンジンさんに任せてしまえば私の開発工数が減るという目論見もあります。 ご回答のほどよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/09/04 申し訳ございませんが、商品管理βの情報をAPIにて追加更新する事は不可となっております。 --- # APIを使った商品情報更新時にページ作成とモールへのアップロードを行いたい URL: https://developer.next-engine.com/questions/1297/ **投稿者:** 神垣　聡LyOWlqAw　**日時:** 2019/09/13 **カテゴリ:** ネクストエンジンAPIについて APIを利用して商品情報を更新しています。 商品情報を更新し終わった後、ページの作成とモールへのアップロードを行いたいです。 1. ページ作成とモールへのアプロードを行うエンドポイントはありますでしょうか？ 2. 一般的にはAPIで更新後、手動で「対象」にチェックを入れてページ作成、アップロードを行うのでしょうか？ よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2019/09/17 1.ページ作成およびモールへのアップロードを行うAPIの提供はございません。 2.ご認識のとおりでございます。 ### 神垣　聡LyOWlqAw（質問者） — 2019/09/17 なるほど、手動とのこと了解しました。ご返信いただきありがとうございます。 --- # バリエーションがある商品を登録したい URL: https://developer.next-engine.com/questions/1299/ **投稿者:** 神垣　聡LyOWlqAw　**日時:** 2019/09/17 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 バリエーションがある商品を登録したいのですが、どのようにして登録すればよいでしょうか？ 下記のいずれかになるでしょうか？ 1. バリエーションごとに別の商品として登録する 2. １商品として登録する 2の場合、メイン機能の「商品管理の一括登録」には「（β版）ページ情報バリエーション」にある通り、このCSV形式で送ると良いでしょうか？ 参考: [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) よろしくお願いします。 --- ## 回答 (8件) ### hamee_sys — 2019/09/20 商品マスタアップロードAPIを利用して、別々の商品として登録する必要がございます。 CSVのファイル内容はメイン機能と共通です。下記のマニュアルを参照くださいませ。 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) ### 神垣　聡LyOWlqAw（質問者） — 2019/09/23 ご回答ありがとうございます。 > CSVのファイル内容はメイン機能と共通 うまく送ることが出来なかったのでもう少し詳しく質問させてください。 下記のバリエーション商品があったとします。 123-s 123-m 123-l まずは「商品情報」としてCSVを「マスタアップロードAPI」に送ります。 バリエーションごとの商品が３つ登録されますが、この状態だとバリエーションごとの在庫や横軸選択肢が正しく設定されていません。 そこで「バリエーション」の形式のCSVを「商品マスタアップロード」に送っていますがエラーとなります。 管理画面の「商品管理の一括登録」から「バリエーション」として同じCSVを送ると正常に登録されます。 [https://gyazo.com/7e57e3a3ffd7ca8750b47bb0169606a3](https://gyazo.com/7e57e3a3ffd7ca8750b47bb0169606a3) 1. この使い方であっているでしょうか？ 2. 何がエラーの原因になっているか確認の方法はありますでしょうか？ よろしくお願いします。 ### hamee_sys — 2019/09/26 本APIはβ版に対応していないためバリエーションの登録をしていただくことができません。（したがってエラーとなります） バリエーションではなく別商品としてご登録くださいませ。ご理解のほどよろしくお願いいたします。 ### 神垣　聡LyOWlqAw（質問者） — 2019/09/26 ご回答ありがとうございます。なるほど、APIではバリエーションとして登録できない、ということですね。 > バリエーションではなく別商品 こちらについてですが、バリエーションの商品を別商品として登録すれば、ネクストエンジンではそれぞれがバリエーションとしての商品として取り扱うことができるのでしょうか？ 別々の商品として登録するところまでは実装が出来ています。 実装をもとに商品情報を登録し、メイン機能からバリエーションの商品として店舗別ページを作成しました。 その際に「項目選択肢 縦軸名」の「縦軸選択肢名」などの欄が設定されていないため、店舗（楽天）に商品を送った際、選択肢がうまく送られませんでした。 [https://gyazo.com/62e721f297318b572f0036e8d901a692](https://gyazo.com/62e721f297318b572f0036e8d901a692) メイン機能の商品マスタ一括登録にてバリエーションCSVを作成し、こちらの項目を設定しました。 そうしたところ正しく送ることができました。ただし手作業ですので、APIで実装を行いたいと思っています。 質問 > バリエーションではなく別商品としてご登録くださいませ。 1. 上記についてAPIでバリエーションのある商品を登録する際、上記のような「縦軸選択肢名」などのカラムは設定する必要がないでしょうか？ 店舗別ページを作成する際にエラーになってしまいましたが、他の原因でしょうか？ 前回の質問についても再度質問させてください。 m(_ _)m > 2. 何がエラーの原因になっているか確認の方法はありますでしょうか？ よろしくお願いいたします。 ### hamee_sys — 2019/10/03 ＞こちらについてですが、バリエーションの商品を別商品として登録すれば、ネクストエンジンではそれぞれがバリエーションとしての商品として取り扱うことができるのでしょうか？ 大変恐縮ですが、取り扱うことはできません。 ＞1. 上記についてAPIでバリエーションのある商品を登録する際、上記のような「縦軸選択肢名」などのカラムは設定する必要がないでしょうか？ バリエーションの設定ができないため、それに関連するカラムは設定していただけません。 ＞> 2. 何がエラーの原因になっているか確認の方法はありますでしょうか？ レスポンスにqueidが返ってまいります。その値を基にアップロードキュー検索API（[https://api.next-engine.org](https://api.next-engine.org)） をお使いいただくと、詳細なエラー内容が返ってまいります。 ### 神垣　聡LyOWlqAw（質問者） — 2019/10/03 ご回答いただきましてありがとうございます。 そうすると結論しましては 1. APIを使ってバリエーション商品は登録できない 2. そのためメイン機能で手動でバリエーション設定を行う必要がある ということで良いでしょうか？ ### hamee_sys — 2019/10/28 連絡が遅れてしまいました。 おっしゃる通りでございます。 ### 神垣　聡LyOWlqAw（質問者） — 2019/10/28 かしこまりました。確認が取れてよかったです。 APIで商品情報を登録後、バリエーションCSVを手動送るようにします。 --- # 自社向けアプリ（特定の企業向けアプリ）を作成、審査通過後、本番環境との接続について。 URL: https://developer.next-engine.com/questions/1300/ **投稿者:** 神垣　聡LyOWlqAw　**日時:** 2019/09/17 **カテゴリ:** 開発環境・SDKについて お世話になります。 自社での利用を前提としたアプリを作成し、審査を出し、通過し、販売中となりました。 ``` 自社のサービス ---> ネクストエンジン アプリ ---> ネクストエンジンメイン機能 ``` データ（商品情報など）は上記の流れになるかと思います。 その際の「自社のサービス」から「ネクストエンジンアプリ」への接続する際のAPIキー（シークレットIDなど）については 開発中のものを使えばよいでしょうか？ それとも本番用は他の箇所から確認可能でしょうか？ よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2019/09/20 ＞それとも本番用は他の箇所から確認可能でしょうか？ トップページ-アプリを作る-API(タブ)画面をご覧ください。 テスト用クライアントID、クライアントシークレット記載の上部に本番用の記載がございます。 審査通過後はこちらをご使用ください。 ### 神垣　聡LyOWlqAw（質問者） — 2019/09/23 APIキーが本番の場合にはメイン環境へ、テスト環境設定の場合にはテスト環境のメイン機能につながるとのことですね。 自己解決しました。ありがとうございました。 --- # 受注明細エンドポイントについて URL: https://developer.next-engine.com/questions/1303/ **投稿者:** sugiura　**日時:** 2019/09/25 **カテゴリ:** その他 お聞きしたいのですが、弊社は倉庫業務を外注でお願いするために準備を進めています。 外注先倉庫（E社）で出荷作業する際に、ネクストエンジンとアプリで連携した（E社）のシステムで納品書を出力して印刷をしてもらうのですが、 その納品書のフォーマットについて、定価の項目を入れたいと思っています。（一般顧客向けと別で業務販売もしているため納品書に定価の項目が必要になります。） ですが、デフォルトで定価用の項目が無いとのことで、（E社）のシステムの担当者のほうから、 「ネクストエンジンで出力される、受注明細エンドポイントのいずれかの項目に定価を紐づけできないか問い合わせしてほしい」とのことで言われました。 （アプリ利用：ネクストエンジン⇔（E社）システム） 見たところ、受注明細エンドポイントの中で各項目（フィールド）があり、そのいずれかに商品マスタの定価を紐づけするというかたちになることかと思いますが、 このようなことは可能でしょうか。 --- ## 回答 (1件) ### sugiura（質問者） — 2019/09/30 一度下記内容で回答をしていただいたのですが、スレッドのほうに表示されていないようなのですが内容は、 ーーーーーーーーーーーーーーーー Re:受注明細エンドポイントについて 商品マスタのgoods_display_priceフィールドをご使用になるのはいかがでしょうか。 受注明細エンドポイントからも取得が可能でございます。 ーーーーーーーーーーーーーーーー という内容でした。 回答いただいたこちらの内容でシステムの担当者に、連絡をしたところ ********** 受注明細エンドポイント内の受注明細の項目の いずれかに定価情報を落とせないか ********** ということを確認してほしいということで言われました。 お手数ですが、ご案内をお願いできますでしょうか。 --- # 受注明細エンドポイントについて URL: https://developer.next-engine.com/questions/1304/ **投稿者:** sugiura　**日時:** 2019/09/25 **カテゴリ:** ネクストエンジンAPIについて お聞きしたいのですが、弊社は倉庫業務を外注（E社）でお願いするために準備を進めています。 ネクストエンジンと（E社）のシステムはアプリで連携されています。 （E社）が出荷作業をする際に、納品書を（E社）のシステムで出力して印刷するのですが、 その納品書の項目で、定価を載せたいと思っています。（一般向けのほか業務販売もしているため） ですが、デフォルトでは定価の項目が無いとのことで、（E社）のシステムの担当者のほうから、 「ネクストエンジンで出力される、受注明細エンドポイントのいずれかの項目に定価を紐づけできないか問い合わせしてほしい」とのことで言われました。 見たところ、受注明細エンドポイントの中で各項目（フィールド）があり、そのいずれかに商品マスタの定価を紐づけするというかたちになることかと思いますが、 このようなことは可能でしょうか。 --- # 受注明細エンドポイントについて URL: https://developer.next-engine.com/questions/1305/ **投稿者:** sugiura　**日時:** 2019/09/25 **カテゴリ:** ネクストエンジンAPIについて お聞きしたいのですが、弊社は倉庫業務を外注（E社）でお願いするために準備を進めています。 ネクストエンジンと（E社）のシステムはアプリで連携されています。 （E社）が出荷作業をする際に、納品書を（E社）のシステムで出力して印刷するのですが、 その納品書の項目で、定価を載せたいと思っています。（一般向けのほか業務販売もしているため） ですが、デフォルトでは定価の項目が無いとのことで、（E社）のシステムの担当者のほうから、 「ネクストエンジンで出力される、受注明細エンドポイントのいずれかの項目に定価を紐づけできないか問い合わせしてほしい」とのことで言われました。 見たところ、受注明細エンドポイントの中で各項目（フィールド）があり、そのいずれかに商品マスタの定価を紐づけするというかたちになることかと思いますが、 このようなことは可能でしょうか。 --- ## 回答 (4件) ### hamee_sys — 2019/09/26 商品マスタのgoods_display_priceフィールドをご使用になるのはいかがでしょうか。 受注明細エンドポイントからも取得が可能でございます。 ### sugiura（質問者） — 2019/10/01 ありがとうございます。 重複でスレッドを立ててしまいすみません。 回答いただいた内容をシステムの担当者に連絡をしたところ ********** 受注明細エンドポイント内の受注明細の項目の いずれかに定価情報を落とせないか ********** ということを確認してほしいということで言われました。 お手数ですが、ご案内をお願いできますでしょうか。 ### hamee_sys — 2019/10/03 大変恐縮ですが、受注明細では定価情報に対応する項目がございません。 ご理解のほどよろしくお願いします。 ### sugiura（質問者） — 2019/10/04 ご回答いただきありがとうございます。承知しました。 --- # 受注一括登録パターンIDの取得方法について URL: https://developer.next-engine.com/questions/1310/ **投稿者:** ガジェログ　**日時:** 2019/10/07 **カテゴリ:** ネクストエンジンAPIについて [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 注文登録では上記のAPIを使用すると思うのですが、 receive_order_upload_pattern_id こちらの項目の取得箇所が不明瞭となっております。 「2」を設定すると正常に通るのですが、これがどこから取れているものなのかが不明で本番で同様に動作するかわかりません。 （管理画面の「受注一括登録パターン設定」の画面で登録されている登録内容の数字を値としても動作しませんでした） --- ## 回答 (3件) ### hamee_sys — 2019/10/09 受注一括登録パターンIDは受注一括登録パターン情報取得API [https://developer.next-engine.com/api/api_v1_receiveorder_uploadpattern/...](https://developer.next-engine.com/api/api_v1_receiveorder_uploadpattern/info) にて受注一括登録パターンIDを取得して頂き、 レスポンスの情報からパターンの名称と比較してIDを探して頂く必要があります。 ### ガジェログ（質問者） — 2019/10/11 EC CUBEで作っているのですが、EC CUBEは汎用標準＝90で合っていますでしょうか？ 90で登録すると以下のエラーが返ってきます。 "result" => "error" "code" => "006007" "message" => "存在しない受注一括登録パターン[90]です。" 固定ではなく、受注一括登録パターン情報取得APIを叩いてレスポンスと比較し動的にIDを 入れなくてはダメということでしょうか？ ### hamee_sys — 2019/10/28 返事が遅れてしまい申し訳ありません。その通りでございます。 --- # Magento2との連携：受注・在庫・出荷情報・ネクストエンジンへ自動的にメールで通知 URL: https://developer.next-engine.com/questions/1312/ **投稿者:** API連携　**日時:** 2019/10/11 **カテゴリ:** ネクストエンジンAPIについて ご担当者さま Magento2でネクストエンジンのAPIを利用して下記内容について、 連携をしたいと考えております。 どのように進めたら、よろしいでしょうか？ #1 注文情報のMagentoからネクストエンジンへのエクスポート #2 出荷実績情報のネクストエンジンからMagentoへのインポート #3 ネクストエンジンとMagento間での在庫データの同期 #4 Magentoで注文を受け付けた際に、ネクストエンジンへ自動的にメールで通知 ご返信頂ければ幸いです。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/10/11 ＃1 Magentのエクスポートの方法についてはMagento様へご確認ください。 受注伝票アップロード’APIをお使いいただき、ネクストエンジンへ取り込んでいただけます。 #2 受注伝票検索APIおよび受注伝票明細検索APIをご利用いただき、出荷済みデータを取得いただけます。 Magentoへのインポートに関しては、恐れ入りますがMagento様へ直接お問い合わせくださいませ。 #3 在庫マスタ検索APIをご利用いただき、在庫を取得いただくことができます。また商品マスタアップロードAPIより在庫情報を更新いただくことができます。 Magentoからの在庫の取得および反映に関しては、恐れ入りますがMagento様へ直接お問い合わせくださいませ。 #4 Magentoよりメールが送られてくると言う前提でありましたら、受注メールの取り込みによってネクストエンジン へ取り込んでいただくことができます。 こちらメイン機能の質問となりますので、詳細についてはマニュアルを参照いただき、ご不明な点はサポートセンターへご連絡ください。 [https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4748/) --- # 商品検索結果が0件となる URL: https://developer.next-engine.com/questions/1313/ **投稿者:** 高橋 祐樹　**日時:** 2019/10/12 **カテゴリ:** ネクストエンジンAPIについて 開発中ステータスです 7000件くらい商品データが登録されているメイン機能を選択しています api_v1_master_goods/count こちらを実行すると "result"=>"success", "count"=>"0", という結果になるのですが、何故でしょうか？ よろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2019/10/16 2つの可能性が考えられます。 1.本番環境とテスト環境を異なっている。本番環境にデータは入っているが、テスト環境にデータが入っていない。 2. β版の商品データが7000件登録されている 1,に関して接続されている環境とclientID clientsecretを今一度ご確認ください。 2.にかんしてはβ版はAPIにてさポートしておりません。ご理解のほどよろしくお願いします。 ### 高橋 祐樹（質問者） — 2019/10/18 ありがとうございます！1が原因でした テスト環境について理解していませんでした。 --- # 在庫マスタ検索について URL: https://developer.next-engine.com/questions/1314/ **投稿者:** kata15　**日時:** 2019/10/12 **カテゴリ:** ネクストエンジンAPIについて 現在アプリを開発中です。 API「在庫マスタ検索」を 以下のページを参照しています。 [https://developer.next-engine.com/api/api_v1_master_stock/search](https://developer.next-engine.com/api/api_v1_master_stock/search) テスト利用しているのですが データが取得出来ません。 当方PHPにてpost入力し、successで返されますが dataが何も入っていません。 これは、テスト環境だからデータが取得出来ない状態なのでしょうか？ よろしくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2019/10/16 ＞これは、テスト環境だからデータが取得出来ない状態なのでしょうか？ テスト環境にデータの登録がない状態かと思われます。本番ではなくテスト環境にてデータを作成してみてください。 ### kata15（質問者） — 2019/10/16 回答をいただきまして、ありがとうございます。 ＞テスト環境にデータの登録がない状態かと思われます。本番ではなくテスト環境にてデータを作成してみてください。 テスト環境にデモ用のデータが登録出来るということでしょうか？テスト環境へのデータ登録について方法が記載してあるページを教えて頂けますでしょうか。 こんな投稿があったので、 [https://developer.next-engine.com/questions/662](https://developer.next-engine.com/questions/662) 初期設定 [https://sandbox01.next-engine.com/Userstartup/top](https://sandbox01.next-engine.com/Userstartup/top) こちらのページで「楽天市場」を設定しますと「既にネクストエンジンは稼働しているのでこの操作を行なうことはできません」と 表示されました。 この場合どの様にしたら良いでしょうか？ ### hamee_sys — 2019/10/18 >テスト環境にデモ用のデータが登録出来るということでしょうか？ 左様でございます。 >テスト環境へのデータ登録について方法が記載してあるページを教えて頂けますでしょうか。 ログイン後、トップページの一覧（画面左下）より、メイン機能（テスト環境）を起動いただき、そちらよりデータを登録くださいませ。 --- # APIリクエスト回数制限について URL: https://developer.next-engine.com/questions/1316/ **投稿者:** 神垣　聡LyOWlqAw　**日時:** 2019/10/16 **カテゴリ:** ネクストエンジンAPIについて APIリクエスト回数制限について、制限に達した際にはどうなるでしょうか？ また現在のリクエスト回数を確認するにはどうしたらよいでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2019/10/18 > APIリクエスト回数制限について、制限に達した際にはどうなるでしょうか？ 回数による制限は特にございません。 > また現在のリクエスト回数を確認するにはどうしたらよいでしょうか？ FAQの下記の質問をご参照くださいませ。 ”Q. 現状のリクエスト回数と通信データ量を把握する方法はありますか？” ### hamee_sys — 2021/08/03 開発時は以下のリンクも併せてご確認ください [https://developer.next-engine.com/api/secure](https://developer.next-engine.com/api/secure) 　**短期間での大量のリクエスト送信はしないでください** - 自動的に大量のリクエストを送信するようなプログラムや、並列で多数のリクエストを同時実行するプログラムは、レスポンス悪化などのサービス低下を招く原因になります サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください 　**同一ユーザーでのマルチスレッドによるリクエストはしないでください** - 認証情報の有効期限がきれた場合、マルチスレッドでリクエストを行っているとエラーレスポンスが返却される可能性があります。 また、上述の通り、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください --- # 消費税項目について URL: https://developer.next-engine.com/questions/1317/ **投稿者:** 石川 和徳　**日時:** 2019/10/17 **カテゴリ:** ネクストエンジンAPIについて 現在、楽天、Wowma、ポンパレ等のモールにて「送料」「代引き手数料」と言った、商品以外の手数料等にも消費税項目が表示されておりますが、 ネクストエンジンAPIで同等のデータを取得する方法はありますでしょうか？ --- ## 回答 (3件) ### hamee_sys — 2019/10/25 恐縮ですが、「送料」や「手数料」の消費税に対応する項目はございません。 ### 石川 和徳（質問者） — 2019/11/12 >「送料」や「手数料」の消費税に対応する項目はございません。 との事でしたが、税率毎の小計・税額はAPIにて取得できないのでしょうか？ もしできる場合どの項目を参照すればよろしでしょうか？ 出来ない場合、実装の予定はありますでしょうか？ ### hamee_sys — 2019/11/21 送料、手数料は税込価格で取得されます。 各項目ごとの税率、小計は取れませんが、企業情報の「基本の税率」を取得することはできるため、 この税率から逆算することで取得していただくことができます。 --- # 店舗別ページの商品画像URL取得 URL: https://developer.next-engine.com/questions/1320/ **投稿者:** 高橋 祐樹　**日時:** 2019/10/19 **カテゴリ:** ネクストエンジンAPIについて 店舗別ページの商品画像URLを取得するにはどうしたら良いでしょうか？ サンプルをいただけると助かります。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/10/25 恐縮ですが、店舗別の商品画像URLを取得するAPIは提供しておりません。 ご理解のほどよろしくお願いいたします。 --- # POSと在庫連動時の同梱処理と分割処理の扱いについて URL: https://developer.next-engine.com/questions/1322/ **投稿者:** BCおがわ　**日時:** 2019/10/24 **カテゴリ:** ネクストエンジンAPIについて 弊社POSと貴社ネクストエンジン(以下、NE)をAPIで在庫連動しておりますが、 同梱処理と分割処理後の受注伝票の取得について相談がございます。 NEからPOSへ取り込まれるまでの流れ ①NEで受注伝票作成 ②NEの受注ステータスが「確認待ち」以降の場合、POS側の常駐プログラムが受注データをダウンロード ③②でダウンロードしたファイルが取込済みの受注伝票でない場合にPOSのDBへ取込 上記流れの中で、同梱処理や分割処理を行うと別の受注伝票となるため、取得タイミングによってはPOS在庫が2重で引かれてしまいます。 受注明細検索（/api_v1_receiveorder_row/search）にて受注情報を取得していますが、 同梱、分割する前の受注伝票のみ取得する等で2重取込しない条件指定は可能でしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/11/06 分割の場合は分割先の伝票よりreceive_order_divide_from_order_id（分割元伝票番号）をチェックいただくことで2重に在庫を引くことを防ぐことができます。 同様に、同梱元の伝票からはreceive_order_include_to_order_id（同梱先伝票番号）にて同梱先をチェックいただくことができます。 --- # 【APIテスト環境】受注注・在庫・出荷情報・受注メールの取込設定 URL: https://developer.next-engine.com/questions/1325/ **投稿者:** API連携　**日時:** 2019/10/28 **カテゴリ:** ネクストエンジンAPIについて ご担当者さま お世話になります。 【APIテスト環境】受注データ・在庫・出荷情報・受注メールの取込設定の弊社内で開発を進めております。 そこで、弊社内での構築終えてあと、ネクストエンジンとAPIのデータ連携のテストをするためには、どのようにすすめれば、よろしいでしょうか？ ネクストエンジン側では、商品登録等は一切行っていない状況です。 お手数ですが、ご回答のほど、よろしくお願いします。 以上 --- ## 回答 (1件) ### hamee_sys — 2019/11/01 アプリとして開発していただく必要がございます。アプリの登録後にAPIを利用することができます。 詳しくは下記をご覧ください。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) --- # 【APIテスト環境】「メイン機能（テスト環境）のアカウント発行」 URL: https://developer.next-engine.com/questions/1326/ **投稿者:** API連携　**日時:** 2019/10/28 **カテゴリ:** ネクストエンジンAPIについて 【APIテスト環境】受注データ・在庫・出荷情報・受注メールの取込設定の弊社内で開発を進めております。 そこで、弊社内での構築終えてあと、「メイン機能（テスト環境）のアカウント発行」して、 テスト環境を申し込む予定です。本番環境は既のAPIは既に稼働しているのですが、 新規で作成した、「メイン機能（テスト環境）のアカウント発行」に関しては、本番環境に影響は無いという認識でよろしいでしょうか？ お手数ですが、ご回答のほど、よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/11/01 テスト環境のデータは本番環境に全く影響はございません。 --- # 商品マスタアップロードにかかる時間に関しまして URL: https://developer.next-engine.com/questions/1330/ **投稿者:** エリー　ティン　**日時:** 2019/10/30 **カテゴリ:** ネクストエンジンAPIについて ご担当者様 お世話になっております、御社の商品マスタアップロードAPIに関して質問させてください 下記のリンクを参考しますと、/api_v1_master_goods/uploadのエンドポイントはファイルがアップロードされた結果を返すことにより、 実際のステータスを確認するためには「アップロードキュー検索API(エンドポイント /api_v1_system_que/search)」を参照するようになっていました。 [https://developer.next-engine.com/questions/674](https://developer.next-engine.com/questions/674) では質問ですが、 「商品マスタアップロードAPI」でファイルをアップロードして「アップロードキュー検索API」で検索できるようになるまでどのぐらいかかりますでしょうか？ 恐らく、Queの形で順次対応されると思いますが、最短・最長時間などを教えていただければ非常に助かります。 （いつまでアップロードキュー検索API呼べないため） 以上、よろしくお願い致します --- ## 回答 (1件) ### hamee_sys — 2019/11/05 最短・最長時間の基準はございません。 早い場合は数秒でキューが実行されますが、 長い場合、数十分掛かる場合もございます。 実際のサーバー・ネットワーク負荷などに影響されます。 --- # 自社開発ECとはじめてAPI連携（受注・在庫・配送ステータス変更）するには URL: https://developer.next-engine.com/questions/1331/ **投稿者:** API連携　**日時:** 2019/10/30 **カテゴリ:** ネクストエンジンAPIについて Magento2とAPI連携を予定しております。 #1 API連携するには、下記URLのアプリ開発をしなければ、ならないのでしょうか？ [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) #1-1 それとも、下記URLの汎用から進めれば、よろしいでしょうか？ [http://manual.ec-doc.net/startup/hanyo/](http://manual.ec-doc.net/startup/hanyo/) #1-2 管理画面>基本情報＞API設定に関しては、御社でしているモールのAPI設定の欄になるのでしょうか？ －－－－－－－－－－－－－－－－－－－－－－－ APIを利用することで受注伝票のアップロード、在庫連携が自動的に行われるようになります。 API認証情報の登録 [https://manual.next-engine.net/main/stock/stock_furoku/18476/](https://manual.next-engine.net/main/stock/stock_furoku/18476/) －－－－－－－－－－－－－－－－－－－－－－－ #1-3その場合は、どのようにAPI連携したら、よろしいでしょうか？ #2 在庫のAPI連携のみ対応可能なのでしょうか？ [https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5174/) #3 それ以外（受注連携・配送ステータスの受け渡し）は、 最後に、下記URLの汎用、API連携をせずに、行うのでしょうか？ [http://manual.ec-doc.net/startup/hanyo/mall-attention/](http://manual.ec-doc.net/startup/hanyo/mall-attention/) #3-1 その場合は、受注メールの取込設定【汎用】を使って行うのでしょうか？ [https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4748/) お手数ですが、ご回答よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/11/01 #1 API連携するには、下記URLのアプリ開発をしなければ、ならないのでしょうか？ >左様でございます。 以下の質問はすべてメイン機能の質問となります。 恐れ入りますが、サポートまでお問い合わせくださいませ。 --- # 自動で受注伝票有効化ができない URL: https://developer.next-engine.com/questions/1334/ **投稿者:** 高見沢　徳明　**日時:** 2019/11/05 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 以下のDevelopperForumの内容を参考にして 受注伝票有効化を行おうとしています。 [https://developer.next-engine.com/questions/1155](https://developer.next-engine.com/questions/1155) CSV作成して以下のAPIの仕様どおりにアップロードしましたが ステータスが遷移しない模様です。CSVは添付のものとなります。 （同じ受注番号なので処理がスキップと出てしまう） [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 蛇足ですが、バッチは以下のSDK用いてアプリ認証から APIコールまで行っています。 [https://github.com/infinity-octaver/ne_api](https://github.com/infinity-octaver/ne_api) こちら何が問題なのでしょうか？ご教示頂けると幸いです。 よろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2019/11/06 APIではなくメイン画面よりCSVをあげた場合はどのようになりますでしょうか。 仮に画面からあげた場合に遷移する場合は、APIの値の設定が間違っている可能性がございます。 ### 高見沢　徳明（質問者） — 2019/11/08 CSVの項目が間違っているようでした。失礼しました。 --- # RenewableToken更新のためのUID,Stateが取得できない URL: https://developer.next-engine.com/questions/1337/ **投稿者:** 高見沢　徳明　**日時:** 2019/11/08 **カテゴリ:** ネクストエンジンAPIについて APIのRenewableTokenを更新すべく、UIDとStateを取得しようとしております。 こちらのURLを参考に [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) 以下のようなRubyのコードを組んでおります。 ---------------------------------------------- NE_SERVER_HOST = "[https://base.next-engine.org](https://base.next-engine.org)" SIGN_IN_PATH = "/users/sign_in/" def self.sign_in client_id, client_secret request_conf = { open_timeout: 120, timeout: 300 } conn = Faraday.new(url: NE_SERVER_HOST, request: request_conf) do |faraday| faraday.request :url_encoded faraday.response :logger faraday.adapter Faraday.default_adapter end response = conn.get SIGN_IN_PATH + "?client_id="+client_id+"&redirect_uri="+Application.config.ne_callback_uri # callback url end -------------------------------------------------- なんか正しく値が取れていないようで以下のようなレスポンスが返ってきます。 呼び方として間違っている箇所ありますでしょうか？ #\n\n\t\n\t\t\n\nwindow.NREUM||(NREUM={});NREUM.info={\"beacon\":\"bam.nr-data.net\",\"errorBeacon\":\"bam.nr-data.net\",\"licenseKey\":\"eb5bdfcf2b\",\"applicationID\":\"121345464\",\"transactionName\":\"cwoPEEFcDgpQFk4RFVUXEktAVhEVXAsPF0leABY=\",\"queueTime\":0,\"applicationTime\":92,\"agent\":\"\"}\n(window.NREUM||(NREUM={})).loader_config={licenseKey:\"eb5bdfcf2b\",applicationID:\"121345464\"};window.NREUM||(NREUM={}),__nr_require=function(e,n,t){function r(t){if(!n[t]){var o=n[t]={exports:{}};e[t][0 --- # receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい URL: https://developer.next-engine.com/questions/1338/ **投稿者:** 高見沢　徳明　**日時:** 2019/11/10 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。受注伝票のステータスを印刷待ちから出荷済みに変更すべく [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) を元にAPIをコールしているのですが、掲題のエラーが表示されます。こちらも拝見しましたが、再度検索するという意味合いがよくわかりません。 [https://developer.next-engine.com/questions/1267](https://developer.next-engine.com/questions/1267) tmp = (NeAPI::Master.new(access_token: spree_next_engine_integrate.access_token, refresh_token: spree_next_engine_integrate.refresh_token).receiveorder_base_search(query: {"receive_order_shop_cut_form_id-eq": r['receive_order_shop_cut_form_id']})) のようなソースを挿入しても特に変わらないです。 ちなみにソースコードはRubyのSDKを用いて以下のようにしています。 spree_next_engine_integrate = SpreeNextEngineIntegrate.find(1) # AccessTokenとRefreshTokenを格納しているモデル result = (NeAPI::Master.new(access_token: spree_next_engine_integrate.access_token, refresh_token: spree_next_engine_integrate.refresh_token).receiveorder_base_search(query: {"receive_order_order_status_id-eq": 20})) # waiting for printing result.each do |r| order = Spree::Order.find_by_number(r['receive_order_shop_cut_form_id']) if order.present? obj = (NeAPI::Master.new(access_token: spree_next_engine_integrate.access_token, refresh_token: spree_next_engine_integrate.refresh_token)) params = {receive_order_id: r['receive_order_shop_cut_form_id'], receive_order_last_modified_date: Time.now.strftime('%Y-%m-%d %H:%M:%S')} status = obj.post(method: 'shipped', model: 'receiveorder_base', query: nil, fields: nil, get_key: nil, params: params) spree_next_engine_integrate.update_attributes(access_token: status.access_token, refresh_token: status.refresh_token) end こちらは何が問題なのでしょうか？ --- ## 回答 (3件) ### hamee_sys — 2019/11/15 receive_order_last_modified_dateは伝票の状態の遷移や変更により、常に変わる可能性があります。 「受注伝票検索」にて最新のreceive_order_last_modified_dateを取得いただき、その値にて再度出荷確定処理を行ってください。 ### 高見沢　徳明（質問者） — 2019/11/15 ご回答ありがとうございます。 そうしますと、receive_order_last_modified_dateの値は任意のものではなく、最新の現在の値を取得してそれをそのまま設定する必要があるということですね？ ### 高見沢　徳明（質問者） — 2019/11/16 > eceive_order_last_modified_dateの値は任意のものではなく、最新の現在の値を取得してそれをそのまま設定 こちらでエラー無く動作することを確認しました。ありがとうございました。 --- # 【バグレポート】フィールド名にタイポを発見 URL: https://developer.next-engine.com/questions/1339/ **投稿者:** 小澤 史朗　**日時:** 2019/11/11 **カテゴリ:** ネクストエンジンAPIについて （質問ではなくバグレポートもしくは要望です） /api_v1_receiveorder_base/update の下記フィールド名はタイポだと思われますので次期バージョンでの修正を希望します 「受注分類タグ」: receive_order_gruoping_tag 誤: gruoping 正: grouping --- ## 回答 (1件) ### hamee_sys — 2019/11/19 ご指摘ありがとうございます。 次期バージョンリリース時に参考とさせていただきます。 --- # bulkupdateで更新フィールドが1つも設定されておりません URL: https://developer.next-engine.com/questions/1340/ **投稿者:** 高見沢　徳明　**日時:** 2019/11/13 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 bulkupdateのAPIで以下のXMLをアップロードしています。 2 すると 020500:[{"receive_order_id"=>"44", "code"=>"020014", "message"=>"更新フィールドが1つも設定されておりません。"}] (NeAPIException) というエラーになってしまいます。これは何が問題なのでしょうか？ ご確認よろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2019/11/21 データ構造は 2　 だけでお間違いないでしょうか。 下記のリファンレンスを見ていただき、xml形式にてリクエストをお送りください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) ### 高見沢　徳明（質問者） — 2019/11/21 本件、失礼しました。質問投稿した際にはタグが入っていたはずなのですが消えてしまった模様です。 こちらですが、updateのAPIでなんとか動くようになりましたので解決しました。 お騒がせして申し訳ありません。 --- # 基本的な事なのですが教えていただけますでしょうか。 URL: https://developer.next-engine.com/questions/1342/ **投稿者:** 河井智恵子　**日時:** 2019/11/20 **カテゴリ:** ネクストエンジンAPIについて １　特定のシステムからapiを利用するだけでもアプリとして作成する必要があり ますでしょうか。 ２　また、アプリというのはサーバーシステムなのでしょうか(FAQ一覧にSSLが必 須とありましたので)。そもそものアプリという単語の意味が理解できておりません。 すいません。　iOSやandoroidのようにコンパイルしたものをどこかにアップして それを有料、または無料で販売するのでしょうか。 アプリを作成するために必要な環境などがあるのでしたら教えていただけますでしょうか。 ３　.Net用のSDKは無いようですが、Windowsサーバーからの利用を行う場合、.Net での開発でもapiを直接利用する分には問題ないでしょうか。 ４　上記とは矛盾しますが、理想としてはWindows上で動作するexeでapiを利用 したいのですが、それは可能でしょうか。 全く初歩的なことを聞いてしまっていて申し訳ないのですが、よろしくお願いいた します。 > --- ## 回答 (4件) ### hamee_sys — 2019/11/21 1. はい、必要がございます。 2. >アプリというのはサーバーシステムなのでしょうか 左様でございます。 ＞そもそものアプリという単語の意味が理解できておりません。 お客様側にて、システムを開発、ドメインなども管理いただき、そのシステムの利用に対して、有料または無料で販売いただく形になります。コンパイルの有無は問いませんが、サーバシステム上でアプリが稼働するとお考えください。 ＞アプリを作成するために必要な環境などがあるのでしたら教えていただけますでしょうか。 貴社管理となりますので、特に環境などの制約はこちらでは設けておりません。SDKを利用いただく場合のみ、該当言語のバージョンをご確認いただく必要があります。詳しくは下記を参照ください。 [https://developer.next-engine.com/sdk](https://developer.next-engine.com/sdk) 3. SDKが提供されていないだけですので、問題ございません。 4. 可能です。 ### 河井智恵子（質問者） — 2019/11/26 4.可能です。とのことなのですが Windowsのパソコン上で動作するexeでapiを利用することが可能という事なのですが、その場合はサーバーは不要なのでしょうか。 ### 河井智恵子（質問者） — 2019/11/22 Windowsのパソコン上で動作するexeでapiを利用することが可能という事なのですが、その場合はサーバーは不要なのでしょうか。 ### hamee_sys — 2019/11/27 必要となります。 詳しくはFAQの「Q. 作成したネクストエンジンアプリは、ローカル環境（PC）で動作検証できますか？」をご覧ください。 [https://developer.next-engine.com/faq](https://developer.next-engine.com/faq) --- # BASEとの連携につきまして URL: https://developer.next-engine.com/questions/1343/ **投稿者:** sugachan　**日時:** 2019/11/21 **カテゴリ:** その他 教えてください。 ネクストエンジンではBASEとの連携は対応していないとありますが、どなたかおこなっている方はいらっしゃいませんか？ 昔に「BASE全自動」というアプリがありましたが、検索しても出てきません。 その場合、どの様なアプリを使用しているか教えて頂きたく、お願いいたします。 --- # 汎用店舗にBASEを取り込みたいのですが URL: https://developer.next-engine.com/questions/1344/ **投稿者:** sugachan　**日時:** 2019/11/22 **カテゴリ:** その他 ネクストエンジン 汎用店舗にBASEを取り込みたいのですが、 上手く起動されている方いらっしゃいますか？ どの様にしたらよろしいのでしょうか？ よろしければ教えて頂きたく、お願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/11/27 下記ページの対応モール・カート一覧に掲載がない方・独自サイトの方を参照くださいませ。 [https://next-engine.net/manageable_systems](https://next-engine.net/manageable_systems) --- # アクセス制限のある環境との在庫連携（EC-CUBE2.12系） URL: https://developer.next-engine.com/questions/1345/ **投稿者:** IPL石川　**日時:** 2019/11/22 **カテゴリ:** ネクストエンジンAPIについて 現在EC-CUBE2.12系のテストサイトにて導入を進めておりますが、在庫連携がうまく行かない状況です。 考えられる要因として、IP制限やDigest認証をかけていたため制限を一時的に外し、 在庫を手動で更新して在庫連携履歴を確認したところ、 在庫連携処理のステータスは「スキップ」、メッセージに「在庫更新対象の商品がありませんでした」と表示されます。 原因の見当がつかないため、何か他に考えられる要因がございましたらご教示頂けますでしょうか。 ※急ぎのため11/25には一次回答を頂けますと大変助かります。 ご確認の程、よろしくお願い致します。 --- ## 回答 (2件) ### IPL石川（質問者） — 2019/11/26 別件かとは思いますが追加で質問がございます。 ネクストエンジン側で受注の出荷を行いましたが、 発送連絡メールの自動送信設定を行っているにも関わらず、 1日前に出荷したにも関わらずメールが受信できない状況です。 マニュアルなど参照し発送連絡メールの自動送信設定は問題なく出来ているかと思われますが、 設定以外にも自動送信メールが送られない原因として考えられることはございますでしょうか。 ### hamee_sys — 2019/11/27 こちらはメイン機能の質問となりますので、 お手数ではございますが、サポートまでご連絡くださいませ。 サポートへの連絡ですが、ネクストエンジンへログイン後、お問い合わせ画面にてご連絡いただけます。 --- # アプリにつきまして URL: https://developer.next-engine.com/questions/1347/ **投稿者:** 河井智恵子　**日時:** 2019/11/26 **カテゴリ:** その他 基本的なもので申し訳ないのですが アプリというのはサーバーで動作するプログラムであればなんでもいいということで良かったでしょうか。 で、apiを呼び出すためにはSSL接続できるドメインを充てていること、そのドメインからのapi呼び出しに対してだけ応答しますよ。という感じでしょうか。 それで、こんかいは別に一般公開する必要の無いアプリを作成する予定なのですが、アプリである以上、ガイダンスの様なものはあるのでしょうか。 apple store などとどうように、審査に通るために最低限必要な機能や画面構成などを教えていただけますでしょうか。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/11/27 アプリのガイダンスは特にございません。 また必要な機能や画面構成といった要件も特にございません。 --- # 受注のセット商品の販売について URL: https://developer.next-engine.com/questions/1348/ **投稿者:** 沼尻　淳　**日時:** 2019/11/29 **カテゴリ:** ネクストエンジンAPIについて 受注情報から購入商品がセット販売の商品なのか？ また、何個セット販売なのか情報を取得する方法あるでしょうか？ あるようでしたら、どのように取得できますでしょうか？ よろしくお願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2019/12/03 大変恐縮ですが、現状APIでセット商品を見分ける方法はございません。 ### 沼尻　淳（質問者） — 2019/12/04 >現状APIでセット商品を見分ける方法はございません。 承知しました。 セット販売であることが判別できればよいので、必ずしもAPIの情報からのみで判断する必要はないと考えています。 同じ商品をバラとセット両方の販売方法で登録した場合は、商品コードは同じになるのでしょうか？ それともセット販売は異なる商品コードになるのでしょうか？ バラ販売と異なる商品コードであることが担保されるなら、商品コードからセット販売であることを判別できるのではと考えています。 よろしくお願いします。 ### hamee_sys — 2019/12/06 こちらメイン機能の質問となりますので、サポートまでご連絡ください。 --- # 受注明細検索APIのサンプルに誤りがあります URL: https://developer.next-engine.com/questions/1350/ **投稿者:** 小澤 史朗　**日時:** 2019/12/02 **カテゴリ:** ネクストエンジンAPIについて 受注明細検索API /api_v1_receiveorder_row/search のサンプルに誤りがあります。 [ （ブラケット） { （カーリーブレイス） が１つずつ欠損しているのでJSONとして正しい形式になっていません。 サンプルの修正をお願いいたします。 誤: --------------------------------------------------------------------- { "receive_order_row_receive_order_id": "1", （以下省略） }, { "receive_order_row_receive_order_id": "1", （以下省略） } ], "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" } --------------------------------------------------------------------- 正: 2行目と3行目を追記 --------------------------------------------------------------------- { [ { "receive_order_row_receive_order_id": "1", （以下省略） }, { "receive_order_row_receive_order_id": "1", （以下省略） } ], "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" } --------------------------------------------------------------------- --- ## 回答 (1件) ### hamee_sys — 2019/12/10 こちら修正いたしました。 ご指摘くださり、ありがとうございました。 --- # 受注明細検索APIのクエリについて URL: https://developer.next-engine.com/questions/1351/ **投稿者:** 小澤 史朗　**日時:** 2019/12/02 **カテゴリ:** ネクストエンジンAPIについて 下記のクエリパラメータについて、APIリファレンス [https://developer.next-engine.com/api/api_v1_receiveorder_row/search](https://developer.next-engine.com/api/api_v1_receiveorder_row/search) に記載されていませんので質問させて下さい。 receive_order_cancel_type_id receive_order_order_status_id ドキュメントによるとどちらもデータ型は「文字列型」とありますが、どのような文字列が許容されるのかについては一切記載がありません。 どちらも備考欄にリンクがあり、リンク先にとぶと receive_order_cancel_type_id は 受注キャンセル区分の説明 [https://developer.next-engine.com/api/fields/system_canceltype](https://developer.next-engine.com/api/fields/system_canceltype) receive_order_order_status_id は 受注状態区分の説明 [https://developer.next-engine.com/api/fields/system_orderstatus](https://developer.next-engine.com/api/fields/system_orderstatus) となっており、そのどちらにも「許容される文字列」「その意味」について一切説明がありません。 ご回答およびAPIリファレンスへの追記を要望いたします。 --- ## 回答 (1件) ### hamee_sys — 2019/12/03 >ドキュメントによるとどちらもデータ型は「文字列型」とありますが、どのような文字列が許容されるのか こちらに関してですが、 receive_order_cancel_type_id は受注キャンセル区分情報取得API(/api_v1_system_canceltype/info)で取得したIDが許容されます。 またreceive_order_order_status_idは受注状態区分情報取得API(/api_v1_system_orderstatus/info)で取得したIDを設定していただけます。 よろしくお願いします。 --- # 「受注伝票出荷確定処理」に代用できる連携方法はないでしょうか？ URL: https://developer.next-engine.com/questions/1352/ **投稿者:** nakayama　**日時:** 2019/12/02 **カテゴリ:** ネクストエンジンAPIについて 「受注伝票出荷確定処理」についてご質問でございます。 上記APIは更新する伝票毎にリクエスト数がカウントされる仕様との事ですが、 当方の倉庫では毎月の出荷が1万近くなることもあり、コストの面でAPIの利用に踏み切れずおります。 やりたいことは「印刷済み」の伝票を一括で「出荷済み」に更新したいのですが、 手動で出荷実績csvを作成してアップロードする作業を無くしたいということです。 出荷実績CSVを生成しアップロードAPIでネクストエンジンへファイル取込むなど、 1日に1回のリクエスト数で済むような連携方法はございませんでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2019/12/03 出荷確定処理APIは仕様上、１件ずつ処理していただく必要がございます。 ご理解のほどよろしくお願いします。 --- # 受注伝票一括更新APIでの出荷確定処理について URL: https://developer.next-engine.com/questions/1353/ **投稿者:** rokuhira　**日時:** 2019/12/02 **カテゴリ:** ネクストエンジンAPIについて 受注伝票一括更新API（ [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) ）の「フィールド一覧」タブに「受注状態区分（receive_order_order_status_id）」がありましたので、 出荷確定済みを示す、「receive_order_order_status_id=50」をリクエストパラメータに含めてAPIをコールしましたが、指定した受注状態区分に更新されませんでした（出荷確定済みになりませんでした）。 出荷確定処理をするためには、受注伝票出荷確定処理API（ [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) ）を用いて1受注伝票ずつ更新しないといけないのでしょうか。 ご回答いただけますと幸いです。 どうぞよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2019/12/03 ＞出荷確定処理をするためには、受注伝票出荷確定処理API（ [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) ）を用いて1受注伝票ずつ更新しないといけないのでしょうか。 おっしゃる通りでございます。ご理解のほどよろしくお願いします。 --- # 受注データのAPI取り込みについて URL: https://developer.next-engine.com/questions/1356/ **投稿者:** 大蔵　友人　**日時:** 2019/12/05 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 ネクストエンジンの受注伝票データを、当社使用のシステムにデータ取り込みを検討しておりまして、以下のポイントでつまづいてしまっていて、恐れ入りますがアドバイス頂きたく書き込みしました。 質問内容は以下の通りです。 【やりたいこと】 1伝票の中で、1明細はキャンセル、他の明細は引当済、の様な場合に キャンセル以外の明細は全て取込を行いたい。 【質問】 「確認チェック区分(confirm_check_id)=2」という条件でAPI受注データを取得しているが、この条件だと全明細が引当済でないと受注データ取得が行えない。 ※引当数=0やキャンセルフラグが立っている明細が1つでもあるとデータ取得が行われない。 上記を解決するにはどの様な取得条件を追加すれば良いか 教えて頂きたいです。 --- ## 回答 (6件) ### hamee_sys — 2019/12/06 受注明細検索APi（/api_v1_receiveorder_row/search）にて明細のキャンセルフラグを条件に取得していただくことができます。 ### 大蔵　友人（質問者） — 2019/12/06 コメントありがとうございます。 開発者と相談してみます。また何かあった際は宜しくお願いします ### 大蔵　友人（質問者） — 2019/12/06 開発者と相談してみます。また何かあった際は宜しくお願いします ### 大蔵　友人（質問者） — 2019/12/06 「確認チェック区分=2」という条件に加え、 キャンセルフラグの条件を除外する、ということでしょうか？ ### 大蔵　友人（質問者） — 2019/12/09 改めての質問です。 ・受注入力 ↓ ・確認チェックを行う ↓ ・入金処理を行う ↓ ・「受注状態」が「引当待ち」になっている ※引当数は0 上記のタイミングで、/api_v1_receiveorder_base/searchでconfirm_check_id=2の条件で取得しにいこうとしたら 取得できなかったのですが、「引当待ち」になっていれば、confirm_check_id=2になっているとの認識でした。 そもそもこの認識が間違いでしょうか？「引当待ち」であればconfirm_check_idは0や1になっている？ お手数ですが、ご確認頂けないでしょうか。 ### hamee_sys — 2019/12/26 引当待ちの条件は下記を参照ください。 [https://developer.next-engine.com/questions/1373](https://developer.next-engine.com/questions/1373) 引当待ちとconfirm_check_id=2は関連はございません。 --- # JavaSDKでインスタンスを作成できない URL: https://developer.next-engine.com/questions/1359/ **投稿者:** 吉川　快里　**日時:** 2019/12/09 **カテゴリ:** 開発環境・SDKについて ne-java-sdk-1.1.1.jarを使用して、NeApiClientインスタンスを生成する際にjava.lang.NoClassDefFoundErrorが発生します。 ビルドパスは通っており、コンパイルエラーは発生していません。 なぜインスタンスを生成できないのでしょうか？ インスタンス生成時のコードは以下の通りです。 NeApiClient neApiClient = new NeApiClient(request, response, clientId, secretId, redirectUrl); --- ## 回答 (3件) ### hamee_sys — 2019/12/11 クラスパスが通っているかなどソースコードの確認をお願いします。 ### 吉川　快里（質問者） — 2019/12/12 ビルドパスは通っており、コンパイルエラーは発生していません。 「クラスパスが通っていること」は確認済みです。 その上で、エラーが発生しうる原因はないのでしょうか？ インスタンス生成時のコードにおける気付きとかあれば、合わせて教えて下さい。 ### hamee_sys — 2019/12/13 クラスパスが通っているのであれば、文法も問題がございませんので、 特筆するような原因は特定いたしかねます。 --- # 受注データの取込について(再) URL: https://developer.next-engine.com/questions/1361/ **投稿者:** 大蔵　友人　**日時:** 2019/12/11 **カテゴリ:** ネクストエンジンAPIについて 12/5に質問させて頂いたものです。 不明点がございますので、再度質問させて頂きます。 ------------------------------------------------------------- 「確認チェック区分(confirm_check_id)=2」という条件でAPI受注データを取得しているが、この条件だと全明細が引当済でないと受注データ取得が行えない。 ※引当数=0やキャンセルフラグが立っている明細が1つでもあるとデータ取得が行われない。 ------------------------------------------------------------- という質問に対し、 ------------------------------------------------------------- 受注明細検索APi（/api_v1_receiveorder_row/search）にて明細のキャンセルフラグを条件に取得していただくことができます。 ------------------------------------------------------------- というご回答は頂いたのですが、 そもそも「確認チェック区分(confirm_check_id)=2」という条件で取得しようとした時に 引当数=0の明細が存在すれば、明細取得が行えない様です。 確認なのですが、各受注伝票が「確認チェック区分(confirm_check_id)=2」となる条件は何なのでしょうか？ 例えば --------------------------------------------- ・受注入力 ↓ ・確認チェックを行う ↓ ・入金処理を行う ↓ ・「受注状態」が「引当待ち」になっている ※引当数は0 --------------------------------------------- という状態で、「確認チェック区分(confirm_check_id)=2」という条件で受注伝票を取得しようとすると取得できません。 1明細でも引当数=0が存在すると確認チェック区分が2にならないのでは？と思っているのですが・・。 お手数ですがご回答頂けないでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2019/12/13 確認チェック区分は伝票上で確認チェックにチェックを入れたタイミングもしくは確認チェック内容がなかった場合は、伝票起票のタイミングとなります。 引き当て待ちの条件は、「確認済み＆入金済み(または後払い)＆明細のいずれかが受注数<>引当数」であり。確認チェック区分とは別項目です。 --- # WMSとのAPI連携について URL: https://developer.next-engine.com/questions/1362/ **投稿者:** 加賀谷司　**日時:** 2019/12/11 **カテゴリ:** ネクストエンジンAPIについて ご担当者様 お世話になっております。 下記URLを確認していますが、 出荷実績や入荷実績をネクストエンジンに反映する際にどのAPIをコール するのかわかりませんでした。 [https://developer.next-engine.com/api/start](https://developer.next-engine.com/api/start) WMS側がクライアントとなりAPI連携するにあたり、 どの程度改修が必要であるか試算しています。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2019/12/13 入荷実績は在庫入出庫API（/api_v1_master_stockiohistory/search）にて取得可能でございます。 出荷実績については、APIの提供はございません。 恐縮ではございますが、ご理解のほどよろしくお願いします。 --- # 受注伝票の取得について URL: https://developer.next-engine.com/questions/1367/ **投稿者:** 大蔵　友人　**日時:** 2019/12/11 **カテゴリ:** ネクストエンジンAPIについて 12/5に質問させて頂いた者です。改めて質問させて頂きます。 「確認チェック区分(confirm_check_id)=2」で「受注伝票情報取得」/api_v1_receiveorder_base/search を行った際、 受注状態が「引当待ち」になっていると伝票が取得出来ないのですが、 こちらの理由を教えて欲しいです。 「確認チェック区分(confirm_check_id)=2」(2:確認済み)になるタイミングはいつなのでしょうか？ 1受注伝票で全明細が引当数<>0になっていることが条件になっているのかと思ったのですが・・。 --- ## 回答 (1件) ### hamee_sys — 2019/12/13 確認チェック区分は伝票上で確認チェックにチェックを入れたタイミングもしくは確認チェック内容がなかった場合は、伝票起票のタイミングとなります。 引き当て待ちの条件は、「確認済み＆入金済み(または後払い)＆明細のいずれかが受注数<>引当数」であり。確認チェック区分とは別項目です。 --- # Javaサンプルを起動させるには？ URL: https://developer.next-engine.com/questions/1368/ **投稿者:** 吉川　快里　**日時:** 2019/12/12 **カテゴリ:** 開発環境・SDKについて JavaSDKのサンプルコードを提供していただいているかと思いますが、 そのサンプルコードを動かすにあたって必要な環境、ライブラリ等をご教授いただけますでしょうか？ 最低限下記の内容は知りたいです。 1.想定しているIDE 2.動作に必要な.jarファイル --- ## 回答 (3件) ### hamee_sys — 2019/12/16 IDEの指定は特にございません。 jaファイルその他必要な環境はについては下記のページに記載がございますので、ご参照ください。 [https://github.com/hamee-dev/sdk-java](https://github.com/hamee-dev/sdk-java) ### 吉川　快里（質問者） — 2019/12/16 恐れ入りますが、提示いただいたページはSDKのページのように思います。 私が知りたいのはサンプルの起動に必要なjarファイルなのですが、それともこちらのページに記載されているのでしょうか？だとすれば申し訳ありません。こちらでは確認できませんでしたので、リンクではなく直接必要なファイルをご教授いただきたいのですが可能でしょうか？ ### 吉川　快里（質問者） — 2019/12/18 こちら自分で確認しました。 STS関連以外に必要だった.jarは lombok.jar httpclient-x.x.x.jar httpcore.x.x.x.jar ne-java-sdk.jar でした。 import org.springframework.boot.web.support.SpringBootServletInitializer; のパッケージは名前が変わっており、 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; に変更する必要があります。 IDEによってはlombokはビルドパスを通すだけでは使用できず 1，lombok.jarをIDEの.iniがある場所に配置 2，lombok.jarを起動して、securitylocationに.iniがある場所に設定 3，install/updateをして、STS起動 の手順が必要です。 他の方の参考になれば幸いです。 --- # 楽天受注データのAPI取り込みについて URL: https://developer.next-engine.com/questions/1371/ **投稿者:** 大蔵　友人　**日時:** 2019/12/16 **カテゴリ:** ネクストエンジンAPIについて 楽天受注データのAPI取り込みについて いつもお世話になっております。 楽天からの受注API取り込みについて、質問させて頂きます。 現在、受注データのダウンロードで通常購入データをダウンロードして、ダウンロードしたCSVをネクストエンジンにアップロードし、受注データを取り込みしております。そして、ネクストエンジンで伝票を処理し出荷確定後、消費者へ発送通知メールを送る流れとしております。 そのネクストエンジンへのCSVによる受注データ取り込みについては、API取り込み自動化の設定が可能だとは存じておりますが、「自動で受注取り込みする」と設定したところ、RMS内受注一覧で入金確認済みデータが全て「発送待ち」ステータスへ移動しておりました。 弊社は、在庫が無い商品を取り寄せとして店舗掲載しておりますので、在庫が無い商品に注文が入った場合、まずは仕入先への問い合わせを実施し、その結果販売が可能な場合は「注文確定待ち」ステータスに」入っている受注の保留を外して手動で「発送待ち」ステータスへ変更しております。 ご注文の商品が欠品などしていた場合、「発送待ち」ステータスに」伝票が移動してしまうと、その時点でお客様へメール連絡も飛ぶので都合が悪いです。 そこでご相談なのですが、ネクストエンジンの楽天API取り込みを自動化したとしても、楽天入金確認済みで在庫が無い商品についてはでは注文確認待ちに留まる様に設定が可能でしょうか? お忙しいところお手数をおかけしますが、ご確認のほど宜しくお願い致します。 大蔵 タグ: 受注 --- ## 回答 (1件) ### hamee_sys — 2020/01/06 メイン機能の質問となりますので、サポートまでご連絡くださいませ。 --- # 引当待ちの伝票を取得するAPI及び取得条件について URL: https://developer.next-engine.com/questions/1373/ **投稿者:** 八木孝憲　**日時:** 2019/12/19 **カテゴリ:** ネクストエンジンAPIについて 以下のAPIを用いて、引当待ちの伝票を取得したいと考えておりますが取得可能でしょうか？ 可能な場合は、取得条件についてご教示ください。 一応こちらでテスト的に作成して、引当待ちまで進めたところ receive_order_order_status_nameが起票済(CSV\/手入力)になっております。 /api_v1_receiveorder_base/search --- ## 回答 (5件) ### hamee_sys — 2019/12/24 はい可能です。取得条件は、 確認済み（receive_order_order_status_id = 2） 且つ入金済み（receive_order_deposit_type_id = 2）(または後払い) 且つ明細のいずれかが受注数≠引当数（receive_order_row_stock_allocation_quantity <> receive_order_row_quantity） 且つキャンセル状態ではない(receive_order_cancel_type_id = 0)場合です。 よろしくおねがいします。 ### 八木孝憲（質問者） — 2019/12/26 ご回答ありがとうございます。 内容確認しました。 ### 世川　紘平 — 2020/02/28 横から失礼します。 こちらに記載の #2 の回答についてお伺いしたいのですが、受注伝票検索（又は受注明細検索）のAPIで 明細のいずれかが受注数≠引当数（receive_order_row_stock_allocation_quantity <> receive_order_row_quantity） という条件の検索は可能なのでしょうか？ パラメータ比較演算子のページを見る限りでは、フィールド値と固定値を比較する事は出来てもフィールド値どうしの比較は出来ない様に見えました。 フィールド値どうしの比較が可能であるならば、その方法を教えていただけませんでしょうか？ ### hamee_sys — 2020/02/28 ご質問ありがとうございます。 検索時に指定はできません。 検索結果に対して上述の通り不一致を検出してください。 以上、ご質問へのご回答となりますがその他ご不明点がございましたらお気軽にお申し出くださいませ。 ### 世川　紘平 — 2020/02/28 ご回答ありがとうございます。 検索時には指定出来ないとのこと、承知いたしました。 --- # API連携を用いてできることの確認 URL: https://developer.next-engine.com/questions/1374/ **投稿者:** 吉川　快里　**日時:** 2019/12/19 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPI連携を用いてできることの確認をしたいです。 やりたいこと 自社ECサイトにNE連携用アプリ(Java バッチ)を作成し、 ユーザ認証、アクセストークン要求、在庫連携をさせる。 自社ECサイトでNE連携用アプリを定期間隔で起動させる 　↓ NE連携用アプリからNEへのユーザ認証要求を行う `https://base.next-engine.org/users/sign_in/` この時、「client_id」と「Redirect URI」を渡す(GET) 　↓ NEのログイン画面が自動的に表示される(？)　サンプルソースを参考に実装しましたがブラウザ表示されない NEへのログインがされていれば、 NEからリダイレクトURI＋「uid」、「state」が返却される(GET) 　↓ NE連携用アプリから「uid」、「state」、「client_id」、「client_secret」を使って アクセストークン要求を行う(POST) `https://api.next-engine.org/api_neauth` NEから「access_token」、「refresh_token」が返却される(レスポンス) 　↓ NE連携用アプリから「access_token」、「refresh_token」を使って 在庫連携APIを呼び出す --- ## 回答 (11件) ### hamee_sys — 2019/12/24 認証部分については下記のページを参考にしてください。 [https://developer.next-engine.com/api/auth](https://developer.next-engine.com/api/auth) その後の流れですが、まず在庫マスタ検索APIを呼ぶことで現在の在庫情報を取得することができます。 また在庫入出庫履歴検索APIで在庫の入出庫履歴を取得することができます。 在庫更新につきましては商品マスタアップロードAPIで実現していただくことが可能です。 ### 吉川　快里（質問者） — 2019/12/24 回答ありがとうございます。 追加で質問です。 １．想定している機能には一度に複数の商品を登録するケースもあるのですが、 商品マスタアップロードAPIを使って複数個の商品を同時にアップロードすることは可能でしょうか？ ２．登録した商品の出品をとりさげたい場合はどのAPIを使えばいいでしょうか？ ### hamee_sys — 2020/01/06 1.同時にアップロードしていただくことは可能です。詳細はAPIリファレンスを参照ください。 2.取り下げは商品を非表示（下記ページのvisible_flg = 0）にすることでご対応していただくことができます。 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) ### 吉川　快里（質問者） — 2020/01/06 toriatukai_kbn=1で対応しようかと思っていたのですが、ネクストエンジン的にはvisible_flg = 0にする方が推奨なのでしょうか？ 良ければ理由なども教えて頂きたいです。 ### hamee_sys — 2020/01/06 toriatukai_kbn=1 でも対応可能です。 用途に応じて使い分けください。どちらもデータとして残るので伝票には登録可能です。 visible_flg 非表示に設定することで、検索結果から表示されなくなり、在庫連携の解除が行われます。 受注伝票、発注伝票、仕入伝票に入力することは可能です。 ※在庫連携を解除する場合は visible_flgを利用ください。 toriatukai_kbn 　0：取扱中 　1、2の場合、自動発注計算の対象外です。 　取扱区分によって、受注伝票の商品明細行の色が異なります。 ※両フィールド共に商品が削除されるわけではないため、モールより商品が取り下げられるわけではありません。あらかじめご了承ください。 visible_flgの場合、在庫連携されなくなるのでモールに在庫がなくなれば、売れなくなります。 toriatukai_kbnの場合、自動発注が行われなくなります。ただし手動での発注は依然可能です。 ### 吉川　快里（質問者） — 2020/01/06 モールより商品が取り下げられるわけではありません とありますが、visible_flg=0又はtoriatukai_kbn=1に設定したとしても各モールで商品が購入される可能性があるということでしょうか？ 設定した時点で各モールでの販売が中止されるステータスは存在しますか？ ### hamee_sys — 2020/01/06 >visible_flg=0又はtoriatukai_kbn=1に設定したとしても各モールで商品が購入される可能性があるということでしょうか？ 左様でございます。 >設定した時点で各モールでの販売が中止されるステータスは存在しますか？ ございません。 完全に取り消すにはモールにて直接商品を取り下げ、メイン機能で商品マスタの削除処理を行う必要があります。 または在庫を0にした後、visible_flg=0 にしていただくことでも対応が可能ですが、この場合モールで商品が取り下げられているわけではないので、 モールの設定にて在庫が0でも販売可能な設定であれば、商品は売れてしまいます。 ### 吉川　快里（質問者） — 2020/01/06 >自動発注が行われなくなります。ただし手動での発注は依然可能 自動発注や手動での発注とはどのような操作のことでしょうか？ >モールで商品が取り下げられているわけではない モールには在庫が0の商品が表示されてしまっているということでしょうか？ >モールの設定にて在庫が0でも販売可能な設定であれば、商品は売れてしまいます モールに在庫が存在しない状態で商品が売れてしまう、とはどのような状況を想定されているのでしょうか？ ### hamee_sys — 2020/01/06 ＞自動発注や手動での発注とはどのような操作のことでしょうか？ 発注についてはこちらを参照ください。 [https://manual.next-engine.net/main/product/prd_hatchu-siire/24247/](https://manual.next-engine.net/main/product/prd_hatchu-siire/24247/) ＞モールには在庫が0の商品が表示されてしまっているということでしょうか？ ＞モールに在庫が存在しない状態で商品が売れてしまう、とはどのような状況を想定されているのでしょうか？ 取り下げられていないというのは、NE側にて非表示処理されようとも、その変更がモールに反映されないという意味合いです。 その際モールがどのような挙動をするかという可能性に今回言及いたしました。 具体的にモールで在庫0の商品が表示されるのか、在庫が存在しない状態で商品を売ることが可能か否かにつきましてはそれぞれのモール側の挙動に依拠しますので、 ネクストエンジン側にてこれ以上の説明を加えることは控えさせていただきます。 ### 吉川　快里（質問者） — 2020/01/07 在庫数を0にする際はzaiko_suで調整するという認識ですが、この場合モールの在庫数も加減されているのでしょうか？ 実際の在庫数はどの値で確認できますか？ 現時点での認識では、 在庫を0にした後にvisible_flg=0にするので在庫連携が行われなくなり、追加で商品が補充されないという認識なのですが合ってますでしょうか？ ### hamee_sys — 2020/01/14 はい、ご認識通りです。 先述の通り、「在庫を0にした後、visible_flg=0 にしていただくこと」にご注意くださいませ。 --- # 受注伝票にある自動送信停止処理の登録情報について URL: https://developer.next-engine.com/questions/1375/ **投稿者:** アプリi8uxN3si　**日時:** 2019/12/20 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 ご担当者様 受注伝票の メニュー > 自動送信停止処理（添付画面） で登録した情報は、APIで取得できないのでしょうか？ 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2019/12/24 恐れ入りますが、APIではこちらの状態を取ることはできません。 ### アプリi8uxN3si（質問者） — 2019/12/31 ご回答ありがとうございます。 --- # 「引当待ち」から「印刷待ち」になるまでの時間について URL: https://developer.next-engine.com/questions/1381/ **投稿者:** 八木孝憲　**日時:** 2019/12/26 **カテゴリ:** その他 「引当待ち」から「印刷待ち」になるまでの時間について以下の点ご教示いただきたいです。 ・12/26の13時～17:30頃にテスト環境で受注伝票を作成し 引当待ちまで進めたのですが、30分経過しても印刷待ちまでステータスが進みませんでした。 こちらはテスト環境だから時間がかかっており、本番環境は短時間でステータスが進むのでしょうか？ ・本番環境において、引当待ちから印刷待ちまで平均何分ぐらいで進んでいるかどうか分かりますでしょうか？ ・また遅くなる要因がございましたら、ご教示ください。 --- ## 回答 (4件) ### hamee_sys — 2020/01/06 引き当てる在庫が十分にあるかまずはご確認ください。 在庫がない場合、印刷待ちに遷移しません。 また平均推移時間の基準は特に設けておりません。 ご理解のほどよろしくお願いいたします。 ### 八木孝憲（質問者） — 2020/01/06 在庫は十分ございます。(夕方16時以降ぐらいから時間が掛かるようになっていた気がします。) 12/26の13時～17:30頃の間でシステム上で負荷が高い状態はありましたでしょうか？ ※負荷が高いため時間が掛かっていたということであれば、納得しますが 特に要因がなく本番環境でも起こりうるようであれば、使い物になりません。 ### hamee_sys — 2020/01/07 在庫がある、入金されてるなど条件が揃えば数分で状態遷移することがほとんどです。 テスト環境は本番よりは性能が劣りますが、本番でもたくさんの企業様がご利用して運用しております。 とはいえ、サーバの負荷状態により時間は前後することもございます。 お問い合わせの情報だけでは曖昧ですが、在庫以外に条件が揃ってないかった可能性はございませんか（例えば入金待ちになってた、など） 12/26の時点で、テスト環境が特に高負荷であることは確認できておりません。 よろしくお願いします。 ### 八木孝憲（質問者） — 2020/01/08 ご回答ありがとうございます。 一旦状況注視します。 --- # 私がしたいことは、審査が必要でしょうか。 URL: https://developer.next-engine.com/questions/1382/ **投稿者:** つかちょん　**日時:** 2020/01/05 **カテゴリ:** ネクストエンジンAPIについて 私はネクストエンジン のAPIを利用させていただき、 ある伝票番号を指定してたら、受注分類タグにあるタグを追加や削除してくれるバッチプログラムを作りたいと考えております。 自社のみで利用する想定なので、アプリ化するというよりも自社プログラムからネクストエンジン に対してapiを叩いて処理をさせていただきたいと考えております。 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2020/01/06 APIをご利用の際はかならずアプリの作成が必要となります。 そのアプリを貴社の環境上に構築していただくことで自社プログラムのように使っていただくことが可能かと存じます。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) 詳しくはこちらのマニュアルを参照くださいませ。 自社でのみご利用の場合、アプリの販売形態にて「特定の企業に公開」を選択ください。 ### つかちょん（質問者） — 2020/01/08 ご回答ありがとうございます。 承知いたしました。 では、記載してくださっておりますURLを元に作成させていただきます。 --- # 受注伝票検索について URL: https://developer.next-engine.com/questions/1384/ **投稿者:** 吉川　快里　**日時:** 2020/01/07 **カテゴリ:** ネクストエンジンAPIについて リファレンスを見ていていくつか分からない点があったので質問させていただきます。 １．receive_order_dateがreceive_order_creation_dateよりも以前の日時になる可能性はありますでしょうか？（受注されてから伝票が作成されるまでに明らかなタイムラグはあるのか？） ２．receive_order_last_modified_null_safe_dateがreceive_order_cancel_date以後になる可能性はありますでしょうか？（商品がキャンセルされた後も何らかの要因で伝票が更新されることはあるのか？） ご教授いただけますと幸いです。 --- ## 回答 (1件) ### hamee_sys — 2020/01/14 1. 可能性はございます。 2. こちらも可能性がございます。 --- # 受注伝票で取得できる値について URL: https://developer.next-engine.com/questions/1387/ **投稿者:** 吉川　快里　**日時:** 2020/01/10 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 ヤフーオークションに商品を出品し、ヤフーオークション固有の情報を取得したいと考えております。 そこで、ヤフーオークションにて商品が購入された際、 オークションidと購入者のyahoo_idをネクストエンジンAPIを用いて取得することは可能でしょうか？ 可能でしたらどのAPI(受注伝票、受注明細、受注伝票オプション)を用いて取得するのか、ご教授いただけますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/01/20 上記のフィールドを取得することはできません。よろしくお願いします。 --- # access_token、reflresh_tokenの取得方法について URL: https://developer.next-engine.com/questions/1389/ **投稿者:** 北川裕之　**日時:** 2020/01/14 **カテゴリ:** ネクストエンジンAPIについて Javaアプリでネクストエンジンとの連携を実装中です。 uid、state、client_id、client_secretは取得できておりますが、 「access_tokenの取得」に倣ってPOSTしてもJavaアプリ側でエラーとなります。 下記リファレンスは確認済み [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth)　 ■質問１． 　考えられるエラー原因は何かありますでしょうか ■質問２． 　Javaのサンプルソースを提供頂けないでしょうか POSTデータ詳細 　URL：[https://api.next-engine.org/api_neauth/](https://api.next-engine.org/api_neauth/) 　param：uid、state、client_id、client_secret エラー内容 　java.net.MalformedURLException: no protocol: --- ## 回答 (1件) ### hamee_sys — 2020/01/23 ■質問１． 　考えられるエラー原因は何かありますでしょうか >こちらでは個々のソースコードの原因の特定はお答えし兼ねます。 >一度cURLにてお試しください、仮に正常に返ってくるようであればプログラムの見直しをお願いいたします。 ■質問２． 　Javaのサンプルソースを提供頂けないでしょうか >大変恐縮ですが、サンプルのソースコードはございません。 --- # ネクストエンジンへの受注データの自動連携について URL: https://developer.next-engine.com/questions/1390/ **投稿者:** インターファクトリー　**日時:** 2020/01/16 **カテゴリ:** ネクストエンジンAPIについて ご担当者様 いつもお世話になっております。 インターファクトリーの林と申します。 弊社のECプラットフォーム「ebisumart」にてネクストエンジンと連携させていただいておりますが 現在の機能としてはメールでの受注取込で連携しており、APIによる自動連携ができていない状況です。 今回弊社にてご提案中のお客様よりAPIによる受注データの自動連携のご要望が出てきまして 追加の開発を検討しているのですが、 その場合下記ページなどを参照しながら弊社側のみの開発で実装は可能でしょうか。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) お客様側からは、ebisumartで作成した受注データを ネクストエンジン側へAPIにて自動連携したいとご要望いただいております。 上記検討進めていきたいと考えておりますので お忙しいところ恐縮ですが、実装可否や開発手順などご教示いただけますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/01/20 要件にもよりますが、貴社の受注を自動でネクストエンジンへ連携することは貴社側の開発で実現は可能でございます。 受注連携を行うには最初の登録は受注伝票アップロード(/api_v1_receiveorder_base/upload) を利用くださいませ。 その後の更新に、受注伝票更新(/api_v1_receiveorder_base/update)、受注伝票一括更新(/api_v1_receiveorder_base/bulkupdate) を利用ください。 開発の手順としてAPIを使用するためにアプリを作成していただく必要がございます、下記のページを参照くださいませ。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) --- # アプリとＡＰＩの関連性 URL: https://developer.next-engine.com/questions/1391/ **投稿者:** 十亀　弘　**日時:** 2020/01/16 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンが提供するＡＰＩを使って、自社システムから、在庫情報の確認や変更反映を行いたいのですが、 それでもアプリを作る必要があるのでしょうか？ ＡＰＩを使いたいだけなのに、アプリを作成しなければいけない理由が理解できません。 ＡＰＩとアプリがセットになる理由を教えてください。 --- ## 回答 (1件) ### hamee_sys — 2020/01/20 アプリのリリース時は弊社側の審査が必要となります。 APIを使うための認証認可をアプリを通じて行っておりますので、アプリとAPIセットとなります。 --- # ＡＰＩの仕様について URL: https://developer.next-engine.com/questions/1392/ **投稿者:** 十亀　弘　**日時:** 2020/01/16 **カテゴリ:** ネクストエンジンAPIについて エクセルＶＢＡからネクストエンジンＡＰＩを使って、在庫数変更などの処理を行いたいのですが、物理的に可能なのでしょうか？ それとも、ネクストエンジンにログインしてアプリを呼び出さないとＡＰＩが使えないのでしょうか？ ＪａｖａのライブラリをＶＢＡに読み解いて、コーディングすれば物理的に可能ではないかと考えたのですが、私の勘違いでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/01/20 >エクセルＶＢＡからネクストエンジンＡＰＩを使って、在庫数変更などの処理を行いたいのですが、物理的に可能なのでしょうか？ はい、特に言語による縛りはございません。VBAはSDKが用意されていないだけであり、他言語同様APIを問題なく使っていただけます。 ただしVBAのバージョン差による挙動やどのバージョンを使えば動作するかなどのサポートは一切ございませんのでご注意くださいませ。 --- # APIを用いた商品の一括登録について URL: https://developer.next-engine.com/questions/1393/ **投稿者:** 吉川　快里　**日時:** 2020/01/17 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) こちらのページには単体の商品登録のみで、複数の場合が記載されていませんでしたので、質問させていただきます。 商品を一括で新規登録する際は、どのような形式でAPIにパラメータを渡せばいいのでしょうか？ ヘッダー、各商品のパラメータごとにCSVの改行コードを挿入する感じでしょうか？ ご教授いただけると幸いです。 --- ## 回答 (3件) ### hamee_sys — 2020/01/20 リファレンスにございます通り、dataにてメイン機能でアップロードされる際の形式と同じように複数データを作っていただくことでアップロードしていただけます。 CSVの中身はメイン機能とAPIでまったく同一でございます。 ### 吉川　快里（質問者） — 2020/01/21 `syohin_code,sire_code,jan_code,maker_name,maker_kana,maker_jyusyo,maker_yubin_bangou,kataban,iro,syohin_name,gaikoku_syohin_name,syohin_kbn,toriatukai_kbn,genka_tnk,hyoji_tnk,baika_tnk,gaikoku_baika_tnk,kake_ritu,omosa,haba,okuyuki,takasa,yusou_kbn,syohin_status_kbn,hatubai_bi,zaiko_teisu,hachu_ten,lot,keisai_tantou,keisai_bi,bikou,daihyo_syohin_code,visible_flg,mail_tag,tag,location,mail_send_flg,mail_send_num,gift_ok_flg,size,org_select1,org_select2,org_select3,org_select4,org_select5,org_select6,org_select7,org_select8,org_select9,org_select10,org1,org2,org3,org4,org5,org6,org7,org8,org9,org10,org11,org12,org13,org14,org15,org16,org17,org18,org19,org20,maker_kataban,zaiko_threshold,orosi_threshold,hasou_houhou_kbn,hasoumoto_code,zaiko_su,yoyaku_zaiko_su,nyusyukko_riyu,hit_syohin_alert_quantity,nouki_kbn,nouki_sitei_bi,syohin_setumei_html,syohin_setumei_text,spec_html,spec_text,chui_jiko_html,chui_jiko_text,syohin_jyotai_kbn,syohin_jyotai_setumei,category_code_yauc,category_text,image_url_http,image_alt\r\nTestP001,9999,,,,,,,,登録時必須,,0,0,120000,,150000,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,\r\nTestP001,9999,,,,,,,,登録時必須,,0,0,120000,,150000,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,` data=には上記のような形式の文字列をPOSTするという認識で合ってますでしょうか？ ### hamee_sys — 2020/01/31 左様でございます。 --- # ネクストエンジンのAPIがどうもおかしいです。 URL: https://developer.next-engine.com/questions/1394/ **投稿者:** 今西　健太　**日時:** 2020/01/20 **カテゴリ:** ネクストエンジンAPIについて 例） 伝票番号：250842 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でリクエストを送ると 1188件がヒットし、伝票番号：250842も検索結果として取得でき 取得した　receive_order_row_last_modified_newest_date　の値も　”2020-01-15 15:52:30”　となっている $query_array['receive_order_id-eq'] = 250842 でリクエストを送ると　この伝票のみが取得できるが 取得した　receive_order_row_last_modified_newest_date　の値も　”2015-04-27 17:42:51”　となっている なぜ　 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でヒットするのか 2020-01-16 11:36:03　の場合10000件がヒットするが、上記のように、本来ヒットしてはいけないデータが多数存在しているかと思います 至急回答をお願いいたします。 --- ## 回答 (8件) ### hamee_sys — 2020/01/20 同じフィールドの絞り込み条件を複数記載されますと、新しい条件が古い条件を上書きします。 複数お使いになられたい場合は別々で抽出していただき、その後データの和（差）を求めていただくようお願いいたします。 ### 今西　健太（質問者） — 2020/01/21 下記、メールにて問い合わせをし、いただいた回答について、再度確認があります。 問い合わせさせていただいた内容と、いただいた回答では説明できていないと思います。 確認をお願いします。 ------------------------------- ■問い合わせ内容 伝票番号：250842 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でリクエストを送ると 1188件がヒットし、伝票番号：250842も検索結果として取得でき 取得した　receive_order_row_last_modified_newest_date　の値も　”2020-01-15 15:52:30”　となっている $query_array['receive_order_id-eq'] = 250842 でリクエストを送ると　この伝票のみが取得できるが 取得した　receive_order_row_last_modified_newest_date　の値も　”2015-04-27 17:42:51”　となっている なぜ　 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でヒットするのか 2020-01-16 11:36:03　の場合10000件がヒットするが、上記のように、本来ヒットしてはいけないデータが多数存在しているかと思います 至急回答をお願いいたします。 ■いただいた回答 同じフィールドの絞り込み条件を複数記載されますと、新しい条件が古い条件を上書きします。 複数お使いになられたい場合は別々で抽出していただき、その後データの和（差）を求めていただくようお願いいたします。 ------------------------------- あらためて検証した結果を追記します。 ＊エンドポイントは/api_v1_receiveorder_row/searchです。 ■１：回答について １） receive_order_row_last_modified_newest_date-gte　=　2020-01-15 15:52:30 receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-16 00:00:00以下の注文明細 結果=1269件 ２） receive_order_row_last_modified_newest_date-gte　=　2020-01-16 11:36:09 receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-16 11:36:09以上2020-01-16 00:00:00以下の注文明細 結果=0件 ３） receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-16 00:00:00以下の注文明細 結果=10000件 ⇒いただいた回答の「新しい条件が古い条件を上書きします」であれば、上記３通りとも、最後の条件が同じですので、 同じ結果になるはずですが、やはり、そのようなことは無く、想定通りFrom～Toの条件となっていると思われます。 ------- ①「新しい条件が古い条件を上書きする」ことはなく、From～Toの条件となるで良いか確認をお願いします。 ------- ■２：問い合わせについて再掲 １） receive_order_row_last_modified_newest_date-gte　=　2020-01-15 15:52:30 receive_order_row_last_modified_newest_date-lte　=　2020-01-15 15:52:30 ⇒受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-15 15:52:30以下の注文明細 結果=1188件 ＊伝票暗号：250842　も検索結果として取得できた このとき、伝票番号：250842の「　receive_order_row_last_modified_newest_date　」の値は「　2020-01-15 15:52:30　」となっていた ２） receive_order_id-eq = 250842 ⇒伝票番号が250842の注文明細 で取得すると、件数は２件「　receive_order_row_last_modified_newest_date　」の値は「　2015-04-27 17:42:51　」となっていた ３) 伝票番号が250842の画面上の表示は、最終更新日時「　2015-04-27 17:42:51　」である ------- ①受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-15 15:52:30以下の注文明細　という条件であれば、伝票番号：250842は検索対象とならないはず、なぜ、検索されてしまうのか ⇒ 本来検索対象とならないはずのデータが検索対象となってしまっていると思われます。 秒間で1万件以上の更新はありえません。 ------- ------- ②検索の条件が異なるだけで、同じ伝票番号のデータが異なるのはなぜか ------- ------- ③1月14までは正常だったのに、1/15以降上記のような状況となっている、当方のシステムでは、検索対象とする日付の指定を含む当該ソースに変更は無い、なぜ1/15以降で発生しているのか ------- ### hamee_sys — 2020/01/21 申し訳ございません。こちらの案内が至りませんでした。 Amazonのデータ保護ポリシー対応のため、1/10より直近のデータをマスク化させていただいております。 1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 お手数ではございますが、購入者名がマスク化されているデータに関しましては、その点をご顧慮していただけますよう、よろしくお願いします。 なお、このマスク化はAmazonの要請によるものであり、今後も起こり続けます。 ### 今西　健太（質問者） — 2020/01/21 変更後の仕様を掲示して貰えますか？ またこちらの投稿を公開に変更して貰えますか？ あと弊社から草薙と言う名前で別途質問をしておりますので、 そちらも返答お願いします。 ### 今西　健太（質問者） — 2020/01/22 回答をいただいたのですが、再度、問い合わせをさせていただきます。 ＞1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 ⇒ ①マスクをしただけで、なぜ本来検索結果とされるはずのないデータが検索結果として取得できるのですか？ ②マスクを行うと、検索する条件によって、取得できるデータの値が異なるのはなぜですか ③現在発生している不具合、　１・検索にて正常にデータが抽出できない。　２・検索条件によって同じ伝票のデータが異なる　これら以外にも影響はありますか ＞マスク化はAmazonの要請によるものであり、今後も起こり続けます。 ⇒ ③そもそもマスク化とはなんですか？　具体的に行った変更点について説明をお願いします。 ④マスク化を行うとデータはどうなるのですか？ ⑤マスク化を行った後、データを正しく抽出する方法を提示してください。 その他 ⑥マスク化を行うことはいつから予定されていたのですか？ ⑦今回の仕様変更について事前に全く告知されていないのはなぜですか？ ＊何がどうなっているのか全く分からないので、何をどう対応してよいのかが全く分かりません。 ### 今西　健太（質問者） — 2020/01/22 後、こちらの件を公開設定に変更してください。 ### 今西　健太（質問者） — 2020/01/27 こちらの質問の返答は頂けますでしょうか？ 回答完了としているのか、何かしら対応中なのか解らないと 当方側も次の対応がしかねます。 宜しくおねがいします。 ### hamee_sys — 2020/01/27 まず質問事項に回答いたします。 ＞①マスクをしただけで、なぜ本来検索結果とされるはずのないデータが検索結果として取得できるのですか？ マスク化にて伝票の更新日時フィールドが更新されたためです。 ＞②マスクを行うと、検索する条件によって、取得できるデータの値が異なるのはなぜですか 伝票の更新日時の値が変更されてしまうためです。 ＞③現在発生している不具合、　１・検索にて正常にデータが抽出できない。　２・検索条件によって同じ伝票のデータが異なる　これら以外にも影響はありますか 今後も更新日時がマスク化のタイミングで更新されることがございます。 ＞④⑥⑦ ネクストエンジンログイン後のメイン機能にて、以前より告知をさせていただいております。 詳しい内容に関しましてはそちらをご参照くださいませ。 ＞⑤マスク化を行った後、データを正しく抽出する方法を提示してください。 こちらは大変恐縮ですが、更新日時での絞り込みの場合、予期せぬタイミング（マスク化）で伝票が更新される仕様となっております。 その点をご了承くださいませ。 次に ＞同じフィールドの絞り込み条件を複数記載されますと、新しい条件が古い条件を上書きします。 こちらは同じフィールドにて同じ比較演算子を使ったこと際に発生する事象のため、こちらの案内ミスでございます。 今回のgte,lteによる絞り込みは質問者様のおっしゃる通りFrom～Toの条件となります。 また ＞伝票番号：250842の「　receive_order_row_last_modified_newest_date　」の値は「　2020-01-15 15:52:30　」となっていた ＞伝票番号が250842の注文明細 ＞で取得すると、件数は２件「　receive_order_row_last_modified_newest_date　」の値は「　2015-04-27 17:42:51　」となっていた こちらについては、受注伝票と受注明細の最終更新日は常に同期されている保証がございません。同期が遅れることもございますので、 他の検索条件も加えていただけますと幸いです。 回答が遅れてしまいましたが、何卒よろしくお願いいたします。 またこちらの投稿を公開とさせていただきます。 --- # アプリの種類の選択について URL: https://developer.next-engine.com/questions/1395/ **投稿者:** 十亀　弘　**日時:** 2020/01/20 **カテゴリ:** ネクストエンジンAPIについて 【アプリの種類】を【自社サービスのアプリ】に設定することで、 ネクストエンジンのインターフェイスを通さずに、例えばエクセルなどからＡＰＩにアクセスすることが可能になるという認識で概ね間違えないでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2020/01/31 左様でございます。 ### 十亀　弘（質問者） — 2020/03/20 かしこまりました。 それでは、アクセストークンとリフレッシュトークンを発行していただきたいのですが、 どのような流れで進めればよいか教えてください。 --- # APIの不具合について URL: https://developer.next-engine.com/questions/1399/ **投稿者:** 草薙　富人　**日時:** 2020/01/21 **カテゴリ:** ネクストエンジンAPIについて 回答をいただいたのですが、再度、問い合わせをさせていただきます。 ＊非公開にしていると、全く回答がもらえないので、公開にして問い合わせをさせていただきます。 ＞1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 ⇒ ①マスクをしただけで、なぜ本来検索結果とされるはずのないデータが検索結果として取得できるのですか？ ②マスクを行うと、検索する条件によって、取得できるデータの値が異なるのはなぜですか ③現在発生している不具合、　１・検索にて正常にデータが抽出できない。　２・検索条件によって同じ伝票のデータが異なる　これら以外のも影響はありますか ＞マスク化はAmazonの要請によるものであり、今後も起こり続けます。 ⇒ ③そもそもマスク化とはなんですか？　具体的に行った変更点について説明をお願いします。 ④マスク化を行うとデータはどうなるのですか？ ⑤マスク化を行った後、データを正しく抽出する方法を提示してください。 その他 ⑥マスク化を行うことはいつから予定されていたのですか？ ⑦今回の仕様変更について事前に全く告知されていないのはなぜですか？ ＊何がどうなっているのか全く分からないので、何をどう対応してよいのかが全く分かりません。 －いただいた回答－－－－－－－－－－－－－－ Amazonのデータ保護ポリシー対応のため、1/10より直近のデータをマスク化させていただいております。 1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 お手数ではございますが、購入者名がマスク化されているデータに関しましては、その点をご顧慮していただけますよう、よろしくお願いします。 なお、このマスク化はAmazonの要請によるものであり、今後も起こり続けます。 －－－－－－－－－－－－－－－ 以前の問い合わせ内容 --------------------------------------------------------------------------------------------------------------------- 下記、メールにて問い合わせをし、いただいた回答について、再度確認があります。 問い合わせさせていただいた内容と、いただいた回答では説明できていないと思います。 確認をお願いします。 ------------------------------- ■問い合わせ内容 伝票番号：250842 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でリクエストを送ると 1188件がヒットし、伝票番号：250842も検索結果として取得でき 取得した　receive_order_row_last_modified_newest_date　の値も　”2020-01-15 15:52:30”　となっている $query_array['receive_order_id-eq'] = 250842 でリクエストを送ると　この伝票のみが取得できるが 取得した　receive_order_row_last_modified_newest_date　の値も　”2015-04-27 17:42:51”　となっている なぜ　 $query_array['receive_order_row_last_modified_newest_date-gte'] = ”2020-01-15 15:52:30”; $query_array['receive_order_row_last_modified_newest_date-lte'] = ”2020-01-15 15:52:30”; でヒットするのか 2020-01-16 11:36:03　の場合10000件がヒットするが、上記のように、本来ヒットしてはいけないデータが多数存在しているかと思います 至急回答をお願いいたします。 ■いただいた回答 同じフィールドの絞り込み条件を複数記載されますと、新しい条件が古い条件を上書きします。 複数お使いになられたい場合は別々で抽出していただき、その後データの和（差）を求めていただくようお願いいたします。 ------------------------------- あらためて検証した結果を追記します。 ＊エンドポイントは/api_v1_receiveorder_row/searchです。 ■１：回答について １） receive_order_row_last_modified_newest_date-gte　=　2020-01-15 15:52:30 receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-16 00:00:00以下の注文明細 結果=1269件 ２） receive_order_row_last_modified_newest_date-gte　=　2020-01-16 11:36:09 receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-16 11:36:09以上2020-01-16 00:00:00以下の注文明細 結果=0件 ３） receive_order_row_last_modified_newest_date-lte　=　2020-01-16 00:00:00 ⇒受注伝票・受注明細の最終更新日が2020-01-16 00:00:00以下の注文明細 結果=10000件 ⇒いただいた回答の「新しい条件が古い条件を上書きします」であれば、上記３通りとも、最後の条件が同じですので、 同じ結果になるはずですが、やはり、そのようなことは無く、想定通りFrom～Toの条件となっていると思われます。 ------- ①「新しい条件が古い条件を上書きする」ことはなく、From～Toの条件となるで良いか確認をお願いします。 ------- ■２：問い合わせについて再掲 １） receive_order_row_last_modified_newest_date-gte　=　2020-01-15 15:52:30 receive_order_row_last_modified_newest_date-lte　=　2020-01-15 15:52:30 ⇒受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-15 15:52:30以下の注文明細 結果=1188件 ＊伝票暗号：250842　も検索結果として取得できた このとき、伝票番号：250842の「　receive_order_row_last_modified_newest_date　」の値は「　2020-01-15 15:52:30　」となっていた ２） receive_order_id-eq = 250842 ⇒伝票番号が250842の注文明細 で取得すると、件数は２件「　receive_order_row_last_modified_newest_date　」の値は「　2015-04-27 17:42:51　」となっていた ３) 伝票番号が250842の画面上の表示は、最終更新日時「　2015-04-27 17:42:51　」である ------- ①受注伝票・受注明細の最終更新日が2020-01-15 15:52:30以上2020-01-15 15:52:30以下の注文明細　という条件であれば、伝票番号：250842は検索対象とならないはず、なぜ、検索されてしまうのか ⇒ 本来検索対象とならないはずのデータが検索対象となってしまっていると思われます。 秒間で1万件以上の更新はありえません。 ------- ------- ②検索の条件が異なるだけで、同じ伝票番号のデータが異なるのはなぜか ------- ------- ③1月14までは正常だったのに、1/15以降上記のような状況となっている、当方のシステムでは、検索対象とする日付の指定を含む当該ソースに変更は無い、なぜ1/15以降で発生しているのか ------- --- ## 回答 (3件) ### hamee_sys — 2020/01/31 こちらと同様の質問とお見受けしますので、クローズいたします。 [https://developer.next-engine.com/questions/1394](https://developer.next-engine.com/questions/1394) ### 草薙　富人（質問者） — 2020/01/31 こちらと同様と言われている投稿が、みれないのですが [https://developer.next-engine.com/questions/1394](https://developer.next-engine.com/questions/1394) ### hamee_sys — 2020/02/03 失礼いたしました。 こちら公開設定とさせていただきましたので、現在ご覧いただけます。 --- # APIの不具合について URL: https://developer.next-engine.com/questions/1401/ **投稿者:** 草薙　富人　**日時:** 2020/01/22 **カテゴリ:** ネクストエンジンAPIについて 回答をいただいたのですが、再度、問い合わせをさせていただきます。 ＊非公開にしていると回答を全く投稿していただけないようなので、公開にしておきます。 ＞1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 ⇒ ①マスクをしただけで、なぜ本来検索結果とされるはずのないデータが検索結果として取得できるのですか？ ②マスクを行うと、検索する条件によって、取得できるデータの値が異なるのはなぜですか ③現在発生している不具合、　１・検索にて正常にデータが抽出できない。　２・検索条件によって同じ伝票のデータが異なる　これら以外のも影響はありますか ＞マスク化はAmazonの要請によるものであり、今後も起こり続けます。 ⇒ ③そもそもマスク化とはなんですか？　具体的に行った変更点について説明をお願いします。 ④マスク化を行うとデータはどうなるのですか？ ⑤マスク化を行った後、データを正しく抽出する方法を提示してください。 今後について ⑥マスク化を行うことはいつから予定されていたのですか？ ⑦今回の仕様変更について事前に全く告知されていないのはなぜですか？ ＊何がどうなっているのか全く分からないので、何をどう対応してよいのかが全く分かりません。 －いただいた回答－－－－－－－－－－－－－－ Amazonのデータ保護ポリシー対応のため、1/10より直近のデータをマスク化させていただいております。 1/15よりAmazonに関連する全サーバーのデータをマスク化したために起きた現象と考えられます。 お手数ではございますが、購入者名がマスク化されているデータに関しましては、その点をご顧慮していただけますよう、よろしくお願いします。 なお、このマスク化はAmazonの要請によるものであり、今後も起こり続けます。 －－－－－－－－－－－－－－－ --- ## 回答 (1件) ### hamee_sys — 2020/01/31 こちらと同様の質問とお見受けしますので、クローズいたします。 [https://developer.next-engine.com/questions/1394](https://developer.next-engine.com/questions/1394) --- # 受注伝票検索APIにつきまして URL: https://developer.next-engine.com/questions/1402/ **投稿者:** 坪山　大輔　**日時:** 2020/01/22 **カテゴリ:** ネクストエンジンAPIについて 受注伝票検索において受注伝票リストを取得し、伝票番号を取得するバッチ処理を作成しております。 ネクストエンジン本体の受注伝票管理では確認待ち状態で2件存在しています。 APIではaccess_tokenとrefresh_tokenとfieldsを入力パラメータとして送信しましたが、 resultはsuccessでcountが0で返ってきます。 エンドポイントは以下のページのものを使用しております。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) また、uidやstateを取得する際のクライアントIDとクライアントシークレットはテスト環境設定のものを使用しております。 質問 ①エンドポイントのホストはテスト環境も本番も一緒でしょうか？ ②試用期間だと取得出来ないなどの制限はございますでしょうか？ ③受注伝票のステータスによって取得できなかったりしますでしょうか？ ご回答宜しくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2020/01/31 テスト環境の伝票は特に取得できないなどの制限はございません。またエンドポイントも本番と共通です。 特定のステータスが取得できないということもございません。 確認待ちの伝票はテスト環境の伝票でお間違いございませんか。 また参考までに本番データの取得が可能になるのはアプリの審査完了後となります。 ### 坪山　大輔（質問者） — 2020/01/31 お忙しいところご返答有難うございます。 >確認待ちの伝票はテスト環境の伝票でお間違いございませんか。 自分が確認している受注伝票ページがテスト環境なのか本番環境なのかが判断できないので、その確認方法をご教授ください。 私としては試用期間=テスト環境という認識でおりました。 受注伝票を確認しているURLは以下になります。 [https://ne95.next-engine.com/Userjyuchu](https://ne95.next-engine.com/Userjyuchu) >参考までに本番データの取得が可能になるのはアプリの審査完了後となります。 アプリの状況は「審査承認済」となっております。 本番環境への接続ができるかどうか、uidとstate取得の為に [https://base.next-engine.org/users/sign_in/?client_id=AAA&secret=BBB](https://base.next-engine.org/users/sign_in/?client_id=AAA&secret=BBB) へ本番用のクライアントID（AAA）とクライアントシークレット(BBB)で接続を試みましたが、 [https://base.next-engine.org/apps/connection_error/](https://base.next-engine.org/apps/connection_error/) のエラーページに遷移し、 アプリの連携に失敗しました 指定したアプリが見つかりませんでした と表示されます。 「審査承認済」なのでuidとstateは取得できる認識ですが、なぜエラーとなるのでしょうか？ ### hamee_sys — 2020/02/03 ご回答が遅くなり誠に申し訳ございません。 先のご回答に一部誤りがございましたので、訂正も含めご回答いたします。 ■テスト環境につきまして 　・テスト環境はネクストエンジンログイン後の下部に 　　表示されておりますアイコンのうち「TEST(赤色)」の帯が 　　付いているものを指します 　　（アクセス後のURLは「[https://sandbox](https://sandbox)」から始まります） 　・アプリの販売を開始される前はテスト環境用のクライアントID 　　およびクライアントシークレットを用い、上記のテスト環境の 　　メイン機能に通信を行います 　・したがいまして、テスト環境用メイン機能に受注情報がない場合 　　データの取得はできかねます（「"count":"0"」で返ります） ■連携エラーのレスポンスにつきまして（訂正箇所） 　・本番環境のクライアントIDおよびクライアントシークレットに 　　つきましては、アプリの販売開始をされたあとに有効となるため 　　現状では、本番環境に通信を行いましてもエラーが返ります なお、原則すべての検証を上記テスト環境において実施していただいたあと 本番環境での最終確認を行っていただくようお願いいたします。 --- # 本番環境のクライアントIDとクライアントシークレット URL: https://developer.next-engine.com/questions/1404/ **投稿者:** 月島ファクトリー　**日時:** 2020/01/23 **カテゴリ:** ネクストエンジンAPIについて 申請が通り販売中のステータスに移行後 本番環境設定のクライアントIDとクライアントシークレットが利用可能と表示されました。 APIを呼び出していますがアプリが見つからないとのエラーが出てしまいます。 どのように対応したら良いでしょうか？ --- ## 回答 (2件) ### 月島ファクトリー（質問者） — 2020/01/23 申請が通り販売中のステータスに移行後 本番環境設定のクライアントIDとクライアントシークレットが利用可能と表示されました。 APIを呼び出していますがアプリが見つからないとのエラーが出てしまいます。 どのように対応したら良いでしょうか？ ### hamee_sys — 2020/01/31 設定＞アプリ＞利用ユーザ設定より ログインユーザにアプリの利用権限があるかご確認ください。 --- # Excel から ネクストエンジンAPI を利用したい URL: https://developer.next-engine.com/questions/1406/ **投稿者:** 妹尾　尚紀　**日時:** 2020/01/27 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 ネクストエンジンAPI を利用し、Excel から 商品情報の取得・在庫数の更新等を行いたいです。 ２点質問があります。 質問１： 以下のアプリ作成画面で、Redirect URI の設定ができますが、 Excel(VBA) から 設定した Redirect URI にアクセスすれば、API が利用できる認識で合っていますでしょうか？ [https://base.next-engine.org/apps/make/](https://base.next-engine.org/apps/make/) 質問２： 以下の開発環境構築・アプリ実装編を参照させて頂きました。 以下は、Java や PHP で API を利用する手順との認識で合っていますでしょうか？ [https://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd](https://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd) [https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4](https://qiita.com/hamee-dev/items/fd8b51eba26240b73bd4) お手数をお掛けしますが、ご回答の程よろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2020/01/31 1. 左様でございます。 2. こちらの記事は最新ではございませんので、参考までにご覧ください。 --- # NE側のサーバー時間を取得したい URL: https://developer.next-engine.com/questions/1411/ **投稿者:** 吉川　快里　**日時:** 2020/02/04 **カテゴリ:** ネクストエンジンAPIについて いつも大変お世話になっております。 お忙しい中目を通していただきありがとうございます。 APIを用いてデータを取得した時間をDBに保存したいと考えているのですが、API側とこちらのサーバーの時間がずれていますと問題があるため、 API側の現在のサーバー時刻を取得したいのですが、そのようなAPIは存在しますでしょうか？ --- ## 回答 (5件) ### hamee_sys — 2020/02/05 お問い合わせありがとうございます。 申し訳ございませんが、弊社APIサーバーの時間を取得する エンドポイントはございません。 なお、ご質問への質問となり大変恐縮ではございますが、 弊社APIサーバーの時間取得の目的はどのようなものでしょうか。 もし、差分を取得したいということでしたら、 最終更新日（xxx_last_modified_null_safe_date）を内部に 保存していただき、そこから差分を取得していただく方法が よろしいかと存じます。 ### 北川裕之 — 2020/02/06 最終更新日を内部保存し、それ以降に更新されたデータを取得することを想定しております。 下記QAにある通り、こちらの意図しないデータ更新もあるようです。 [https://developer.next-engine.com/questions/1394](https://developer.next-engine.com/questions/1394) 例えばｍAmazon指示によるマスク化対応後に「保存した最終更新日」で差分取得すると、 全件取得してしまうのではないでしょうか？ ### hamee_sys — 2020/02/06 マスク化など内部処理により最終更新日はオペレーションの有無に関わらず発生することがございます。 件数を減らし上書きしても問題なければこの「最終更新日」で処理しても問題ないとは思いますが、正確に特定の項目のみ変更があったものを「差分」と定義するのであれば、受注番号や明細番号、特定項目のNull/Emptyなどを、検索条件に加えていくことにはなってしまいます。 また、受注伝票の差分取得などでよくやる方法としましては、「受注分類タグ」を使う方法がございます。 1. 受注伝票検索→A処理を実行→「A処理済み」の受注分類タグを貼付 2. 受注伝票検索（条件:受注分類タグ「A処理済み」）→B処理を実行→「B処理済み」の受注分類タグを貼付 このように行うことで差分取得を行うことはできます。 もし実現しいことが異なるようでしたら、改めて実現したいことを記載の上ご質問くださいませ。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### 北川裕之 — 2020/02/06 ご回答ありがとうございます。 ネクストエンジンのAPIを利用して自社システムに受注情報を取り込む」際に下記対象を取得したいです。 １．新規受注 ２．キャンセルされた受注 こちらの想定としましては 　＜n回目の連携＞ 　　一定間隔でAPIを使って、前回API連携した日時より後に作成/更新された受注伝票/受注明細を取得 　　前回API連携した日時より後にキャンセルされた受注伝票を取得(注文キャンセル日で引き当て) 　　API連携した日時を保持 　＜n+1回目の連携＞ 　　前回API連携した日時を起点とし、n回目の連携と同様の処理を行う ### hamee_sys — 2020/02/06 ■新規受注について 初回取得時に受注日時を保持し、それより新しい伝票を検索するのはいかがでしょうか。 「receive_order_date」 こちら日時型となっておりますので、 receive_order_date-gte='yyyy-mm-dd hh:mm:ss'; で検索し、取得した最新の日時を保存。次回、この日時で検索。 ■キャンセルについて こちらは対象となる受注状態区分とキャンセル日時で検索するのはいかがでしょうか。 「receive_order_order_status_id」 「receive_order_cancel_date」 出荷済みの伝票がキャンセルされることはないのであれば受注状態区分を指定すると絞り込めます。 receive_order_cancel_date-gte='yyyy-mm-dd hh:mm:ss'; で検索し、取得した最新の日時を保存。次回、この日時で検索。 上記、お試しいただければ幸いです。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 --- # API連携について URL: https://developer.next-engine.com/questions/1414/ **投稿者:** 坂下　広樹　**日時:** 2020/02/06 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジン上に作成した「自社作成アプリ」を介して、ネクストエンジンと弊社POSシステムを連携し、 各ECサイトのネクストエンジン上の出荷確定データを、EC売上としてPOSシステムに取り込む運用を想定しています。 ただ、POSシステムはVPN接続の楽天クラウドで運用しています。 VPN接続の楽天クラウドには、外部システム連携用の光回線とファイヤーウォールを設置しています。 通常、ネクストエンジンのグローバルIPアドレスと使用するポート番号を、ファイアウォールに設定してもらう必要がありますが、 アプリを介して連携を行う場合、どのような設定を行えばよいのでしょう？ （ネクストエンジン側からはアプリのIPアドレスは公開していない、と回答をいただきました） --- ## 回答 (3件) ### hamee_sys — 2020/02/06 ご質問ありがとうございます。 他社様の事例ですが以下のようなPOS連携アプリがネクストエンジン上にございます。 [https://base.next-engine.org/apps/?t=145](https://base.next-engine.org/apps/?t=145) ネクストエンジン上の出荷確定データをAPI経由で取得するアプリを貴社にて開発いただければ、貴社管理下にネクストエンジンxPOS連携用アプリはございますので、楽天クラウドと外部システム連携するためのIPも指定できるものと思われます。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### 坂下　広樹（質問者） — 2020/02/06 ご回答ありがとうございます。 「IPも指定できる」と言いますと、そのIPをこちら側で把握するには、どうしたら良いのでしょうか？ ### hamee_sys — 2020/02/06 ご質問ありがとうございます。 データ連携については ネクストエンジン→【POS・ネクストエンジン連携アプリ】→楽天クラウド ネクストエンジン←【POS・ネクストエンジン連携アプリ】←楽天クラウド このようになり、POS・ネクストエンジン連携アプリは貴社環境（サーバー）下に配置されますので、このアプリの「IPアドレス」は貴社ルールに則り取得できるものと思われます。 参考までに、 【POS・ネクストエンジン連携アプリ】の役割 ・ネクストエンジンとのアクセス認証 ・ネクストエンジンとのAPI経由で通信（情報検索・登録） ・楽天クラウド外部連携との通信（POS検索・登録） このようになろうかと存じます。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 --- # 利用料金について URL: https://developer.next-engine.com/questions/1416/ **投稿者:** YI　**日時:** 2020/02/07 **カテゴリ:** ネクストエンジンAPIについて 初めて利用させていただきます。 現在、弊社基幹システムとネクストエンジンのAPI連携を検討しております。 「すべての企業に公開」タイプでアプリを開発した場合は、使用従量に関係なく無料で使用することが出来るという理解でよろしいでしょうか？ 連携させる基幹システムのメーカーによる、制限、限定等はございますか？ また、「すべての企業に公開」タイプでアプリを開発した場合でも、このような場合は課金される等のルールはございますか？ お忙しいところ恐れ入りますが、ご教示ください。 よろしくお願い申し上げます。 --- ## 回答 (6件) ### hamee_sys — 2020/02/07 ご質問ありがとうございます。 API利用料金について、現在公開アプリにつきましてはAPI料金はかかりません。 但し、公開アプリの販売価格は最低価格以上に設定していただく必要がございますのでご理解ください。 また、連携する基幹システムへの制限等ですが、原則こちらはございません。 但し、ご利用ユーザーさまに不利益なもの、運用影響を確認できたもの及び、当社規定によりネクストエンジンのご利用をご遠慮いただいた場合は、販売停止させていただく場合がございますことを予めご了承くださいませ。 [マニュアル](http://manual.next-e.jp/price/)も合わせてご確認くださいませ。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### YI（質問者） — 2020/02/10 お世話になっております。 ご回答いただき、誠にありがとうございました。 公開アプリの販売価格は最低価格についてですが、確認してみたところ初期費用、月額利用料共に0円～あると思います。 何か規定があるようでしたら、ご教示ください。 また、自社開発したアプリを自社で使用する場合も、利用料は発生するのでしょうか？ お忙しいところ恐れ入りますが、ご回答、よろしくお願い申し上げます。 引き続き、よろしくお願い致します。 ### hamee_sys — 2020/02/12 ご質問いただきありがとうございます。 公開アプリについては、原則最低価格（2020.2.10現在）3,000円となっております。 当社提供アプリ以外にも一部例外的に販売価格を調整しているアプリもございますが、そちらは各企業間で別途調整させていただいているものとなりますので、詳細のご回答は致しかねます。もしこちらご商談のご希望がある場合は、別途公式サイト「[お問い合わせ](https://next-engine.net/inquiry)」よりご連絡くださいませ。 自社開発したアプリを自社で使用する場合については、API利用料が別途かかります。 API利用料につきましては、[FAQ](https://developer.next-engine.com/faq)の「#審査・利用料金関連」よりご確認ください。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### YI（質問者） — 2020/03/09 お世話になっております。 初期費用の最低価格ですが、0円でも可能でしょうか？ また、最大利用可能ユーザー数決定についてのルールはございますか？ 最大利用可能ユーザー数　無制限 初期費用　0円 月額費用　3300円（税込） で登録されていたアプリがありましたので、質問です。 引き続き、よろしくお願い致します。 ### hamee_sys — 2020/03/09 ご質問ありがとうございます。 初期費用の有無は各社様でご設定いただけますのでご確認いただきましたとおり0円も可能です。 また、最大利用可能ユーザー数についても御社アプリのルールに沿って決定いただければと思います。 （無制限で月額固定なのか、固定ユーザー数で月額〜円なのか等） なお、月額費用についても一律購入初月は無料とさせていただいておりますのでご了承ください。 ※再購入については無料とはなりません。 以上、ご質問へのご回答とさせていただきますが その他ご不明点ございましたらお気軽にお申し出くださいませ。 ### YI（質問者） — 2020/03/09 ご回答いただき、ありがとうございました。 本件、承知致しました。 --- # 受注明細検索APIにて、特定の項目を検索条件に使用するとレスポンスが帰ってこない。 URL: https://developer.next-engine.com/questions/1419/ **投稿者:** API接続ID　**日時:** 2020/02/19 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております、ネクストエンジンAPIについてエラーが発生しているのですが、原因がわからないため質問をさせていただきます。 ＃状況 ・ログインのIDPWに間違いはなく、ログイン自体は成功している ・リフレッシュトークンの取得も正常に完了している ・取得項目は下記の通り 'receive_order_id' , 'receive_order_shop_cut_form_id' , 'receive_order_date' , 'receive_order_send_date' , 'receive_order_import_date' , 'receive_order_deposit_date' , 'receive_order_hope_delivery_date' , 'receive_order_send_plan_date' , 'receive_order_statement_delivery_instruct_printing_date' , 'receive_order_cancel_date' , 'receive_order_cancel_type_id' , 'receive_order_deposit_amount' , 'receive_order_delivery_cut_form_id' , 'receive_order_shop_id' , 'receive_order_delivery_name' , 'receive_order_delivery_id' , 'receive_order_payment_method_name' , 'receive_order_payment_method_id' , 'receive_order_total_amount' , 'receive_order_goods_amount' , 'receive_order_tax_amount' , 'receive_order_delivery_fee_amount' , 'receive_order_charge_amount' , 'receive_order_other_amount' , 'receive_order_point_amount' , 'receive_order_order_status_name' , 'receive_order_pic_name' , 'receive_order_gruoping_tag' , 'receive_order_confirm_check_id' , 'receive_order_worker_text' , 'receive_order_delivery_cut_form_note' , 'receive_order_picking_instruct' , 'receive_order_statement_delivery_text' , 'receive_order_note' , 'receive_order_hope_delivery_time_slot_name' , 'receive_order_purchaser_name' , 'receive_order_purchaser_kana' , 'receive_order_purchaser_tel' , 'receive_order_purchaser_zip_code' , 'receive_order_purchaser_address1' , 'receive_order_purchaser_address2' , 'receive_order_purchaser_mail_address' , 'receive_order_customer_id' , 'receive_order_customer_type_id' , 'receive_order_consignee_name' , 'receive_order_consignee_kana' , 'receive_order_consignee_tel' , 'receive_order_consignee_zip_code' , 'receive_order_consignee_address1' , 'receive_order_consignee_address2' , 'receive_order_gift_flag' , 'receive_order_deposit_type_id' , 'receive_order_credit_approval_type_id' , 'receive_order_credit_approval_amount' , 'receive_order_statement_delivery_printing_date' , 'receive_order_important_check_id' , 'receive_order_important_check_name' , 'receive_order_row_no' , 'receive_order_row_cancel_flag' , 'receive_order_row_goods_id' , 'receive_order_row_goods_name' , 'receive_order_row_goods_option' , 'receive_order_row_quantity' , 'receive_order_row_stock_allocation_quantity' , 'receive_order_row_stock_allocation_date' , 'receive_order_row_unit_price' , 'receive_order_row_sub_total_price' , 'receive_order_row_received_time_first_cost' , 'receive_order_row_wholesale_retail_ratio' , 'receive_order_hope_delivery_time_slot_id' , 'receive_order_temperature_id' , 'receive_order_business_office_stop_id' , 'receive_order_business_office_name' ・取得開始位置（offset）は0 ・wait_flagは1 ・検索条件に「receive_order_row_last_modified_newest_date-gte」を指定した場合、即座に応答が帰ってくる程度の件数 ・同じ日付で「receive_order_row_stock_allocation_date-gte」を指定すると、エラーとなる ・エラーとなったとき、レスポンスが一切ないため、メッセージコードも判明しない状況 ・１分経過した時点で強制的に遮断されたような動作をしている 上記の状態で、現在も続いています。 正常にアクセスできるときもあるのですが、頻繁にエラーが発生するため、お問い合わせさせていただきます。 調査、対処方法の方わかりましたら、よろしくお願いいたします。 --- # 複数商品が購入された受注伝票の一部がキャンセルされた場合の挙動 URL: https://developer.next-engine.com/questions/1421/ **投稿者:** 吉川　快里　**日時:** 2020/02/20 **カテゴリ:** ネクストエンジンAPIについて いつも大変お世話になっております。 複数の商品が購入された受注伝票の一部の商品がキャンセルされてしまった場合の挙動について質問させていただきます。 上記の場合、受注伝票のキャンセル日には値は入るのでしょうか？それとも伝票明細のキャンセルフラグが立つだけで、受注伝票のキャンセル日には何も値は入らないのでしょうか？ もし、受注伝票のキャンセル日に値が入るとすれば、一部の商品がキャンセルされた後にすべての商品がキャンセルされた場合はどのような挙動をするのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/03/16 ご回答が遅くなり申し訳ございません。 「受注キャンセル日」につきましては、受注伝票がキャンセルされた場合にのみ値が登録されます。 そのため一部の商品がキャンセルされた場合には、値は登録されず、 該当受注明細の「キャンセルフラグ」が立つのみでございます。 --- # WMS連携APIについて URL: https://developer.next-engine.com/questions/1431/ **投稿者:** 佐藤陽一郎　**日時:** 2020/03/02 **カテゴリ:** ネクストエンジンAPIについて APIを使用してWMS連携のI/F構築を検討しています。 (実現したいこと) 1.ネクストエンジン→WMSに商品マスタ、出荷指示や入荷予定のデータを渡したい。 2.WMS→ネクストエンジンへ入荷実績のデータを渡したい。 (確認したいこと) ・上記の連携処理が実現できる、対象のAPIを教えていただけますでしょうか。 ・以上のAPIについてデータの差分更新、データに洗い替えは可能でしょうか。 以上、ご確認のほどお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2020/03/02 サポートへもお問い合わせいただいているかと存じますが、内容を確認させていただき、 回答が準備でき次第、個別にご連絡させていただきますので、今しばらくお待ちくださいませ。 --- # NEから他システムへの配送番号連携 URL: https://developer.next-engine.com/questions/1435/ **投稿者:** SykOtwk　**日時:** 2020/03/09 **カテゴリ:** ネクストエンジンAPIについて NextEngineにて配送番号が登録された際に、その配送番号を他システムへ連携するアプリの開発を検討しております。 メインアプリにて「出荷 > 配送番号反映」をしたことをトリガーとして、他のアプリを起動できるものでしょうか。 バッチを用いた受注情報変更の監視が必要なのであれば、受注情報のどの項目を監視すべきでしょうか。 ご教示宜しくお願いいたします。 --- ## 回答 (7件) ### hamee_sys — 2020/03/09 ご質問ありがとうございます。 現在のネクストエンジンAPIではイベントハンドラのような設定は出来ません。 連携されたい状態に合わせたステータスと配送番号項目を定期監視してください。 実装方法については連携されるシステムの仕様にもよるため参考程度にはなりますが、[受注伝票検索](https://developer.next-engine.com/api/api_v1_receiveorder_base/search)で、「受注状態区分」が ”出荷確定済” と「発送伝票番号」が ”空以外” を検索条件に指定してご確認いただくとよろしいかと存じます。 ※指定すべきID等については、各環境にて取得してください。 貴社システムとの重複連携を避ける方法としては、連携後に ”連携済み” など任意の「受注分類タグ」を受注伝票に更新（貼付）し、検索対象から除外するなどの方法もあるかと思いますので、参考にしてみてください。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### SykOtwk（質問者） — 2020/03/09 早々のご回答ありがとうございます。承知いたしました、検討いたします。 合わせて確認させていただきたいのですが、開発依頼元曰く、 NextEngineのサーバがメンテナンスなどに入る？などしたときに、 アプリのクライアントIDおよびクライアントシークレットが変更されることがあって、 その場合に認証エラーになるから、それを検知できるようにもしたいとのことでした。 アプリのクライアントID及びクライアントシークレットは、 サンプルプログラムのようにプログラム内部に埋め込もうとしていたのですが、 上記のようなことはあるのでしょうか？ 上記のようなことがあるとすると、そのたびにプログラムを更新することになりますか？ ### hamee_sys — 2020/03/09 ご質問いただきありがとうございます。 ＞ アプリのクライアントIDおよびクライアントシークレットが変更されることがあって 事の経緯がわかりかねますため、正確なご質問への訂正になっているかわかりませんが、当社メンテナンスにより、上記値が変更されることはございません。 ネクストエンジン「アプリを作る」の画面上から「更新」ボタンを押下することで意図的に更新することは可能です。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点等ございましたらお気軽にお申し出くださいませ。 ### SykOtwk（質問者） — 2020/03/09 ご回答ありがとうございます。 念のため追加で確認させてください。 > ネクストエンジン「アプリを作る」の画面上から「更新」ボタンを押下することで意図的に更新することは可能です。 何かしらのタイミングで、上記操作を行う必要が発生することはあるでしょうか？ > 事の経緯がわかりかねますため 開発依頼元のお話を伺うに、 他システム上でクライアントID及びクライアントシークレットを登録し、 その、他システム側から受注情報をNE宛に連携していたアプリがあって、 その利用の中で、時折更新しないとならなかった、と伺っています。 「Key」とおっしゃっていたので、クライアントID及びクライアントシークレットではない可能性もあるのですが、 何か思い当たることがあれば合わせてご教示いただければ幸いです。 ### hamee_sys — 2020/03/09 ご質問いただきありがとうございます。 ＞ 何か思い当たること 推察するに恐らくは[アクセストークン（リフレッシュトークン）](https://developer.next-engine.com/api/auth)のことではないかと思われます。 該当項目が上記であれば、セキュリティ識別情報として一般的な仕組みになっておりますので適切にご対応いただければと存じます。 項目の正否は開発依頼元様へご確認ください。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点等ございましたらお気軽にお申し出くださいませ。 ### SykOtwk（質問者） — 2020/03/09 ご回答ありがとうございます。 リンク頂いた先を拝見して、このようなことがあるのではないかと考えましたが、いかがでしょうか？ --- バッチ処理には、ユーザが画面からアクセスしたときに取得したアクセストークン（リフレッシュトークン）が必要である。 基本的には1日1度、長くて3日（リフレッシュトークンの有効期限内）に1度、バッチ実行していれば、 この初回のユーザがアクセスしたときに取得した情報を利用し続けることが出来るが、 サーバメンテナンスなどにより3日を超えてバッチ処理が実行されなかった場合、 再度ユーザ操作による画面からのアクセストークン（リフレッシュトークン）取得が必要となる。 --- ご確認宜しくお願いいたします。 ### hamee_sys — 2020/03/09 ご質問いただきありがとうございます。 仕様的には確かにそのようになりますので100%ロジック上の回避をするという意味では、画面上からアプリ再起動が必要になる可能性はございます。 ただ、ご質問は「サンプルプログラムのようにプログラム内部に埋め込もうとしていたのですが」というプログラム修正のお話しだったかと存じますので、こちらへの影響はないものと思われます。また、該当となるネクストエンジンAPIサーバーの稼働実績ですが、メンテナンスについも日単位で停止した実績はございません（災害などは除く）ので、推奨の通り、各種トークンをバッチ処理により1日1回程度更新していただければ問題は発生しないかと存じます。 --------- access_tokenの有効期限が切れていてrefresh_tokenの有効期限内の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します。 --------- 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 --- # 「特定の企業に公開」、 Redirect URI 「localhost」のアプリの審査 URL: https://developer.next-engine.com/questions/1436/ **投稿者:** sat　**日時:** 2020/03/09 **カテゴリ:** その他 「特定の企業に公開」、 Redirect URI 「localhost」のアプリの審査の場合、 localhost のため、ネクストエンジン側からそのアプリにはアクセスできないと思われます。 そのようなアプリの場合、どのような審査基準で審査されるのでしょうか。 「特定の企業に公開」アプリでも審査が却下されることがあるのでしょうか。 以上、ご回答の程 よろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2020/03/09 ご質問いただきありがとうございます。 審査基準については非公開であるためお答えできかねますが、当社基準に則り、審査及びご確認のご連絡をさせていただくことはあるかと存じます。 もし、検証目的であり本番アプリとRedirect URIが異なるようでしたら、テスト環境にて検証をお願いいたします。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 --- # 【質問】在庫連携_受注伝票を作成しないことは可能でしょうか？ URL: https://developer.next-engine.com/questions/1439/ **投稿者:** 清水智史(株式会社ecbeing)　**日時:** 2020/03/10 **カテゴリ:** ネクストエンジンAPIについて 貴社のマニュアルを確認させていただく限り、外部からネクストエンジン様へ在庫情報を連携する場合、 受注伝票の作成が自動的に実施されるよう見受けられます。 弊社 ECサイトでは受注情報を外部サービスにて管理しているため、 ネクストエンジン様側では受注伝票を作成せず在庫の減算情報のみを連携したいと考えております。 上記 実装を実施することは可能でしょうか。 ■閲覧させていただきましたマニュアル 　・在庫連携のしくみ 　[https://manual.next-engine.net/main/stock/stk_overview/4262/](https://manual.next-engine.net/main/stock/stk_overview/4262/) --- ## 回答 (1件) ### hamee_sys — 2020/03/10 ご質問いただきありがとうございます。 汎用形式による受注メール（サンクスメール）のCC（Carbon Copy）も送れない、という前提でご回答いたします。 貴社ECサイトで販売された受注数分をネクストエンジン内の在庫から減算したいということであれば、貴社ECサイトから何らかの方法で減算したい在庫数を取得し、以下のネクストエンジンAPIにより在庫数を加算/減算することは可能です。 ▽商品マスタアップロードAPI [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) ▽商品マスタCSVのファイル内容 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) ・商品コード（syohin_code） ・在庫数の加算/減算値（zaiko_su） を指定していただければAPI経由で加算減算することは可能です。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点等ございましたらお気軽にお申し出くださいませ。 --- # 申請中のアプリの状態を確認したいので「アプリを探す」を使用したいのですが、どこから入れますか？ URL: https://developer.next-engine.com/questions/1441/ **投稿者:** 長谷川伸　**日時:** 2020/03/11 **カテゴリ:** 開発環境・SDKについて 申請中のアプリの状態を確認したいので「アプリを探す」を使用したいのですが、どこから入れますか？ --- ## 回答 (1件) ### hamee_sys — 2020/03/11 ご質問ありがとうございます。 申請中のアプリは「アプリを探す」からは確認できませんが、 「アプリを探す」は以下のURLとなります。 [https://base.next-engine.org/apps/](https://base.next-engine.org/apps/) また本サイトはAPI等開発に関するご質問のみを受け付けておりますので 次回以降は通常のサポート窓口へお問い合わせください。 --- # 公開アプリの自社使用におけるAPI利用料金 URL: https://developer.next-engine.com/questions/1446/ **投稿者:** shiromofufactory　**日時:** 2020/03/15 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 こちらのQ&Aを見まして、関連して質問させてください。 [https://developer.next-engine.com/questions/1416](https://developer.next-engine.com/questions/1416) まず、自社で開発した公開アプリを自社利用する場合、アプリの利用料金はかからないものと 理解しております。（この時点で間違っていればご指摘ください。） また、引用したQ&Aによれば、公開アプリについてはAPI利用料金はかからないとのことでした。 つまり、 「自社で開発した公開アプリを自社利用する場合は、API利用回数に関わらず費用発生はしない」 ということになりますでしょうか？ （もちろん、公開に値するアプリであると審査で認めていただいた場合、という前提です。） --- ## 回答 (1件) ### hamee_sys — 2020/04/30 ご回答が大変遅くなり申し訳ございません。 貴社で開発された全体公開アプリをご利用される場合、 貴社もアプリを購入していただく必要がございますので、 アプリ販売時に設定された月額利用料金が発生いたします。 逆に、特定企業にのみ公開するアプリを開発された場合は API通信費用のみが発生いたします。 --- # 受注伝票有効化 URL: https://developer.next-engine.com/questions/1449/ **投稿者:** shiromofufactory　**日時:** 2020/03/18 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIを使って、こちらのURLの「受注伝票有効化」にあたる処理を行いたい（ [新規受付]ステータスの受注伝票を[確認待ち]以降に変更したい）のですが、 受注伝票一括更新のAPIを使って試したところ、受注状態がメール取込済（新規受付）のものは更新できないとのエラーが出力されました。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/8719/) エラー内容 code: '020009', message: '[receive_order_order_status_id]は受注状態がメール取込済のため更新できません APIを使って「受注伝票有効化」にあたる処理を行うことはできない仕様なのでしょうか？ --- ## 回答 (8件) ### hamee_sys — 2020/03/19 受注伝票の有効化と同等にあたる処理につきましては、 下記の流れで実現可能でございます。 1.受注伝票の検索により受注状態区分が「1.受注メール取込済」であるもののみを取得する 　エンドポイント：/api_v1_receiveorder_base/search 2.1で取得した受注伝票の情報をもとに取込用CSVファイルを作成し、受注伝票アップロードを行う 　エンドポイント：/api_v1_receiveorder_base/upload 　※CSVファイルの作成の際は、メイン機能で各店舗ごとに設定した 　　受注一括登録パターンで作成を行う必要がございます 　　下記エンドポイントより受注一括登録パターンIDを取得できます 　　エンドポイント：/api_v1_receiveorder_uploadpattern/info 3.アップロード後、伝票の状態によって確認待ち～印刷待ちのいずれかに遷移します ### shiromofufactory（質問者） — 2020/03/19 ご回答ありがとうございます！ ＞　※CSVファイルの作成の際は、メイン機能で各店舗ごとに設定した ＞　　受注一括登録パターンで作成を行う必要がございます ＞　　下記エンドポイントより受注一括登録パターンIDを取得できます ＞　　エンドポイント：/api_v1_receiveorder_uploadpattern/info この部分について再度質問させてください。 弊社には複数の店舗があるのですが（Makeshop, Amazonなど）、その全てを一括で更新したい場合、 受注一括登録フォーマットパターンとして90：汎用標準パターンを使用し、 こちら（[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_hanyo/5552/)）の フォーマットに沿ったCSVを作成することで実現できるものと考えましたが、正しいでしょうか？ ### hamee_sys — 2020/03/19 アップロード時には受注一括登録パターンIDを指定しますが、 各パターンIDには下記のとおり店舗IDが含まれているため、 1店舗ごとのアップロード処理が必要となります。 [https://developer.next-engine.com/api/fields/receiveorder_receive_order_...](https://developer.next-engine.com/api/fields/receiveorder_receive_order_upload_pattern) そのためたとえ同じパターンを設定されていても、 複数の店舗に対して一括で受注CSVファイルをアップロードすることはできかねます。 ### shiromofufactory（質問者） — 2020/03/19 ありがとうございました。よくわかりました。 たびたび申し訳ありませんが、APIによるアップロードの仕様について質問させてください。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/juchu_hanyo/5552/) こちらのページに以下のガイドがございました。 ＞受注CSVファイルを取り込むと、[新規受付]ステータスの受注伝票は[確認待ち]ステータス以降に移動します。 ＞受注メール取込を利用していない場合は、受注CSVファイルを取り込むと同時に[確認待ち]ステータス以降に受注伝票が作成されます。 ①作成済みの新規受付ステータスの受注伝票にすでにある項目が、アップロード時のCSVにはなかった場合 　（たとえば「受注名カナ」が作成済みの受注伝票には登録されているが、CSVでは列を省略した場合）、 　対象項目は据え置きとなるという理解で正しいでしょうか？　それとも削除されてしまうのでしょうか？ ②新規受付ステータスの受注伝票にすでに商品の受注明細が登録されていた場合、 　アップロード時のCSVに指定された商品情報との関係はどうなるのでしょうか？ 　・明細が追加される 　・同じ商品コード（？）であれば上書きする 　・無視されて登録済みの明細情報が維持される　　など・・ 　また、もし「明細が追加される」である場合、明細を追加せずにアップロードすることは可能でしょうか？ 　前述のURLのガイドでは商品名などが必須項目となっていたため、 　「取得した受注伝票の情報をもとに取込用CSVファイルを作成し、受注伝票アップロードを行う」とすると 　ステータスを更新するだけでなく明細情報が重複してしまうのではないかと危惧しています。 ### shiromofufactory（質問者） — 2020/03/24 こちらの件、直近の質問だけお答えいただけていないので、お願いできませんでしょうか。 お忙しいようでしたら②だけで大丈夫です。 自分でテスト環境で実験して試せればよいのですが、手動で伝票新規作成を行うと、 はじめからステータスが「確認待ち」等（受注状態：２）になってしまうため、実験ができない状態です。 （私の理解が浅く、代替のやり方があるのかもしれませんが。） なにとぞよろしくお願い申し上げます。 ### hamee_sys — 2020/03/25 ＞①作成済みの新規受付ステータスの受注伝票にすでにある項目が、アップロード時のCSVにはなかった場合 ＞　（たとえば「受注名カナ」が作成済みの受注伝票には登録されているが、CSVでは列を省略した場合）、 ＞　対象項目は据え置きとなるという理解で正しいでしょうか？　それとも削除されてしまうのでしょうか？ 　列を省略した場合、登録済のデータは変更されず据え置きとなります。 ＞②新規受付ステータスの受注伝票にすでに商品の受注明細が登録されていた場合、 ＞　アップロード時のCSVに指定された商品情報との関係はどうなるのでしょうか？ 　同一店舗の同一店舗伝票番号で、受注メール取込時とCSV作成時で 　受注明細の内容が異なる場合があるということでしょうか。 　（原則、受注メールとCSVの内容は一致しているかと存じます） 　[https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4748/) 　上記を参照のうえ、受注メールをメイン機能に取り込んでいただくと 　新規作成された受注伝票は「新規受付」ステータスに入りますので、 　挙動をご確認いただけるかと存じます。 ### shiromofufactory（質問者） — 2020/03/25 ご回答ありがとうございます。 ＞　同一店舗の同一店舗伝票番号で、受注メール取込時とCSV作成時で ＞　受注明細の内容が異なる場合があるということでしょうか。 いえ、そうではありません。 「（新規受付）伝票A　明細A-1, A-2」に対して「伝票A　明細A-1, A-2」と同じ内容のデータをCSVで上書きしたときに、 「伝票A　明細A-1, A-2, A-1, A-2」と明細がだぶってしまうことにならないか？を心配していました。 ご回答のトーンから推測すると、 「A-1, A-2がそれぞれ上書きされて、A-1とA-2はキーも中身も同じなので結果としては変わらない」ということでしょうか。 （であれば嬉しいのですが。） ### hamee_sys — 2020/03/25 はい、重複して登録されることはございません。 --- # 自動実行処理の引当処理を停止させた状態で引当を行う方法について URL: https://developer.next-engine.com/questions/1450/ **投稿者:** 世川　紘平　**日時:** 2020/03/19 **カテゴリ:** ネクストエンジンAPIについて 自動実行処理の引当処理を停止させた状態で、APIを使って手動で引当をする方法がドキュメントで見つからなかった為、実装方法についてご教授下さい。 ※商品区分が「0：通常」及び「10：予約」の商品に対しての引当を想定しております。 仮に引当する手段がない場合、自動実行処理の引当処理をOFFにする用途はなんでしょうか。 --- # 受注伝票更新API実行時のメールアドレス形式チェックについて URL: https://developer.next-engine.com/questions/1456/ **投稿者:** 世川　紘平　**日時:** 2020/03/25 **カテゴリ:** ネクストエンジンAPIについて 受注伝票更新APIを使用して購入者メールアドレス（receive_order_purchaser_mail_address）を変更しようとした所、 以下の動作となったのですが、受注伝票更新API実行時のメールアドレス形式チェックは、どの様なチェックを行っているのでしょうか。 ■「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」に更新しようとする場合 以下のエラーが発生しました。 メッセージコード(code) : 011015 メッセージ(message) : [receive_order_purchaser_mail_address]メールアドレスの形式ではありません。 ■「[xx@xxx.xxx](mailto:xx@xxx.xxx)」に更新しようとする場合 正常に更新できました。 ■「[xxxx@xxx.xxx](mailto:xxxx@xxx.xxx)」に更新しようとする場合 正常に更新できました。 【備考】 ・メイン機能から購入者メールアドレスを更新する場合は「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」に更新する事が出来ました。 ・受注伝票アップロードAPIを使用して受注伝票を作成する際は、購入者メールアドレスが「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」の受注伝票を作成する事が出来ました。 --- ## 回答 (5件) ### hamee_sys — 2020/03/25 エラーの詳細につきまして、確認・調査を行いますので お時間を頂戴いたしますが、しばしお待ちくださいませ。 ### hamee_sys — 2020/03/26 受注伝票更新APIを利用したメールアドレスの更新の場合 「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」のみ更新処理が実行されない仕様となっております。 （「[aaa@aaa.aaa](mailto:aaa@aaa.aaa)」や「[abc@def.com](mailto:abc@def.com)」などは更新が可能で「x」を使った上記形式の場合のみ更新不可） ### 世川　紘平（質問者） — 2020/03/26 ご回答ありがとうございます。 書式不正というよりは「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」という値が特別にエラーになる為と理解しました。 重ねて２点お伺いしたい事がございます。 １．「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」の他にも同様のエラーとなる値はありますでしょうか ２．メールアドレス形式チェックがどの様なルールで行われているか、開示していただけませんでしょうか ### hamee_sys — 2020/04/01 １．「[xxx@xxx.xxx](mailto:xxx@xxx.xxx)」以外にはエラーとなる値はございません ２．RFCに準拠する形式でチェックしております ### 世川　紘平（質問者） — 2020/04/01 ご回答ありがとうございます。 １．２の回答について、承知いたしました。 --- # 印刷待ちから出荷済みに変更するAPI URL: https://developer.next-engine.com/questions/1457/ **投稿者:** 高見沢　徳明　**日時:** 2020/03/30 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 NEXT ENGINE API使って印刷待ち状態の注文を出荷済み変更する手順についてご教示ください。 ドキュメントも拝見しましたがよくわからなかったのでよろしくお願いします。 --- ## 回答 (6件) ### hamee_sys — 2020/03/30 ステータスが「納品書印刷待ち」または「納品書印刷済み」の 受注伝票に対して「出荷確定処理」を行うには、下記の エンドポイントに対してリクエストを送ることで処理が可能です。 　・受注伝票出荷確定処理 　　[https://api.next-engine.org/api_v1_receiveorder_base/shipped](https://api.next-engine.org/api_v1_receiveorder_base/shipped) 詳細につきましては下記ページをご覧ください。 　[https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) ### 高見沢　徳明（質問者） — 2020/03/30 早々にありがとうございます！確認します。 ### 高見沢　徳明（質問者） — 2020/03/31 お世話になっております。 receive_order_order_status_idが20のデータを抜いてきて上記のAPI（shipped）をかけてみたのですが ステータスが変わらないようです。 これは何が考えられますでしょうか？ ### hamee_sys — 2020/04/01 ステータスが変わらない、というのは何かエラーが生じているということでしょうか。 なお、以前、下記の投稿にて同類のご質問をいただいているかと存じますが、 今回は異なるエラーでしょうか。（エラーが生じている場合） [https://developer.next-engine.com/questions/1338](https://developer.next-engine.com/questions/1338) ### 高見沢　徳明（質問者） — 2020/04/01 こちらとは別に再度エラーメッセージを確認したところ /opt/rubies/ruby-2.5.5/lib/ruby/gems/2.5.0/gems/ne_api-0.0.11/lib/ne_api.rb:31:in `response': 009007:受注伝票がキャンセルされてます。確認してください。 (NeAPIException) となっていました。ne_api-0.0.11はrubyのNEXT ENGINEのライブラリですが、呼んでいる内容は貴社APIなのでエラーはその内容に準じていると考えられます。 これはどういう内容なのでしょうか？ ちなみに現在印刷待ちが9件あり、バッチでAPIをコールしてもステータスが遷移しません。 ### hamee_sys — 2020/04/01 個別に調査を行いますので、直近でリクエストを行った「日時」および エラーが返った「日時」をお教えいただけますでしょうか。 （日時のみの情報で結構です） --- # 本番環境での動作確認方法について URL: https://developer.next-engine.com/questions/1460/ **投稿者:** 中間　博章　**日時:** 2020/04/06 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 開発したアプリの本番環境での動作確認方法に関して質問させてください。 本番環境への切替後、本番環境でのアプリ動作確認をするためには、 メイン機能（テスト環境）とは別に、本番用のメイン機能を契約する必要がある。 この認識で間違いないでしょうか。 それとも開発者用に本番用のメイン機能を優遇して提供してくれる制度などはございますか。 ご返信よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2020/04/07 アプリの動作検証はテスト環境で行っていただく必要がございます。 また、開発企業様用に無償などでのメイン機能の提供は 行っておりません。 基本的にはテスト環境のみで動作検証は行えるかと存じますが 本番環境が必要になるのはどのようなケースでしょうか。 --- # 受注API連携時の受注明細「商品OP」項目について（汎用カート） URL: https://developer.next-engine.com/questions/1461/ **投稿者:** 田中慎吾　**日時:** 2020/04/07 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンに受注メール取り込み時、またはAPIにて受注更新時に 受注明細の「商品OP」項目に任意の文字列を出力するようにしたいのですが、 活用可能な項目でしょうか。 上記が難しい場合、受注明細毎に任意の文字列を出力できる代替項目はありますでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2020/04/08 受注メールにおける取り込みにつきましては、下記の メイン機能のマニュアルをご確認ください。 [https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4748/) APIでの受注伝票情報の更新につきましては、下記ページの フィールド一覧にございます項目が更新可能です。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) なお、受注明細情報につきましては「件数取得」「検索」のみが 実行可能であるため、明細ごとに情報を更新することはできかねます。 その他、代用可能な項目としましては、先に記載した フィールド一覧のいずれかをご選択いただくのがよろしいかと存じます。 ### 田中慎吾（質問者） — 2020/04/08 ご連絡ありがとうございます。 API更新は明細毎に対応できないが、受注メール取り込み時であれば「商品オプション」項目を活用して 明細毎に活用できると理解いたしました。 その上で追加で質問ですが、 下記の様に受注取り込みメールに「商品オプション」を指定したのですが、 実際項目には反映されておりませんでした。 原因はわかりますでしょうか。※注文自体は取り込めております。 ご注文番号：1064605 お支払合計：￥ 4,279 ご決済方法：代金引換 メッセージ： ◎購入者 　お名前　：アイピーロジック 東海1　様 　オナマエ：アイピーロジック テスト 　郵便番号：〒113-8403 　ご住所　：秋田県テストテストテスト 　電話番号：090-9999-9999 　メール　：[ttokai+1@iplogic.co.jp](mailto:ttokai+1@iplogic.co.jp) ◎お届け先　お名前　：アイピーロジック 東海1　様 　オナマエ：アイピーロジック テスト 　郵便番号：〒113-8403 　ご住所　：秋田県テストテストテスト 　電話番号：090-9999-9999 　配送方法：当社指定配送業者(ヤマト運輸、佐川急便、日本郵便など) 　お届け日：指定なし 　お届け時間：指定なし ****************************** 　ご注文商品明細 ****************************** 商品コード：3500658 商品名：Nie 本割込小型三徳包丁 商品オプション：テスト 単価：￥ 3,289 数量：1 ------------------------------------------------- 小　計 ￥ 3,289 (うち消費税 ￥299） 値引き ￥ 0 送　料 ￥ 660 手数料 ￥ 330 ============================================ 合　計 ￥ 4,279 ============================================ ご使用ポイント 0 pt 今回加算される予定のポイント 32 pt 現在の所持ポイント 4,500 pt ### hamee_sys — 2020/04/08 実際に反映されていない項目は「商品オプション」のみでしょうか。 汎用形式で受注メールを取り込む場合、先にご案内いたしました マニュアルに記載の形式に一致させる必要がございます。 拝見する限り、一致していないレイアウトとなっておりますので、 マニュアルを改めてご確認ください。 [https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/4748/) なお、受注メールの取込におけるお問い合わせにつきましては メイン機能の通常サポート内容であるため、サポート窓口まで お問い合わせくださいますようお願いいたします。 --- # APIを使ったERPとのデータ連携について URL: https://developer.next-engine.com/questions/1465/ **投稿者:** Masa　**日時:** 2020/04/16 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 現在、Next Engineの利用を検討中の企業様向けにアプリの開発を検討していますが、基幹業務(ERP)との連携において何点か質問させてください。 1. Next Engine のビジネスデータと ERP のビジネスデータを連携する予定です。Next Engine のデータを定期的に転送/コピーしたり、ERP のデータをもって Next Engine のデータを更新したりします。 ERP から直接 API をコールしてこれらの処理を行うため、アプリケーションサーバーの PHP コード等を使いません。その場合、アプリケーション申請時の「Redirect URI」には何を入力すればよろしいでしょうか？ 2. コミュニティで既に質問されていますが、2020年4月現在、外部からAPIをコールする際には、ログイン画面を経なければその後の処理を行えないという状況には変わりないでしょうか？つまり、外部のプログラム中でユーザーIDとパスワードを明示的に記述して、ログイン画面を経ずに処理を行うというのはできないという理解で正しいでしょうか？ 3. 1、2 に関連していますが、貴社ご提供の「freee専用「会計ソフト連携アプリ」」の説明中に、「連携頻度は1日1回。連携時間は設定可能！」とありますが、これは誰もログインしていない状態でも動作するのでしょうか？もし同様のアプリを開発できれば、1、2の課題は解決出来そうですが、いかがでしょうか？ ご教授よろしくお願い致します。 --- ## 回答 (8件) ### hamee_sys — 2020/04/24 ご連絡が遅くなり誠に申し訳ございません。 1～3につきまして、内容を確認のうえ、 回答いたしますので今しばらくお待ちくださいませ。 ### Masa（質問者） — 2020/04/24 お手数をおかけしますが、よろしくお願い致します。 ### hamee_sys — 2020/04/28 回答が遅くなり申し訳ございません。 1. バッチでの処理を計画されていらっしゃるかと存じますので、 そちらを前提として回答申し上げます。 バッチ処理を実行するためにはaccess_token,refresh_tokenが必要となり それらを取得するためにはアプリケーションサーバーを介する必要がございます。 　※下記ページ中段「バッチ処理」参照 　　[https://developer.next-engine.com/api/auth](https://developer.next-engine.com/api/auth) そして、アプリケーションサーバーを介す際に、アプリ作成時に設定した 「RedirectURI」にURLパラメータ（uid,state）を付与した状態でリダイレクトします。 （上記ページ上部「ネクストエンジン本体にアクセス」参照） そのため、access_tokenおよびrefresh_tokenを取得する画面を作成する必要がございます。 なお、バッチ処理のみの実装の場合でも初回のみログイン画面を経由する必要がございます。 2. 上記1.で記述いたしましたように、access_token,refresh_tokenを取得する際には アプリケーションサーバーを介する必要があり、また、初回のみログイン画面を 経由する必要がございます。 3. 前述いたしました「バッチ処理」に記載のとおり、事前に処理内容を準備のうえ、 access_token,refresh_tokenを保持・更新する仕組みを構築いただければ 例えば「1日に1回23時に実行」といった処理が可能になります。 ### Masa（質問者） — 2020/04/28 ご返信をありがとうございます。 初歩的な同じことを何度もお聞きするようで申し訳ないのですが、再度確認させてください。処理については、Next Engineからのデータの抽出、Next Engineのデータの更新、をバッチにて定期的に行う要件となります。 1. 2. 「初回ログイン」とありますが、これは、定期処理について、一回だけログインすれば、あとは毎日同じ時刻に処理する場合でも、以後は一切ログインが不要ということでしょうか？また、繰り返しになりますが、ログインは必ずWebブラウザ上で、マニュアルでユーザーID/パスワードを入力する必要があるという理解でよろしいでしょうか？ 3. 定期バッチ処理は、あくまでこちらで用意するアプリケーションサーバーでそのような仕組みを構築する必要があり、Next Engineで何らかの設定を行うことはできないということでしょうか？また、Tokenは最長３日使用できるということですが、更新する際には、再度上述の方法でのログインが必要になりますか？ 以上、よろしくお願い致します。 ### hamee_sys — 2020/04/28 ＞定期処理について、一回だけログインすれば、あとは毎日同じ時刻に処理する場合でも、 　以後は一切ログインが不要ということでしょうか？ さようでございます。 ただし、バッチ処理の際には必ずaccess_token,refresh_tokenが必要となります。 ＞ログインは必ずWebブラウザ上で、マニュアルでユーザーID/パスワードを 　入力する必要があるという理解でよろしいでしょうか？ 相違ございません。 ＞Next Engineで何らかの設定を行うことはできないということでしょうか？ はい、ネクストエンジン側で設定を行うことはできかねます。 ＞Tokenは最長３日使用できるということですが、更新する際には、 　再度上述の方法でのログインが必要になりますか？ 各エンドポイントに対しリクエストを送った際にaccess_toke,refresh_tokenが レスポンスされますので、そちらを保持する仕組みを構築していただき、 次回リクエスト時に、その保持していたtokenを利用しバッチ処理を実行することで ログイン処理は不要となります。 ### Masa（質問者） — 2020/04/28 ご丁寧にありがとうございます。 そうなると、以下のような対応となると思いますが、ご確認いただけますか？ 1. 定期バッチジョブはすべてこちらで構築するアプリケーションサーバーにて処理する。 2. スケジュールについても、そのような仕組みをアプリケーションサーバーに構築する。 3. 初回ログインのみは対話形式にてブラウザ上で行い、その際のトークンをアプリケーションサーバー上のDBに保存するような仕掛けを作り、以後はこのトークンをもって、次のトークンの更新をし続ける。 4. これにより、ログインは初回のみで、以後はスケジュールバッチジョブを人手を介さずに行うことが可能となる。 何度も申し訳ありませんが、よろしくお願い致します。 ### hamee_sys — 2020/04/30 バッチ処理につきましては、ご提示いただいた内容でアプリを構築していただくことになります。 何とぞよろしくお願いいたします。 ### Masa（質問者） — 2020/04/30 情報を取り出すテストプログラムを使い、ログイン画面を経ずに商品一覧が取り出せることを確認できました。 また、トークンが更新されることも確認しました。 お忙しいところサポートいただきありがとうございました。 --- # 「アプリを作る」内「販売」タブの月額費用最低金額 URL: https://developer.next-engine.com/questions/1467/ **投稿者:** 長尾　**日時:** 2020/04/21 **カテゴリ:** その他 ユーザー様へは無償での提供も検討しておりますが、月額費用は0円ではエラーになってしましました。 無償での提供はできないということでしょうか。 --- ## 回答 (2件) ### hamee_sys — 2020/04/24 アプリの最低販売金額は「3,000円（税抜）」となっております。 そのため、3,000円未満を設定された場合、エラーとなります。 ### 長尾（質問者） — 2020/04/24 ご回答ありがとうございます。 無償での提供はできないということで承知しました。 --- # 「アプリを作る」内「販売」タブの利用規約URL URL: https://developer.next-engine.com/questions/1468/ **投稿者:** 長尾　**日時:** 2020/04/21 **カテゴリ:** その他 弊社サービスの利用規約はPDFファイルでユーザー様に参照いただいています。 「販売」タブの利用規約URLに指定する利用規約は、ファイルの形式に制限などありますでしょうか。 それともhttpでアクセスできればよろしいでしょうか。 --- ## 回答 (2件) ### hamee_sys — 2020/04/24 ファイル形式に制限はございません。 PDFデータであっても、インターネット通信により ご利用企業様が閲覧できれば問題ございません。 ### 長尾（質問者） — 2020/04/24 ご回答ありがとうございます。 承知しました。 --- # 「アプリを作る」内「基本」タブのアプリURLについて URL: https://developer.next-engine.com/questions/1469/ **投稿者:** 長尾　**日時:** 2020/04/21 **カテゴリ:** その他 入力したアプリURLはどのようなタイミングでアクセスされるものでしょうか。 あるいはユーザー様が参照されるものではなく、審査において、サービスの内容を調べるために利用されるものでしょうか。 画面下部のアプリを選択したときには「API」タブのRedirect URIにアクセスされるようでしたのでご質問しました。 --- ## 回答 (2件) ### hamee_sys — 2020/04/24 仰せのとおりアプリアイコンから起動した際の遷移先は 原則「Redirect URI」となります。 また、基本タブ内のアプリURLにつきましても、 ご提示の用途とお考えいただいて問題ございません。 ### 長尾（質問者） — 2020/04/24 承知しました。 ありがとうございます。 --- # 意図しない「仮取込時過剰引当分の戻し」が含まれる注文について URL: https://developer.next-engine.com/questions/1470/ **投稿者:** 田中慎吾　**日時:** 2020/04/23 **カテゴリ:** ネクストエンジンAPIについて おせわになります。 至急なのですが、4/17～4/23現在で100件を超える大量の「仮取込時過剰引当分の戻し」が含まれる 注文が発生しております。 かなり頻発しているので、アプリとの連携に問題があるとしか考えられないのですが、 受注取込時点でサーバー側でエラーログや取り込んでいる商品情報など、 確認いただけませんでしょうか。 もちろんアプリ会社側にも確認しておりますが、連携エラーなどが発生しておらず テストしても再現できないため原因の究明に難航しております。 また、アプリ側でNEとの「受注取込」連携の際のアップロード上限数（行数や容量）は決まっておりますでしょうか。 ※以前、行数が多いデータ連携をした際に連携に失敗したため。 --- # APIで取得した受注伝票のjson文字列のオブジェクト化 URL: https://developer.next-engine.com/questions/1473/ **投稿者:** 北川裕之　**日時:** 2020/04/23 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIで受注伝票の検索結果をjson形式で受け取りました。 json文字列に対してkeyで一つずつ取得するのではなく、クラスにマッピングして取得する方法はないでしょうか。 以下、実装コードになります。 // jsonをモデルに変換 try { List> lkmap = (ArrayList>)receiveOrderResult.get("data"); List modelList = new ArrayList(); for(LinkedHashMap json : lkmap) { 　　　　　　　　　//本来はここで受注票クラスにパースしてオブジェクトとして扱いたい String receive_order_id = json.get("receive_order_id"); String receive_order_shop_id = json.get("receive_order_shop_id"); } }catch(Exception e){ System.out.println(e); } --- # API接続が切れる件 URL: https://developer.next-engine.com/questions/1474/ **投稿者:** ECロボ　**日時:** 2020/04/28 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 弊社が提供している物流倉庫自動出荷・在庫管理アプリ「AiR Logi」で 倉庫分散のため弊社システムの２アカウントを1つのネクストエンジンに接続をして利用している荷主様がいらっしゃいますが、 片方のアカウントのAPI接続がしょっちゅう切れてしまいます。 原因は分かりますでしょうか？ 複数から同時接続すると強制的に切れてしまうのでしょうか？ --- # 商品マスタアップロード時に自動変換される項目について URL: https://developer.next-engine.com/questions/1475/ **投稿者:** 北川裕之　**日時:** 2020/04/28 **カテゴリ:** ネクストエンジンAPIについて [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) 上記APIにて、商品マスタのアップデートをしました。 連携元となるデータ値に半角カナがあったのですが、全角カナに変換されました。 ＜確認事項１＞ 　これは仕様でしょうか？ 　　　連携前　　ダイハツ 純正スチール(ｷｬｯﾌﾟ無)+ブリヂストン ブリザック ＲＥＶＯ ２ 　　　連携後　　ダイハツ 純正スチール(キャッフ゜無)+ブリヂストン ブリザック ＲＥＶＯ 2 ＜確認事項２＞ 　上記のような半角から全角に変換されるような仕様はどのリファレンスを確認すればよいでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/04/30 本システムでは半角カタカナのご利用は推奨していないため 商品マスタ内で文字列を登録できる項目につきましては、 すべて自動で全角へ変換される仕様となっております。 なお、自動変換される挙動につきましては、メイン機能の仕様のため メイン機能のマニュアルへ追加掲載を行う予定でございます。 --- # 店舗別ページの更新について URL: https://developer.next-engine.com/questions/1477/ **投稿者:** shiromofufactory　**日時:** 2020/04/29 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 店舗別ページの更新（[https://manual.next-engine.net/main/page/pg_sakusei-koushin/28224/](https://manual.next-engine.net/main/page/pg_sakusei-koushin/28224/) で説明されているような内容）を APIから行いたいのですが、リファレンスを見ると、店舗別ページの情報は取得のみ可能で更新用のAPIは用意されていないように見えます。 ※更新したい店舗はMakeshopです 現状では、店舗別ページの更新はメイン画面からの操作でしか行えないのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/04/30 現在のところ、ネクストエンジンAPIによる、 店舗別ページの情報更新を行うことはできかねます。 今後、更新可能なエンドポイントの開発は検討しておりますが 現段階でリリースの予定などは未定でございます。 --- # 項目「ピッキング指示」の内容の更新について URL: https://developer.next-engine.com/questions/1492/ **投稿者:** kata15　**日時:** 2020/05/29 **カテゴリ:** ネクストエンジンAPIについて 賢明の通りの項目をAPIで一括で更新をするには、 どのAPIを利用したら更新できますでしょうか。 ご存じの方いらっしゃいましたら教えて頂けますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/06/01 受注伝票更新： [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) 上記エンドポイントへのリクエストにより更新可能です。 --- # 受注キャンセル区分について URL: https://developer.next-engine.com/questions/1493/ **投稿者:** 近藤　信和　**日時:** 2020/06/03 **カテゴリ:** ネクストエンジンAPIについて キャンセルid が 0 以外から 別のもの に変わる場合があるのでしょうか？ サンプルのデータには "cancel_type_id":"12", "cancel_type_name":"伝票を確認後、有効にして下さい。" とありますが、これは場合によっては id 0 の 有効な受注 に戻されるということでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/06/03 メイン機能での処理により、"0"以外のキャンセルidへ変更になる場合はございます。 同様に"0"以外のキャンセルidの受注情報が"0"へ変更になる場合もございます。 なお、各キャンセルidと名称につきまして、メイン機能内にて設定されております。 （初期値から任意の値へ変更している場合がございます） 下記をご参考のうえ、設定内容をご確認ください。 支払/発送名称とキャンセル理由の変更(区分名称) [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_benr...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_benri/9148/) --- # RMS -SAP 間のデータ連携について URL: https://developer.next-engine.com/questions/1497/ **投稿者:** 阿部　浩明　**日時:** 2020/06/16 **カテゴリ:** ネクストエンジンAPIについて 自社の楽天ストアにて、現在ネクストエンジンを使用し外部パートナーへ倉庫の運用を委託しております。 これを、自社倉庫（SAPを使用）に移管するうえで、RMSとSAPとデータ連携の構築を考えております。 #1 RMSのAPIを使用してEDIを介してSAPとデータを送受信する場合、RMSの度重なる仕様変更に自社の開発チームが対処できない可能性を憂慮しています。 #2 そのため、RMSからいったんネクストエンジンを介して」SAPと連携をする、としたほうがRMSの仕様変更などが発生した場合も対応が早いと想定しています。 ただ、　RMSーSAP間のデータ連携について、上記＃1、＃2どちらの方法が良いのか、もしくはほかにより良い方法があるのか、#2が良いとした場合、自動で回す仕組みに対応したアプリがあれば教えていただけると幸いです。 私自身が開発者ではなく運営サイドなのゆえ、説明に不足などがあればご質問いただけますと幸いです。 またRMS SAP間のデータ連携においてネクストエンジンAPIを開発された方などいらっしゃればぜひアドバイスをいただきたいです。 よろしくお願いします。 --- # 販売形態＝すべての企業に公開について URL: https://developer.next-engine.com/questions/1498/ **投稿者:** 小林　弘和　**日時:** 2020/06/17 **カテゴリ:** ネクストエンジンAPIについて 「販売形態＝すべての企業に公開」について質問させてください。 ※「販売形態＝特定の企業に公開」の場合は利用したことがあります。 　 例えば A社とB社とC社でネクストエンジンAPIで受注データを集計して 分析するアプリを作成するとします。 ・弊社のネクストエンジンアカウントを"S"とします。 　"S"でネクストエンジンにログイン 　「アプリを作る」で販売形態＝すべての企業に公開で登録。 ・A社が「アプリを探す」からアプリの申し込みをおこないます。 ・このA社のデータをAPIで取得したいです。 　データ取得にはアクセストークンが必要で 　トークンの取得には[uid][state][client_id][client_secret]がセット 　で必要だと思います。 　A社がネクストエンジンにログインすれば、A社の[uid][state]は取れるので、 　あとは[client_id][client_secret]があればよいと思うのですが 　弊社のネクストエンジンアカウント"S"で登録した 　[client_id][client_secret]が利用できるのでしょうか。 　 　今までは「販売形態＝特定の企業に公開」で登録していたので 　弊社がA社、B社、C社のネクストエンジンに個別にログインして 　「アプリを作る」で作成した[client_id][client_secret]を使って 　アクセスしていました。 　 　A社の場合はA社の[client_id][client_secret] 　B社の場合はB社の[client_id][client_secret] 　C社の場合はC社の[client_id][client_secret] お手数をおかけし申し訳ありませんが ご回答のほどよろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2020/06/17 [client_id][client_secret]はアプリごとに設定されておりますので 今回のケースの場合、ネクストエンジンアカウント"S"で登録した [client_id][client_secret]をご利用いただくことで取得可能でございます。 ### 小林　弘和（質問者） — 2020/06/17 [client_id][client_secret]はアプリごとに設定されているということで理解できました。 ご回答ありがとうございました。 --- # 受注一括登録パターン情報取得で0件のとき、どのようにAPIで受注伝票一括登録を使えば良いでしょうか？ URL: https://developer.next-engine.com/questions/1526/ **投稿者:** 嘉山　典子　**日時:** 2020/07/09 **カテゴリ:** ネクストエンジンAPIについて APIテスト環境にて、/api_v1_receiveorder_base/uploadで受注伝票を一括登録にアクセスすると、下記のエラーが表示されます。 存在しない受注一括登録パターン[100035]です。 そこで/api_v1_receiveorder_uploadpattern/infoで一括登録のパターン情報にアクセスしましたが、 {"result":"success","count":"0","data":[],"......}のように件数は0件と表示されます。 どうすれば、受注伝票を一括登録できるようになるのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/07/15 テスト環境のメイン機能におきまして、受注一括登録パターンの設定は 実施されておりますでしょうか。 [https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/7625/) 受注一括登録パターンの設定後、下記をご参考にパターンIDを指定のうえ 登録リクエストを送信いただければと存じます。 [https://developer.next-engine.com/questions/574](https://developer.next-engine.com/questions/574) --- # 外部カート連携時、モール商品一括登録について URL: https://developer.next-engine.com/questions/1527/ **投稿者:** 斉藤 正賢　**日時:** 2020/07/10 **カテゴリ:** その他 外部カート（ecbeingを想定）に対してモール商品一括登録機能と同じ動作は可能でしょうか？ 同じ動作として想定している動作は下記です。 ・在庫連携商品の指定 ・任意タイミングでの一括在庫反映 --- ## 回答 (1件) ### hamee_sys — 2020/07/15 誠に恐れ入りますが、ご投稿いただきました質問につきましては、 メイン機能に関する内容となりますので、下記ネクストエンジンの サポートまでお問い合わせください。 電話：03-4570-0637(平日10:30～17:30) メール：[info@next-engine.jp](mailto:info@next-engine.jp) --- # 発送元マスタ情報の取得APIについて URL: https://developer.next-engine.com/questions/1531/ **投稿者:** 嘉山　典子　**日時:** 2020/07/16 **カテゴリ:** ネクストエンジンAPIについて 商品マスタに「発送元コード」が含まれています。この発送元マスタ(発送元コード、発送元情報を取得するAPIがリファレンスで見当たらないようです。 この情報の取得APIはありますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/07/16 発送元マスタの情報を取得するエンドポイントはご用意しておりません。 また、恐れ入りますが、現在のところ新たに開発する予定はございません。 何とぞご理解賜りますようお願いいたします。 --- # 「受注一覧と受注詳細の確認」「出荷状況の確認と更新」のシステム連携する方法 URL: https://developer.next-engine.com/questions/1532/ **投稿者:** 谷田　浩一　**日時:** 2020/07/16 **カテゴリ:** ネクストエンジンAPIについて １．受注一覧と受注詳細の確認 ２．出荷状況の確認と更新 上記２点、API?など利用してシステム連携する場合、実装する方法や注意・制限事項などを教えいただくことは可能でしょうか。 関連するドキュメントやサンプルを頂けると助かります。 --- ## 回答 (1件) ### hamee_sys — 2020/07/16 APIを利用しメイン機能内のデータと連携する場合には アプリを作成いただく必要がございます。 下記にてアプリ作成の流れを記載しておりますのでご覧ください。 　■参考URL： 　　[https://developer.next-engine.com/api/start](https://developer.next-engine.com/api/start) そのうえで、受注データの取得・更新、出荷確定処理などを行うには、 上記ページ左部メニューにございます、各種エンドポイントへ リクエストを送ることで実現可能です。 エンドポイントにより、更新が可能なものと、検索・件数取得のみが 実行可能なものがございます。 --- # 入出庫区分について URL: https://developer.next-engine.com/questions/1543/ **投稿者:** 吉田　幸司　**日時:** 2020/08/17 **カテゴリ:** ネクストエンジンAPIについて 入出庫区分の数字についておしえていただきたいのですが、数字とその説明はどこに記載してありますか。 --- ## 回答 (1件) ### hamee_sys — 2020/08/18 下記のエンドポイントより区分情報を取得することが可能です。 [https://developer.next-engine.com/api/api_v1_system_iotype/info](https://developer.next-engine.com/api/api_v1_system_iotype/info) --- # 受注伝票の出荷確定日の変更方法 URL: https://developer.next-engine.com/questions/1544/ **投稿者:** 堀松昌紀　**日時:** 2020/08/20 **カテゴリ:** その他 出荷確定した伝票をテストのために「印刷待ち」に戻し、テスト後納品書印刷を行い「出荷確定済」に状態を移行しました。 その際、「出荷確定日」が最終の納品書を印刷した日になってしまいました。 API ・伝票の操作等何らかの方法で、「出荷確定日」を変更する方法はないでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/08/20 出荷確定日につきましては受注状態が「出荷確定済」となった日付が 自動登録され、画面上およびAPIでの更新はできかねる項目でございます。 なお、出荷確定戻し後、再度、納品書印刷を行い、出荷確定をした際に 「出荷確定日」が2度目の納品書印刷を行った日になっているとのことでございますが、 納品書印刷の際に同時にステータスを「出荷確定済み」へ移動させるメニューを 選択していた場合、ご提示の挙動となります。 --- # 受注データの参照で「受注分類タグ」の特定項目にて参照するには URL: https://developer.next-engine.com/questions/1546/ **投稿者:** 小川　菜絵　**日時:** 2020/08/28 **カテゴリ:** ネクストエンジンAPIについて 現在、APIを使った受注データの取得しています。 これまでは、取込条件として「受注分類タグ」が空のものを対象にしている取得していましたが、 追加された荷主様で「受注分類タグ」に追加し伝票の管理を行っている様で、空の状態のデータを 取る事が出来ない状態になりました。 そこで、指定したタグのみ取得する様にする為には、どの様にしたら良いかご教授頂きたい。 --- ## 回答 (1件) ### hamee_sys — 2020/08/31 誠に申し訳ございませんが、受注分類タグを条件に指定した 受注伝票の検索には対応しておりません。 受注分類タグの項目自体を取得することは可能ですので、 取得後にプログラム側で絞り込みをかけていただければと存じます。 --- # 配送番号の更新について URL: https://developer.next-engine.com/questions/1550/ **投稿者:** 黒崎　信行　**日時:** 2020/09/07 **カテゴリ:** ネクストエンジンAPIについて お世話になります。私は倉庫側のシステム運営をしているものです。 下記質問でございます。 受注伝票に対して倉庫から発送された際に配送番号を更新するAPIはございますでしょうか。 手動でのアップロードではなく自動で定期的に更新できる仕組みを検討しております。 （例えばAmazonの配送番号自動更新APIのような仕組み） 恐れ入りますが、ご確認のほどお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2020/09/15 下記のエンドポイントより「発送伝票番号(receive_order_delivery_cut_form_id)」を 更新していただくことが可能です。 ・受注伝票更新 　[https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) ・受注伝票一括更新 　[https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) --- # 商品マスタの一括アップロードについて URL: https://developer.next-engine.com/questions/1551/ **投稿者:** 黒崎　信行　**日時:** 2020/09/07 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 下記質問になります。 リクエスト回数削減を目的として、複数の商品マスタを１つのリクエストで 更新できるAPIはございますでしょうか。 （例えば、受注データ一括更新のように） 恐れ入りますが、ご確認のほどお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2020/09/15 下記のエンドポイントより、複数の商品コードに対して一括での 更新を行うことが可能です。 ・商品マスタアップロード 　[https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) --- # client_id/client_secret取得の件 URL: https://developer.next-engine.com/questions/1552/ **投稿者:** 増尾裕司　**日時:** 2020/09/07 **カテゴリ:** ネクストエンジンAPIについて 表題の件、取得のために管理画面からアプリの申請が必要とのことですが リダイレクトURLの設定は必須なのでしょうか？ APIをコールしたいだけなので不要と考えるのですが無しで審査して頂けないのでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2020/09/15 APIのコールを行うにはアプリを登録していただく必要があるため Redirect URI項目の設定は必須でございます。 ### 山本 正浩 — 2022/05/08 テスト環境において、uid と state と id が redirect_uri の url パラメータとしてリクエストされまましたので アプリケーションサーバにおいてこれらを取得出来ました。 アプリケーションサーバとしては、API を実行するために、更に client_id と client_secret を追加して access_token を取得するリクエストを投げますが、 アプリケーションサーバ側では、予めユーザごとに client_id と client_secret をユーザに登録して頂く必要がありますでしょうか？ 言い換えると、アプリケーションサーバには、ユーザごとの client_id と client_secret を登録する機能の実装が必要でしょうか？ という質問になります。 本番環境の準備が出来ていない為に本番環境が redirect_uri に発行するリクエストが不明の為にこのような質問に至っています。 --- # 受注明細追加について URL: https://developer.next-engine.com/questions/1555/ **投稿者:** JAMSHOP WEBコンテンツ・チーム　**日時:** 2020/09/16 **カテゴリ:** ネクストエンジンAPIについて APIで受注明細を複数追加する場合 現在、伝票の更新日時をネクストエンジンから取得して、 その更新日時と追加する明細をネクストエンジンに渡して更新しています。 複数明細追加の場合、上記処理を連続して行いますが、 伝票の更新日時の取得が、ネクストエンジン側で追いつかなく、明細を追加できないことがありますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2020/09/16 連続処理の間隔にもよりますが、直前の処理の完了タイミングにより 正しい最終更新日を指定できず、明細追加が実行できない場合もございます。 なお、複数の明細追加について、1度の処理とせず連続の処理としている 特別な事情はございますでしょうか。 --- # api_v1_receiveorder_base/count でコールしているが、Successで結果が0件しか返ってこない URL: https://developer.next-engine.com/questions/1556/ **投稿者:** Noguchi　**日時:** 2020/09/23 **カテゴリ:** ネクストエンジンAPIについて ・言語PHP ・SDKで接続しています。 ・手動で作った注文伝票あり（確認待ち5件、引当待ち4件） ・Successとなるが、結果が0件 [https://developer.next-engine.com/api/api_v1_receiveorder_base/count](https://developer.next-engine.com/api/api_v1_receiveorder_base/count) レファレンスのサンプルのリクエストをみると、 ・receive_order_shop_id-eq=xxx とあるのですが、リクエストの項目には特に指定がないのですが、これは必須でしょうか？ 必須場合、このidはどこから見れますでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2020/09/25 「receive_order_shop_id」につきましては必須ではなく 任意の項目でございます。 なお、「receive_order_shop_id」はメイン機能で設定されている 店舗コードを指し、下記エンドポイントより取得可能です。 　店舗マスタ検索： 　[https://developer.next-engine.com/api/api_v1_master_shop/search](https://developer.next-engine.com/api/api_v1_master_shop/search) また、結果が0件で返ってくる点でございますが、手動で作成されている 受注伝票が存在するメイン機能はテスト用のものでしょうか。 アプリの販売開始処理をするまではAPIでの接続先メイン機能は テスト用メイン機能となります。 ### Noguchi（質問者） — 2020/09/25 ご回答ありがとうございました。 テスト用メイン機能に注文データを入れたところ取得できました。 ありがとうございました。 --- # 明細行に関する不具合 URL: https://developer.next-engine.com/questions/1558/ **投稿者:** 中島 清志　**日時:** 2020/09/26 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンの伝票画面にて、明細追加をおこなった際に receive_order_row_returned_reason_id に"0" receive_order_row_returned_reason_nameに"受注キャンセル" が設定される不具合があるようです。 複数の受注、商品コード等で確認されており特殊なケースでは無さそうです。 お手数ですが確認をお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2020/09/26 ご指摘の内容はメイン機能にて受注伝票を起動し、明細行の追加を 行った際のものでしょうか。 誠に申し訳ございませんが、メイン機能内の操作による事象につきましては 下記、サポートセンターまでお問い合わせいただきますようお願いいたします。 　サポートセンター連絡先： 　03-4570-0637(平日10:30～17:30) 　[info@next-engine.jp](mailto:info@next-engine.jp) なお、ネクストエンジンAPIを利用して受注明細行を追加した際の 事象の場合は実際のリクエスト内容およびリクエスト日時、 リクエストを送った際のaccess_token,refresh_tokenを上記連絡先へ ご連絡いただきましたら調査いたします。 何とぞよろしくお願いいたします。 ### 中島 清志（質問者） — 2020/10/09 明細行の追加に関しては伝票画面から行ったものです。 明細行の追加に関しては伝票画面から行ったものです。 ただ、APIから取得できるreceive_order_row_returned_reason_id については、 本来はネクストエンジンの伝票画面上から、確認や更新できる項目では無いと 考えているのですがもう一度確認していただけますでしょうか？ APIから取れる値がおかしい訳ですから、 こちらへ問い合わせした方が良いかと考えたのですが。 ### 中島 清志（質問者） — 2020/09/26 明細行の追加に関しては伝票画面から行ったものです。 ただ、APIから取得できるreceive_order_row_returned_reason_id については、 本来はネクストエンジンの伝票画面上から、確認や更新できる項目では無いと 考えているのですがもう一度確認していただけますでしょうか？ APIから取れる値がおかしい訳ですから、 こちらへ問い合わせした方が良いかと考えたのですが。 --- # API在庫連携について（在庫上書可否について） URL: https://developer.next-engine.com/questions/1564/ **投稿者:** 一ノ瀬　彩子　**日時:** 2020/10/19 **カテゴリ:** ネクストエンジンAPIについて WMSとAPIで在庫連携をするにあたり、CSVのアップロード同様、差分更新のみとなりますか？ 絶対数での上書きを行うことは可能でしょうか。 ご教示いただけると助かります。 --- # ページ情報の１フィールドのみAPI連携可否について URL: https://developer.next-engine.com/questions/1565/ **投稿者:** 一ノ瀬　彩子　**日時:** 2020/10/19 **カテゴリ:** ネクストエンジンAPIについて ページ情報の１項目が在庫と連動するため、その項目（フリーエリア１を使用予定）のみ、在庫APIとあわせてデータを送信できないかと考えています。 （在庫に紐付くシリアル番号を連携するため） １）商品マスタの１項目のみ連携・更新が可能か。 ２）1項目のみ可能な場合は、在庫データと商品マスタを同じAPIで連携することは可能か？APIは別になりますか。 ３）APIが分かれている場合は、ネクストエンジンのアプリ側でそれぞれに送り出し可能か（開発内容によりますか？） これらについてご教示お願いいたします。 --- # 受注明細検索APIについて URL: https://developer.next-engine.com/questions/1568/ **投稿者:** 畑中　健吾　**日時:** 2020/11/24 **カテゴリ:** ネクストエンジンAPIについて 受注明細検索APIについて①②の質問がございます。 ①出力パラメータ「data：検索結果の連想配列」のデータの並び順は、受注明細の「伝票番号 昇順、明細行番号 昇順」でしょうか。 上記でない場合、何の項目の並び順で連携されるか、ご教授お願いします。 ②受注伝票の明細が複数ある場合、「伝票番号」が同じ値のデータが複数行連携される想定ですが、認識合ってますでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2020/11/24 以下のとおり、回答申し上げます。 ① 受注伝票の作成順にレスポンスするため、原則、伝票番号の昇順となりますが、 内部ではソート処理を行っていないため、アプリ側でソート処理を入れていただく形式が 確実な方法となります。 ② ご認識のとおりでございます。 ### 畑中　健吾（質問者） — 2020/11/24 ご回答ありがとうございます。 ①②ともに、承知しました。 追加で質問があります。 受注明細検索APIのリクエストデータのoffset・limitを使用して、1000件単位で複数回に分けて受注明細APIをリクエストする場合、 以下の（例）の様に、複数明細の受注伝票(伝票番号:1001)が1回目と2回目で分かれて取得される可能性ありますでしょうか？ それとも、受注伝票(伝票番号:1001)の明細が1回目と2回目で分かれるのを防ぐために、 受注伝票単位のデータ(伝票番号:1001、明細:1～3)を、2回目に集約して取得されるのでしょうか。 （例） 受注明細検索APIで検索結果の1500件、1000件ずつ2回に分けて取得する場合 ＜1回目取得＞　※1000件対象 件数No:0001～1000 件数No　　伝票番号　明細行番号 0001　　　0001　　　1 : : 0999　　　1001　　　1 1000　　　1001　　　2 ＜2回目取得＞　※500件対象 件数No:1000～1500 件数No　　伝票番号　明細行番号 1001　　　1001　　　3 1002　　　1002　　　1 : : 1500　　　1500　　　1 ### hamee_sys — 2020/11/26 ご提示のケースの場合、分かれての取得となります。 そのため、同一伝票の受注明細行を分かれて取得した場合は アプリ側でデータを統合するなどの処理が必要になる想定です。 --- # 印刷済みから、出荷済みに一括で変更するAPIは存在しますか？ URL: https://developer.next-engine.com/questions/1573/ **投稿者:** 田口さん　**日時:** 2020/11/26 **カテゴリ:** ネクストエンジンAPIについて [https://manual.next-engine.net/main/shipment/shp_settei-unyou/11176/](https://manual.next-engine.net/main/shipment/shp_settei-unyou/11176/) 上記の操作に相当する部分を自動で行いたいと思っています。 印刷待ちから印刷済みへは、一括で処理できるのですが、 同様に出荷済みに一括で行うAPIが見つけられませんでした。 １件ごとにAPIを呼び出すのが正しい仕様でしょうか？ もしくは、別の手段があれば、教えていただければと思います。 ・印刷待ちから、一括で出荷済みというルートでもかまいません。 よろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2020/11/26 APIを利用しての自動での一括出荷確定処理は行うことができかねます。 下記エンドポイントを使い、伝票ごとの自動実行処理が必要です。 　・受注伝票出荷確定処理 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) ### 田口さん（質問者） — 2020/11/27 返答ありがとうございます。了解しました。 --- # 受注確認内容IDについて URL: https://developer.next-engine.com/questions/1575/ **投稿者:** 畑中　健吾　**日時:** 2020/12/02 **カテゴリ:** ネクストエンジンAPIについて (1)受注明細APIで連携される「受注確認内容ID」の項目に、 　 受注確認内容IDと明細行番号が登録されている想定ですが認識あってますでしょうか。 (2)受注明細APIで連携された受注確認内容IDを用いて、 　 受注確認内容検索APIをリクエストして受注確認内容を取得できますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/12/02 (1)認識に相違ございません。 　なお、受注確認内容が受注伝票全般に係る内容の場合は明細行番号は返りません。 　（例：商品コードが商品マスタに存在しません。、送り先の郵便番号と住所があってません。、など） (2)はい、取得可能です。 --- # WMS連携について URL: https://developer.next-engine.com/questions/1576/ **投稿者:** 根間崇弘　**日時:** 2020/12/03 **カテゴリ:** ネクストエンジンAPIについて 連携実績のないWMSの入庫実績CSVをアプリを通してアップロードするAPIの提供はありますか？ 他のWMSのアプリだと連携できてるようです。 --- ## 回答 (1件) ### hamee_sys — 2020/12/03 入荷による在庫数の更新を行う場合は、下記のエンドポイントより 各商品コードの情報を更新することが可能です。 　・商品マスタアップロード： 　　[https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) 「在庫数の加算/減算値(zaiko_su)」の値をもって更新が行われます。 なお、WMS側への入庫による在庫数更新であることをメイン機能の 「入出庫履歴」に表示させたい場合は、下記の項目に文字列を 入力して更新いただくことで表示可能です。 　「入出庫履歴の事由(nyusyukko_riyu)」 ※この項目を省略される場合は統一して、 　「商品マスタCSVファイルによる入出庫」と表示されます --- # WMSの出荷指示について URL: https://developer.next-engine.com/questions/1578/ **投稿者:** 根間崇弘　**日時:** 2020/12/05 **カテゴリ:** ネクストエンジンAPIについて APIを使用してWMS連携のI/F構築を検討しています。 (実現したいこと) 1.ネクストエンジン→WMSに出荷指示データを渡したい。 2.WMS→ネクストエンジンへ出荷実績のデータを渡したい。 (確認したいこと) ・上記の連携処理が実現できる、対象のAPIを教えていただけますでしょうか。 ・以上のAPIについてデータの差分更新、データに洗い替えは可能でしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/12/08 1. 下記ページ記載のエンドポイントよりネクストエンジン側で 発送待ちとなっている受注伝票の検索が可能です。 　・受注伝票検索： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 「受注状態区分(receive_order_order_status_id)」が下記となっている 受注伝票が対象となります。 　・20:納品書印刷待ち 　・40:納品書印刷済 2. WMS側で出荷が完了した受注データに対し、下記ページ記載の エンドポイントより出荷確定処理を行っていただくことで ネクストエンジン側のステータスも「出荷確定済」となります。 　・受注伝票出荷確定処理： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) 　　　※複数伝票の一括処理は行えず、伝票ごとの処理が必要 なお、受注伝票の更新については以下のエンドポイントより伝票ごと、 または複数伝票の一括処理が可能です。 　・受注伝票更新： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) 　・受注伝票一括更新： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) --- # 返品時のAPI連携について URL: https://developer.next-engine.com/questions/1579/ **投稿者:** 根間崇弘　**日時:** 2020/12/05 **カテゴリ:** ネクストエンジンAPIについて NEXT ENGINE側で返品が発生した場合をトリガーにするAPI等の提供はありますか？ または、リアルタイムで or バッチで確認する場合はどのAPIのエンドポイントを確認したらいいですか？ --- ## 回答 (1件) ### hamee_sys — 2020/12/08 返品処理をトリガーに情報を取得するAPIはご提供しておりません。 下記ページ記載のエンドポイントより任意のタイミングで 取得することは可能です。 　・受注伝票検索： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 「受注キャンセル区分(receive_order_cancel_type_id)」にて 返品に該当する区分値を条件に検索いただくことで情報の取得が可能です。 受注キャンセル区分の区分値につきましては以下をご確認ください。 　・受注キャンセル区分情報取得： 　　[https://developer.next-engine.com/api/api_v1_system_canceltype/info](https://developer.next-engine.com/api/api_v1_system_canceltype/info) --- # PHPのサンプルコードでの環境設定 URL: https://developer.next-engine.com/questions/1580/ **投稿者:** 杉本　達雄　**日時:** 2020/12/11 **カテゴリ:** 開発環境・SDKについて お世話になります。 「サンプル（FuelPHP）」のページより環境設定をしているのですが、不明な部分があり質問させてください。 質問 ダウンロードした「app-template-fuel-master」について、「はじめに - ダウンロード」にある設定までは完了しました。 そのあと、このフォルダ下のファイルはインストールした「fuelphp」の直下に上書き保存すればよろしいのでしょうか。 まずはPHPのサンプルコードを利用してアクセストークンがとれるまでの設定をしたいと思っておりますので、 わかりづらい質問で大変恐縮ですが、ご回答いただけると助かります。 --- # PHPのサンプルコードでの環境設定 URL: https://developer.next-engine.com/questions/1581/ **投稿者:** 杉本　達雄　**日時:** 2020/12/11 **カテゴリ:** 開発環境・SDKについて お世話になります。 「サンプル（FuelPHP）」のページより環境設定をしているのですが、不明な部分があり質問させてください。 質問 「はじめに - ネクストエンジンアプリ基盤を動かす」でログインするときのURLが [https://localhost/auth/login](https://localhost/auth/login) と記載されておりますが、環境に合わせるようとなっておりますが、どういう仕組みになっているのかが不明となっております。 ちなみにfuelPHPのWelcomepページは下記となっております。 [https://localhost/fuelphp/](https://localhost/fuelphp/) まずはPHPのサンプルコードを利用してアクセストークンがとれるまでの設定をしたいと思っておりますので、 わかりづらい質問で大変恐縮ですが、ご回答いただけると助かります。 --- # アクセストークンの期限切れについて URL: https://developer.next-engine.com/questions/1582/ **投稿者:** ネクストエンジン設定代行　**日時:** 2020/12/14 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 株式会社インキュービックです。 当社ではご登録頂いている各ユーザにおいて、10分に1回 APIを実行し伝票処理を行うアプリを運営しております。 PHP SDK(Ver1.1)を導入しており、トークンまわりの処理は アプリ側で実施していない状況ですが、 まれにアクセストークンが切れてしまう現象が発生しております。 PHP SDKのバージョンを上げたら改善されますでしょうか？ アドバイスいただけますと幸いです。 どうぞ、よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2020/12/17 PHPのSDKに関しましては現在提供しているVer1.1が 最新のものとなっております。 [https://developer.next-engine.com/api/secure](https://developer.next-engine.com/api/secure) 状況の詳細がわかりかねますが、上記ページに記載のとおり 認証情報の有効期限が切れている状況で、マルチスレッドで リクエストを行うとエラーが返却される可能性もございます。 また、各APIエンドポイントに対しリクエストを行いますと 都度、必ず最新のaccess_token,refresh_tokenが返却されますので そちらの値をDBなどに保存のうえ、次回リクエスト時には その認証情報をお使いいただくとよろしいかと存じます。 --- # 至急確認依頼 URL: https://developer.next-engine.com/questions/1583/ **投稿者:** 長谷川徳一　**日時:** 2020/12/15 **カテゴリ:** ネクストエンジンAPIについて 申請を行ったのですが、本番用のアプリのアイコン表示されません。 こちら確認お願いできますか？ --- ## 回答 (1件) ### hamee_sys — 2020/12/15 12月7日に承認処理を行っておりますので、貴社環境にて 販売開始の処理を行っていただくことで本番アプリを ご利用いただくことが可能です。 （すでに本番アプリをご利用いただいているかと存じます） なお、審査の申請をいただいてから審査結果が出るまでは 1週間ほどを要しますので、あらかじめご了承ください。 --- # 受注伝票オプション検索APIの「のし」や「ラッピング」について URL: https://developer.next-engine.com/questions/1585/ **投稿者:** 畑中　健吾　**日時:** 2020/12/17 **カテゴリ:** ネクストエンジンAPIについて 「のし」、「ラッピング」が設定されている受注伝票に対して、 受注伝票オプション検索APIでリクエストした場合、レスポンスの「のし」、「ラッピング」の項目にどんな値が設定されていますでしょうか。 また、「のし」、「ラッピング」が設定されていない受注伝票の場合、受注伝票オプションの「のし」、「ラッピング」の値は、NULLでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2020/12/17 「のし」および「ラッピング」につきましては、当該受注伝票内の 各項目に入力されている文字列がそのまま出力されます。 また、受注伝票内に各項目が入力されていない場合は NULLで返却いたします。 --- # 欠品処理のAPI URL: https://developer.next-engine.com/questions/1588/ **投稿者:** Nag　**日時:** 2020/12/25 **カテゴリ:** ネクストエンジンAPIについて 欠品処理を行えるAPIエンドポイントはありますか？ --- ## 回答 (1件) ### hamee_sys — 2020/12/28 誠に申し訳ございませんが、欠品処理を行うための APIはご用意しておりません。 --- # 印刷済み/出荷済みステータスの変更について URL: https://developer.next-engine.com/questions/1593/ **投稿者:** Nag　**日時:** 2021/01/12 **カテゴリ:** ネクストエンジンAPIについて 印刷済み/出荷済みステータスへの変更については以下エンドポイントで行えるということはわかったのですが、 - 受注伝票納品書印刷済み(エンドポイント /api_v1_receiveorder_base/receipted)　印刷済み状態へ - 受注伝票出荷確定処理(エンドポイント /api_v1_receiveorder_base/shipped)　出荷済み状態へ 複数の受注伝票を一括で更新するAPIはありますでしょうか？ ない場合、受注数分だけAPIをコールすることになるので、 APIコール回数が料金表の価格帯の上限10000を超えることになるのですが、 見積もりについてはどちらの窓口に相談すればよいでしょうか？ [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) --- ## 回答 (1件) ### hamee_sys — 2021/01/12 納品書印刷済みへの変更につきましては、下記エンドポイントより 一括での処理が可能です。 　・納品書印刷済み一括更新： 　　[https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdat...](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdatereceipted) 出荷確定処理につきましては、一括での処理はできず、 受注伝票ごとの処理が必要です。 API通信費用のご相談につきましては、下記サポート窓口までご連絡ください。 　電話：03-4570-0637(平日10:30～17:30) 　メール：[info@next-engine.jp](mailto:info@next-engine.jp) --- # 購入者情報を取得して外部システムと連携したい URL: https://developer.next-engine.com/questions/1596/ **投稿者:** 中條 裕介　**日時:** 2021/01/20 **カテゴリ:** ネクストエンジンAPIについて APIを利用して受注明細の情報を取得して、弊社のサーバーに登録したいと考えております。 その際に購入者の情報を管理したいのですが、ネクストエンジン側では購入者を識別するような一意なIDはありますでしょうか。 （例えばAさんが複数回、購入したとしてもAさんという1つのデータとして管理したい） ある場合は、どのように取得すればよいでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2021/01/20 購入者情報を識別するユニークなキーは保持しておりません。 そのため、氏名や電話番号、メールアドレスなどの情報を用いて 名寄せを行っていただく必要がございます。 --- # 商品マスタへの商品一括登録にてアイテム数の制限はありますか？ URL: https://developer.next-engine.com/questions/1597/ **投稿者:** 福木　章了　**日時:** 2021/01/20 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 テスト店舗にて在庫連携と商品マスタへの登録を書きテストさせていただきました。 その結果、250件の登録はできたのですが送信したデータが1000件を超えるものであったため、原因分析をしたいと思っています。 下記3点教えてください。 ---------- 1. テスト店舗での制限、一括登録の上限などございますでしょうか。 2. キューのエラー確認などはどこで行えばよかったでしょうか。 3. マイナスに振れる在庫加算数の時、在庫数の更新はどのように扱われますか。 　※ 在庫数10に対して zaiko_su = -30 で更新したときなど ---------- よろしくお願いいたします。 --- ## 回答 (7件) ### hamee_sys — 2021/01/20 1.sandbox環境において、制限などは特にございません。 　登録データの内容に問題がないかご確認ください。 2.登録結果につきましては、下記エンドポイントより 　キューの検索を実行することが可能です。 　・アップロードキュー検索 　　[https://developer.next-engine.com/api/api_v1_system_que/search](https://developer.next-engine.com/api/api_v1_system_que/search) 　なお、メイン機能内、下記メニューからも商品一括登録の状態を確認することが可能です。 　該当メニュー： 　（β版）商品管理の一括登録（商品マスタ一括登録も同様） 　- ページ最下部「商品一括登録の状態・履歴」 3.在庫数は「0」となります。 ### 福木　章了（質問者） — 2021/01/20 お世話になっております。 回答ありがとうございました。 すみません、追加で2点ほど教えてください。 ---------- 4. アップロードキュー検索では『メッセージ』にて登録が止まったsyohin_codeなどの情報は提供されますでしょうか。 5. 商品登録時に在庫数がマイナス値（例：zaiko_su = -1600）の場合、エラーとなりますか。 ---------- 4について （β版）商品管理の一括登録「商品一括登録の状態・履歴」を確認したところ、登録が止まったレコードについての情報がありませんでした。 アップロードキュー検索では『取り込みが止まった場所』を探すことができると考えてよかったですか。 5について 登録されたレコード以外を抽出したところ、最初の値（止まった原因と思われるレコード）の在庫数が【-1069】となっていました。 弊社の社内システムに予約販売が組み込まれているためこのような数値となっています。 これが登録が止まる原因であれば修正したいと思いますので教えてください。 よろしくお願いいたします。 ### hamee_sys — 2021/01/20 4. 例として下記のようなメッセージが表示されますので、 商品コードの特定は可能です。 =========================================== [3]件取り込みましたが、以下をご確認ください。 商品マスタCSVの[2]行目：フリー在庫数が0個のため、 出庫されませんでした。(商品コード:XXXX) =========================================== しかしながら、商品コードの明記の有無はエラー内容により 異なります。 たとえば、仕入先コードに未登録のものが指定されていた場合は 下記のようなメッセージが表示されます。 =========================================== 117行目 仕入先コードは登録済のものを入力してください =========================================== 5. 新規登録時にマイナスの値を設定して登録を行った場合、 在庫数は「0」で登録されます。 そのため、今回の処理が止まった原因は他にあるかと思われますので CSVの内容など改めてご確認いただければと存じます。 ### 福木　章了（質問者） — 2021/01/21 お世話になっております。 回答ありがとうございました。 その後いろいろとテストしてみた結果、エラーとなっているレコードの特定が出来ました。 以下1点教えてください。 ---------- 6. 商品名に文字【&】が入っている事が原因でした。その他【&】以外にシステム内で読み込まれない可能性のある文字はありますか ---------- 6について 止まったと推定したレコードを記載します。 =========================================== syohin_code,sire_code,jan_code,kataban,syohin_name,genka_tnk,hyoji_tnk,baika_tnk,zaiko_su 20033,9999,4980511620033,20033,"GGジンジャー グレーター&マドラー ホワイト",180,0,200,72 =========================================== ※この中の＆をスペースに変更したところ、下記エラーは発生せず取り込みが出来ました。 ▼上記レコードをシングルでPOSTした結果（アップロードキュー検索より抽出） ---------- [2021-01-21 11:54:16] production.INFO: array ( 'result' => 'error', 'code' => '006005', 'message' => 'データが1件も存在しません', 'access_token' => （以下略） ---------- ▼投げたパラメータ ---------- access_token=--&refresh_token=--&wait_flag=1&data_type=csv&data=syohin_code,sire_code,jan_code,kataban,syohin_name,genka_tnk,hyoji_tnk,baika_tnk,zaiko_su 20033,9999,4980511620033,20033,"GGジンジャー グレーター&マドラー ホワイト",180,0,200,72 ---------- よろしくお願いいたします。 ### hamee_sys — 2021/01/21 メイン機能にて使用不可と定義している文字は以下ページに記載がございます。 　・本システムの使用不可文字： 　　[https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8...](https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8688/) 今回のエラーの起因である「&」につきましては、上記ページでは定義しておりませんが、 画面からの操作とAPIリクエストによる差異でございます。 メイン機能からの操作では「&」が商品名などに含まれていることは問題ないものの、 APIリクエスト文に含まれている場合、パラメータを繋ぐ文字列との関連によりエラーが 発生する可能性がございます。 ### 福木　章了（質問者） — 2021/01/21 お世話になっております。 回答ありがとうございます、確認させていただきました。 リンク先の文字については既にエスケイプ処理しているので、これ以外にないと言う事であれば問題なさそうです。 ありがとうございます。 ちなみに、今回行ったアップロード実験の結果【＆】については全角/半角ともにダメでした。 ※ダブルクォーテーションで囲っても同じ結果。 その他、思いつく限りのエスケイプ処理をやってみたのですが、こちらもすべてダメでした。 別の文字への置換で対応したいと思います。 情報提供ありがとうございました。 ■追加 商品コードに【_｜アンダーバー】が入っているとキューにスローされた後の登録工程でエラーが発生する用です。 このエラーはキューに入ってからなので【商品コードは半角英数,ハイフンで入力してください】とメッセージをもらえました。 【_】は画面上からの登録できたのですが、登録できる方がイレギュラーと考えてよかったでしょうか。 ### hamee_sys — 2021/01/28 アンダーバーの取り扱いにつきましては、ご認識のとおりでございます。 --- # 【至急】APIのクエリについて URL: https://developer.next-engine.com/questions/1598/ **投稿者:** 長谷川徳一　**日時:** 2021/01/20 **カテゴリ:** ネクストエンジンAPIについて /api_v1_receiveorder_row/search こちらのAPIを利用して、データを取得したいのですが、 「日付」や「期間」で絞り込んでデータを取得するための記述はどのようにすれば良いでしょうか。 ご教示のほど、宜しくお願いいたします。 --- ## 回答 (5件) ### hamee_sys — 2021/01/20 比較演算子を用い、特定のフィールドを条件に指定することで 日付や期間指定での検索が可能です。 　・パラメータ比較演算子： 　　[https://developer.next-engine.com/api/param/operator_compare](https://developer.next-engine.com/api/param/operator_compare) ### 長谷川徳一（質問者） — 2021/01/20 期間を指定する場合のサンプルがあれば記載お願いできますでしょうか。 ### 福木　章了 — 2021/01/20 至急と言う事だったので横から失礼します。 お目汚しでしたら飛ばしてください。 抽出したいのが【作成日】だったとします。 作成日のカラム名は【receive_order_row_creation_date】なので、これにパラメータを付けてPOSTします。 具体的に 2021-01-15 00:00:00 ～ 2021-01-17 00:00:00 の期間抽出とした場合下のように記載します。 【receive_order_row_creation_date-gte=2021-01-15 00:00:00&receive_order_row_creation_date-lte=2021-01-17 00:00:00】 これを、access_tokenなどと同列のパラメータとして&演算子で追加すればOKです。 注文明細で実行してみたことはありませんが、商品マスタではこの形式でできるので同じだと思います。 お試しください。 ### 長谷川徳一（質問者） — 2021/01/20 福木さま ご記載いただいた対応方法にて解決できました。 教えていただき、誠にありがとうございます。 ### 福木　章了 — 2021/01/21 お役に立てて良かったです。 お互いCreate作業頑張りましょう。 --- # 「新規受付」の受注伝票の取得について URL: https://developer.next-engine.com/questions/1599/ **投稿者:** 畑中　健吾　**日時:** 2021/01/20 **カテゴリ:** ネクストエンジンAPIについて (1)受注伝票のステータスが「新規受付」の場合、 受注伝票の受注状態区分は「1.受注メール取込済」の値が登録されている認識ですがあってますでしょうか。 (2)受注明細検索APIにて、受注伝票を取得する場合、ステータスが「新規受付」の受注伝票も取得されますでしょうか。 (3)(2)で取得される場合、受注明細検索APIにて、ステータスが「新規受付」の受注伝票を取得させない検索条件の設定方法がございましたら、教えていただけないでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2021/01/20 (1) はい、認識のとおりでございます。 (2) 受注状態区分(receive_order_order_status_id)を条件に 設定しない限り、取得されます。 (3) 受注状態区分(receive_order_order_status_id)で 「1(受注メール取込済)」を除外する条件を設定いただければ可能です。 　・パラメータ比較演算子 　　[https://developer.next-engine.com/api/param/operator_compare](https://developer.next-engine.com/api/param/operator_compare) 　　- [receive_order_order_status_id-nin=1]で設定可能かと存じます 受注状態区分の情報につきましては、下記エンドポイントより取得可能です。 　・受注状態区分情報取得 　　[https://developer.next-engine.com/api/api_v1_system_orderstatus/info](https://developer.next-engine.com/api/api_v1_system_orderstatus/info) --- # Redirect URIと本番環境の登録について教えてください。 URL: https://developer.next-engine.com/questions/1601/ **投稿者:** 福木　章了　**日時:** 2021/01/22 **カテゴリ:** その他 お世話になっております。 redirect_uri について2点ほど教えてください。 ---------- 1. access_tokenの取得後、API接続する際にredirect_uri に登録していないホストからアクセスする方法はありますか 2. redirect_uri は1つのアプリに対して1つの登録となるのでしょうか 3. 1ユーザー1サーバーの構成となっているシステムの場合、本番環境設定のredirect_uri はどのように登録すればよいでしょうか ---------- 弊社の開発システムの構成上、共通のアクセス元を用意することが難しいです。 (1ユーザー1サーバーの構成にしているため) redirect_uri はAPI接続の際にも確認される項目であったと思います。 複数のサーバーにて1つのアプリを利用する場合、どのような登録をすればよかったでしょうか。 1について access_token取得までであれば専用のサーバー立ててやりくりできると思い質問させていただきました。 2について ユーザーごとにredirect_uriの登録が出来れば問題は解決されるのでお聞きしました。 3について 審査の際にどのように申請すればよいかわからなかったためお聞きしました。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2021/01/28 アクセス元のホストとネクストエンジンへ登録したRedirect URIが 不一致の場合、APIを使用することはできかねます。 不一致の場合、下記のエラーメッセージが返るかと存じます。 　・メッセージコード： 　　[https://developer.next-engine.com/api/param/message](https://developer.next-engine.com/api/param/message) 　　- 001006:アクセス元ホストとネクストエンジンで指定したredirect_uriが一致しません。 また、Redirect URIにつきましては1アプリ1つの登録となります。 --- # 受注伝票の受注番号と複数配送先の受注伝票について URL: https://developer.next-engine.com/questions/1602/ **投稿者:** 畑中　健吾　**日時:** 2021/01/22 **カテゴリ:** ネクストエンジンAPIについて (1) 受注伝票検索のフィールド一覧の受注番号の備考欄に「原則、店舗内で一意に付与される番号（重複する可能性あり。）」とありますが、受注番号が重複する場合が、どういったケースか教えていただけないでしょうか。 (2) 配送先が複数存在する受注伝票がモールからネクストエンジンへ連携された場合、受注番号は全て同じ値になりますでしょうか。 (3) 受注伝票・受注明細フィールドなどで、配送先が複数存在する受注伝票かどうかを判断する項目はありますでしょうか。 --- ## 回答 (2件) ### 畑中　健吾（質問者） — 2021/01/27 上記の質問ご確認はいただけましたでしょうか。 お忙しいところ恐縮ですが、宜しくお願い致します。 ### hamee_sys — 2021/01/28 (1) 店舗側の仕様により異なりますが、たとえば、CSVデータを用い メイン機能へ受注情報を取り込む際、同じデータを複数回にわたり 取り込むと、同じ受注番号で異なる伝票番号の受注伝票が メイン機能で生成されるケースがございます。 (2) 複数配送先が存在する受注伝票の対応につきましては、 下記のとおり、対応モール・カートが限定されております。 　[https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_tori...](https://manual.next-engine.net/main/orders/ord_torikomi-shori/juchu_torikomi/37551/) また、受注番号につきましては、上記ページに記載のとおり 子伝票にあたる受注伝票にのみ、受注番号の末尾に「-h+数字」が付与されます。 (3) 上記のとおり、受注番号の末尾に振られた文字列から 検索することは可能かと存じます。 --- # API取得項目の最大桁数 URL: https://developer.next-engine.com/questions/1603/ **投稿者:** 櫛部　泰明　**日時:** 2021/01/22 **カテゴリ:** ネクストエンジンAPIについて 各APIで取得可能な項目の最大桁数を確認出来るマニュアルはありますか？ --- ## 回答 (2件) ### hamee_sys — 2021/01/28 各取得項目の最大桁数に関するマニュアルなどはご用意しておらず、 現時点でご用意のお約束はできかねます。 何とぞご了承ください。 ### 櫛部　泰明（質問者） — 2021/01/28 回答ありがとうございます。 メイン機能側のマニュアルページに桁数を記載しているもの見つけたので、こちらで確認していこうと思います。 [https://manual.next-engine.net/main/starter/str_overview/kiso_menu-name/...](https://manual.next-engine.net/main/starter/str_overview/kiso_menu-name/11159/) --- # 受注明細検索の挙動について URL: https://developer.next-engine.com/questions/1610/ **投稿者:** 榊間　浩人　**日時:** 2021/01/28 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注明細検索の機能を利用したアプリをユーザーに提供しております。お客様への対応のためお教え頂きたのですが以下2点ご確認お願い致します。 1. お客様の環境でreceive_order_shop_id-eqとreceive_order_row_shop_cut_form_id-eqとフィールドに指定して検索を行ったところ、複数レコードを取得しました。 ただ、メイン機能上には該当の receive_order_shop_idとreceive_order_row_shop_cut_form_idを持つ受注データには受注明細が1件しかなく、他に同一の receive_order_row_shop_cut_form_id を持つデータもメイン機能上からは確認できませんでした。 こちらの挙動について、どのような場合に発生するかお教えください。 2. 上記リクエストを試した際、receive_order_row_quantity が0のレスポンスが返ってきていました。ただ、メイン機能上で受注を作る場合は `受注数は1以上にしてください` というエラーが出るかと思います。こちらもどのような場合にreceive_order_row_quantity が0の受注明細が作成されるかお教えください。 --- ## 回答 (1件) ### hamee_sys — 2021/02/03 大変お手数ではございますが、以下の情報を サポート窓口までお送りいただけますでしょうか。 別途、調査をさせていただきます。 　・該当の企業様情報 　・リクエスト日時 　・リクエスト時のaccess_token 　・リクエスト内容 　・レスポンス内容 　・アクセス元IPアドレス（おわかりであれば） 【サポート窓口】 メール：[info@next-engine.jp](mailto:info@next-engine.jp) --- # 在庫更新プログラムについて URL: https://developer.next-engine.com/questions/1612/ **投稿者:** Kosuke_Ikeura　**日時:** 2021/01/29 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 汎用店舗に対する在庫連携プログラムについて質問です。 NextEngineのシステムからのリクエストは1日何回、どのようなタイミングで送られますでしょうか？（例：毎日17時に1回等） またそれは設定可能なものでしょうか？ また、おそらく心配はいらないと思いますが、 JavaScript・TypeScriptを使用したLambda関数でリクエストを受け取る設計にしようと考えているのですが、こちらは実現可能でしょうか？ お手隙の際に返信いただければ幸いです。 --- ## 回答 (1件) ### hamee_sys — 2021/02/03 汎用形式での連携に関わらず、ネクストエンジンでの在庫情報の 更新は以下のタイミングで行われます。 　[https://manual.next-engine.net/faq/stock/1484/](https://manual.next-engine.net/faq/stock/1484/) そのため、更新タイミングをご指定いただくことはできかねます。 また、在庫更新情報につきましては、以下に明記のある形式で 送信いたしますので、それらの情報を受け取れる形であれば 問題ございません。 　[https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5...](https://manual.next-engine.net/main/stock/stk_settei-unyou/zaiko_hanyo/5174/#a1) また、汎用形式の連携に関しては、ネクストエンジンAPIとは異なるため 下記ネクストエンジンのサポート窓口までお問い合わせください。 電話：03-4570-0637(平日10:30～17:30) メール：[info@next-engine.jp](mailto:info@next-engine.jp) --- # 受注伝票出荷確定処理APIについて URL: https://developer.next-engine.com/questions/1613/ **投稿者:** 畑中　健吾　**日時:** 2021/02/02 **カテゴリ:** ネクストエンジンAPIについて 受注伝票出荷確定処理APIにて、 更新される項目は以下の認識ですがあってますでしょうか。 また、他に更新される受注伝票の項目などがあれば、ご教授お願いします。 ・出荷確定日　＝　受注状態が出荷確定済みになった日 ・受注状態　　＝　50:出荷確定済(完了) --- ## 回答 (1件) ### hamee_sys — 2021/02/03 ご認識のとおりでございます。 受注伝票上に項目はございませんが「最終更新日」も同様に更新されます。 また、企業様の設定、運用により異なりますが、自動送信メール機能にて 発送メールが送信された場合「メール送信状態値」が更新される場合もございます。 --- # 商品マスタの「パッケージ込みの高さ/幅/奥行/重さ」の取得、更新について URL: https://developer.next-engine.com/questions/1616/ **投稿者:** rokuhira　**日時:** 2021/02/19 **カテゴリ:** ネクストエンジンAPIについて 掲題の件について、各項目は商品マスタアップロードAPI（ [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) ）で更新が可能かと思いますが、 商品マスタ検索API（ [https://developer.next-engine.com/api/api_v1_master_goods/search](https://developer.next-engine.com/api/api_v1_master_goods/search) ）で取得することは不可能でしょうか。 商品マスタ検索APIのドキュメントの「フィールド一覧」タブに該当の項目がなく、上記を取得したい場合はどのようにすれば良いかご教示いただけますと幸いです。 どうぞよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2021/03/11 お問い合わせの項目につきましては（β版）商品管理メニューで 設定可能な項目でございます。 現在、（β版）商品管理内の情報取得および検索、更新に 関しましてはAPI未対応でございます。 今後、対応の計画はございますが、現段階ではリリース予定などの 詳細は決まっておりません。 ご理解賜りますようお願いいたします。 --- # 商品マスタ検索APIを使って配送料無料を取得する方法について URL: https://developer.next-engine.com/questions/1621/ **投稿者:** Nag　**日時:** 2021/03/03 **カテゴリ:** ネクストエンジンAPIについて 商品マスター検索APIのフィールド一覧について [https://developer.next-engine.com/api/api_v1_master_goods/search](https://developer.next-engine.com/api/api_v1_master_goods/search) 以下マニュアル「商品管理の項目名とルール」の「配送料無料」の項目に相当するフィールドが見当たらないですが、 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) APIを使ってこの商品項目「配送料無料」を取得する方法はありますでしょうか。 もしくは、別のエンドポイントなどで取得することは可能でしょうか。 --- ## 回答 (1件) ### hamee_sys — 2021/03/11 お問い合わせの項目につきましては（β版）商品管理メニューで 設定可能な項目でございます。 現在、（β版）商品管理内の情報取得および検索、更新に 関しましてはAPI未対応でございます。 今後、対応の計画はございますが、現段階ではリリース予定などの 詳細は決まっておりません。 ご理解賜りますようお願いいたします。 --- # （β版）商品管理のカテゴリ情報の取得について URL: https://developer.next-engine.com/questions/1624/ **投稿者:** shiromofufactory　**日時:** 2021/03/10 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 （β版）商品管理＞ページ情報＞カテゴリ＞店舗内カテゴリx の登録情報は、現時点でAPIでは取得不可能でしょうか？ （β版）商品管理のページ情報自体がAPI未対応とどこかで目にした記憶もあるのですが、念のため確認させていただけましたら幸いです。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2021/03/11 現在、（β版）商品管理内の情報取得および検索、更新に 関しましてはAPI未対応でございます。 今後、対応の計画はございますが、現段階ではリリース予定などの 詳細は決まっておりません。 ご理解賜りますようお願いいたします。 --- # 公開されているnode.jsのSDKはありますでしょうか？ URL: https://developer.next-engine.com/questions/17/ **投稿者:** app開発者　**日時:** 2016/12/01 **カテゴリ:** 開発環境・SDKについて node.jsを利用してネクストエンジンアプリの開発を検討しているのですが、 すでに公開されているnode.js製のSDKはありますでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2016/12/02 ネクストエンジン公式のSDKにnode.js版はありません。 確認したところ、github上にネクストエンジンアプリ開発者の方が作成されたnode.jsのSDKがございます。 [https://github.com/Leko/node-nextengine](https://github.com/Leko/node-nextengine) 公式ではありませんのでネクストエンジンとしてSDKのご利用方法をサポートすることはできかねますが、こちらをご利用するのも一つの方法かと思いますのでご検討ください。 ### 今村 邦人 — 2023/06/26 [https://developer.next-engine.com/api/sdk](https://developer.next-engine.com/api/sdk) を確認したところ、node.js の SDK は非公式という表記が無いようですので、公式と判断して良いでしょうか。 --- # 仕入先マスタ検索 日時型データへの比較演算子設定に関して URL: https://developer.next-engine.com/questions/1745/ **投稿者:** hiroakinakama　**日時:** 2022/05/17 **カテゴリ:** ネクストエンジンAPIについて 仕入先マスタ検索時、日時型データへの比較演算子設定に関して質問です。 該当エンドポイント：仕入先マスタ検索 [https://api.next-engine.org/api_v1_master_supplier/search](https://api.next-engine.org/api_v1_master_supplier/search) 最終更新日（supplier_last_modified_null_safe_date）に対して、パラメーター比較演算子の -gte を設定して使用していました。 意図としては、直近数日以内に更新された仕入先マスタを取得するためです。 しかしながら今年の4月中旬頃より、指定したパラメーターが正常に動作していない様に見受けられます。 POST送信時例：'supplier_last_modified_null_safe_date-gte': '2022-05-14' 取得したマスタの該当データ：supplier_last_modified_null_safe_date: '2021-07-20 15:33:55' こちらは以前と何か仕様が変更されましたでしょうか。 ご確認のほどよろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2022/07/05 こちら、調査・回答が遅くなり大変申し訳ございません。 調査したところデータベースの内部的な設定に不備がございました。 正しく実行できるよう設定を直しましたので2022/06/13 12:31頃以降は正しい結果が返ってくるか思われます。 ご確認のほど、何とぞ、よろしく御願いたします。 --- # ローカルでの動作検証について URL: https://developer.next-engine.com/questions/19/ **投稿者:** user01　**日時:** 2016/12/02 **カテゴリ:** ネクストエンジンAPIについて 作成したネクストエンジンアプリは、ローカル環境（PC）で動作検証できますか？ --- ## 回答 (2件) ### hamee_sys — 2016/12/05 ローカルでの動作検証は可能です。 ローカル環境でのAPIご利用までの流れをご説明している記事がございますので、 こちらをご参考にしていただければ幸いです。 　ネクストエンジンAPIの使い方 　[http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd](http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd) 1度uidとstateを取得し、access_tokenとrefresh_tokenを取得すると、refresh_tokenの有効期限である 72時間以内にリクエストを送っていただければトークンの更新が可能なため、バッチでも実質継続利用が可能となります。 継続利用については以下のマニュアルをご参照ください 　NE APIにおけるrefresh_tokenについて 　[http://api.next-e.jp/refresh_token.php](http://api.next-e.jp/refresh_token.php) なお、ネクストエンジンAPIは公開されたWebアプリケーションを想定しているため、 ローカルPCでのトークン取得はあくまで動作検証に留めることをおすすめいたします。 ### yuuna — 2016/12/08 利用可能ですが、callbackを[https://localhost](https://localhost)として登録＆受け取る必要があります。 その際にhttpsが必須となるとなりますが、ローカルにhttpsサーバーって立てるの大変ですよね。 裏技なのですが、httpsで受け手エラーになったあとに同じ引数のままURLをhttpにかえると認証が通れたりします。 私はこの方法でよく開発しています！ --- # access_token/refresh_tokenを「日次で」最新の状態にするような仕組みについて URL: https://developer.next-engine.com/questions/1909/ **投稿者:** CRM User　**日時:** 2024/08/27 **カテゴリ:** ネクストエンジンAPIについて 『Zoho CRM』というクラウドサービスから 『ネクストエンジンAPI』の［受注伝票アップロード］をコールし、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 『ネクストエンジン』の［受注伝票］データを作成する処理を開発中です。 それに際し、↓日次で［access_token］をリフレッシュする仕組みを構築しました。 ＜仕組みの概要＞ 「毎日21時」に、入力パラメータに［refresh_token］を指定し、↓「企業情報取得」をコールする。 [https://developer.next-engine.com/api/api_v1_login_company/info](https://developer.next-engine.com/api/api_v1_login_company/info) ⇒［access_token］の有効期間は「1日」のため、↑これを日次実行すれば、 　［access_token］が毎日リフレッシュされる。 しかし、上記仕組みで↓［access_token］がリフレッシュされない、という事象が発生しました。 例） 【実行日時】8/24 21:00【起動結果】"access_token_end_date": "2024-08-25 21:00:12" 【実行日時】8/25 21:00【起動結果】"access_token_end_date": "2024-08-26 21:00:57" 【実行日時】8/26 21:00【起動結果】"access_token_end_date": "2024-08-26 21:00:57" ← リフレッシュされず これは、［access_token］の有効期間「内」に仕組みが実行されたから、と推測されます。 以下、質問です。 ■質問1 『ネクストエンジンAPI』コール時、入力パラメータに［refresh_token］を指定しても、 ［access_token］の有効期間「内」だった場合、リフレッシュされないでしょうか。 ■質問2 「質問1」の回答が YES である場合、［access_token］の有効期間「内」に ［access_token］をリフレッシュする方法(※)はございますでしょうか。 ※「uid・state取得」からの「access_token取得」以外で、です。 ＜参考リンク＞ 2018/6/20 (水) 16:50 [https://developer.next-engine.com/questions/854](https://developer.next-engine.com/questions/854) ▼▼▼引用開始▼▼▼ 最初にWebアプリでaccess_token/refresh_tokenを取得後、 DB等に保持しaccess_token/refresh_tokenを最新の状態にするような仕組みを構築することで、 ￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣ その後は更新された最新のaccess_token/refresh_tokenを利用することにより認証を自動化することが可能です。 ▲▲▲引用終了▲▲▲ 以上、ご確認・ご回答よろしくお願いいたします。 --- # アプリ開発時に必要な利用料金について質問 URL: https://developer.next-engine.com/questions/20/ **投稿者:** user01　**日時:** 2016/12/02 **カテゴリ:** 開発環境・SDKについて ネクストエンジンアプリの開発を検討しています。 アプリを開発するにはネクストエンジンを契約する必要がありますか。 開発会社のため、弊社では受注や在庫の管理自体は行いません。 ただし、受注取込用のアプリを作成予定のため、受注伝票が起票できるかの検証をしたいと思っております。 この場合、月額費用はこちらのページに記載されている内容と同じく、受注件数による従量課金となりますでしょうか。 [http://next-engine.net/price](http://next-engine.net/price) --- ## 回答 (1件) ### hamee_sys — 2016/12/02 アプリ開発用のテスト環境をご用意しております。 テスト環境のご利用料金は無料です。ぜひご利用ください。 --- # tokenのexpireについて URL: https://developer.next-engine.com/questions/21/ **投稿者:** yuuna　**日時:** 2016/12/08 **カテゴリ:** ネクストエンジンAPIについて tokenがログインのたびにかわる仕様について、batchでアクセス中にユーザーがアプリにログインしてしまい エラーになるケースが多々あります。こちらについて対策などなされる予定はありますでしょうか？ #バッチ専用ユーザーを用意するというのはありますが、ユーザーに説明するのにしきい高いです。 --- ## 回答 (1件) ### hamee_sys — 2016/12/09 アクセストークンですが、ログインの度に必ず更新されるのではなく、アクセストークンの有効期限が切れている場合にアプリの認証処理を走らせたタイミングで更新されます。 例えばアクセストークンの有効期限が10:00までだった場合 　1. 09:00 [バッチ] APIリクエスト （アクセストークンA） 　2. 09:30 [画面] アプリ認証　　　（アクセストークンA）←ここでは更新されない 　3. 09:50 [バッチ] APIリクエスト （アクセストークンA） 　4. 10:01 [画面] アプリ認証　　　（アクセストークンB）←ここで更新される 　5. 10:02 [バッチ] APIリクエスト （アクセストークンB） という状態になります。 現状の仕様では、リクエストの度にDBなどの永続化されたデータを毎回参照し、アプリの画面など別のプロセスでトークンの更新があっても問題ないように実装いただくのが回避策になるかと思います。 上記のため、対策の予定はございません。 ただ、開発者の皆様がご利用しやすいAPIにしていきたいと存じますので、ご意見などありましたら投稿いただけますと幸いです。 --- # ネクストエンジンAPIで出来ること URL: https://developer.next-engine.com/questions/22/ **投稿者:** 小宮山　佳　**日時:** 2016/12/14 **カテゴリ:** その他 弊社では、簡単にECショップを開設できるBASE,STORESに似たプラットフォームを開発しております。 今後の拡大のためにネクストエンジンと接続することを考えているのですが、以下目的を達成することは出来るのでしょうか。 まだAPI資料を読み込んでいる最中であり、込み入った質問でなく恐縮です。 [質問事項] ・既にYahoo!ショッピングや楽天に登録されている商品を、別プラットフォームへ一括アプロード ・管理画面からの商品一括登録 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2016/12/19 ネクストエンジンAPIとメイン機能に分けてご説明致します。 まず、各マニュアルは以下になりますのでご参照下さい。 ネクストエンジンAPI [http://api.next-e.jp](http://api.next-e.jp) ネクストエンジン メイン機能 [http://manual.ec-doc.net/](http://manual.ec-doc.net/) >既にYahoo!ショッピングや楽天に登録されている商品を、別プラットフォームへ一括アプロード 既にモール側に登録されている商品情報をネクストエンジンに取り込むという点では メイン機能で実現可能です。 以下が該当マニュアルです。 [http://manual.ec-doc.net/beta_shouhinkanri/](http://manual.ec-doc.net/beta_shouhinkanri/) >管理画面からの商品一括登録 ネクストエンジンAPIでの商品一括登録は可能です。 以下が該当マニュアルです。 [http://api.next-e.jp/param_upload_goods.php](http://api.next-e.jp/param_upload_goods.php) メイン機能での商品一括登録は可能です。 以下が該当マニュアルです。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/g003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/g003/) ネクストエンジンAPIで可能なリクエストについては以下にエンドポイント一覧を記載致します。 ご参照下さい。 [http://api.next-e.jp/request_url.php](http://api.next-e.jp/request_url.php) --- # メイン機能クリックで999999エラー URL: https://developer.next-engine.com/questions/23/ **投稿者:** 山岸　弘基　**日時:** 2016/12/15 **カテゴリ:** その他 以前から、夜中の３時前後に、テスト環境の「メイン機能」をクリックすると、 api.next-engine.org により 999999 エラーが表示されます。 アドレスバーには、 [https://api.next-engine.org/Api_Mf/login?main_function_web_host_name=san...](https://api.next-engine.org/Api_Mf/login?main_function_web_host_name=sandbox.next-engine.org&main_function_schema_code=164&main_function_user_code=XXX&authentication_code=XXX&operator_login_code=XXX&operator_name=XXX&ip_address=XXX&running_started=1) （codeなどはXXXに変えてあります。） 画面には、 {"result":"error","code":"999999","message":"API\u30b5\u30fc\u30d0\u30fc\u306e\u30b7\u30b9\u30c6\u30e0\u30a8\u30e9\u30fc\u304c\u767a\u751f\u3057\u307e\u3057\u305f\u3002"} （多分、デコードすると、「APIサーバーのシステムエラーが発生しました。」のはず。 メイン機能もAPIで実装されているのかしら？ とか思いつつ、どういう仕組みになっているのか、興味深々です。 --- ## 回答 (5件) ### 山岸　弘基（質問者） — 2016/12/19 この状態のときに、 /api_v1_master_goods/search コールすると、 999999 APIサーバーのシステムエラーが発生しました。 が返ってきて、 /api_v1_login_user/info コールすると、 000001 存在しないパス[/api_v1_login_user/info]にアクセスしました。 が返ってくる。 てことは、やはりメイン機能もAPIで実装されていて、 result が error のとき、戻り値だけ表示しているってこと？ 勝手に深読みすると、 メイン機能のアプリケーションサーバーと、 データベースサーバーが分かれていて、 APIサーバーは、データベースサーバーのフロントに位置するとか？ で、 「メイン機能サーバーが混み合って・・」は、 データベースサーバーの負荷を見てるとか？ でも、 「メイン機能サーバーが混み合って・・」は、 発生するタイミングがショップさん毎に異なるし、 /api_v1_receiveorder_base/update を２５０回連続コールしても発生しないショップさんもあるれば、 /api_v1_receiveorder_row/search の入力パラメータに receive_order_include_possible_order_id-in を使うと、２、３回連続コールしただけで発生するショップさんもあるし、 これは、 receive_order_include_possible_order_id にインデックスがついてなくて、DBMSがハングしてるのかしら？ でも、同じ処理で、発生しないショップさんもあるし、、 このあたりの構造がわかると、 それに合わせてアプリを開発することができるのですが、 いかがでしょうか？ ### hamee_sys — 2016/12/19 メイン機能は認証に関して、APIを経由しデータアクセスを行っています。 この問題は弊社でも把握しており、対策を検討中です。 ご不便をおかけいたします。ご了承下さい。 ### hamee_sys — 2016/12/19 > やはりメイン機能もAPIで実装されていて、 > result が error のとき、戻り値だけ表示しているってこと？ ネクストエンジンのシステム構成等に関わる内容についてはお応えできかねますが、APIへのリクエストがあった場合のアクセスは「アプリ → API → メイン機能」という経路で通信を行っております。 この内、API→メイン機能の通信に失敗するとAPIがエラーを返すという状況が起こっております。 > 「メイン機能サーバーが混み合って・・」 ご推察の通り、”企業様ごとに”メイン機能およびAPIの利用状況を総合的に判断してこのメッセージを返却しております。 APIで操作の対象となるデータの件数や検索条件、（共用サーバーでご利用いただく場合）他の企業様の利用状況などにより、同じお客様でも制限がかかる場合もあれば、かからない場合もございます。こうすれば制限がかからないとお応えできないのが心苦しいのですが、ご理解いただけますと幸いです。 APIマニュアルにも記載がございますが、夜間から早朝にかけては一部制限がかかっていないため比較的ご利用いただきやすいかと思いますのでご参考にしていただければと存じます。 「検索速度について」 [http://api.next-e.jp/param_count_search.php](http://api.next-e.jp/param_count_search.php) ### 山岸　弘基（質問者） — 2016/12/21 ありがとうございます。 発生するのがこの時刻だけなので、さほど困ってはおりません。 きっと、何かのメンテナンス時刻なんですよね。 ### hamee_sys — 2016/12/21 > きっと、何かのメンテナンス時刻なんですよね。 はい。 ご推察の通り、この時間帯はメンテナンスの処理を行っております。 この時間帯のアクセスは避けていただいた方が無難でございます。 --- # ヤフオク自動出品時のヤフオク固有項目に関して URL: https://developer.next-engine.com/questions/24/ **投稿者:** 金田　恭史　**日時:** 2016/12/22 **カテゴリ:** ネクストエンジンAPIについて 現在、自社で商品情報入力画面を作成し、御社API経由でヤフオクへ自動出品する仕組みを作っております。 商品マスタ名項目CSV([http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/))に則った形式で商品マスタ予約一括登録APIを実行し一定時間後に商品マスタが登録された後、御社のバッチで自動的にヤフオクに出品される理解でおりますが、上記の商品マスタ名項目CSVには開催期間や自動延長設定、早期終了設定や最低落札価格といったヤフオク独自の機能の設定項目がありません。 どのような方法で設定すればいいのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2016/12/26 ご質問ありがとうございます。 > 御社のバッチで自動的にヤフオクに出品される理解でおりますが、 ヤフオクへ出品する機能はメイン機能の標準機能ではなく、弊社が作成した「ヤフオク!ストア専用 オークション自動連携」アプリ(以下、ヤフオクアプリと記載)の機能になります。 そのため、 > 上記の商品マスタ名項目CSVには開催期間や自動延長設定、早期終了設定や最低落札価格といったヤフオク独自の機能の設定項目がありません。 これらヤフオク独自の設定項目は商品マスタではなく、このヤフオクアプリのDBに存在しております。 > ヤフオクへ自動出品する仕組みを作っております。 御社で作成されている仕組みはヤフオクアプリを利用する想定でしょうか。 そうであれば、ヤフオク独自の設定項目はヤフオクアプリから設定していただくことになります。 ヤフオクアプリは利用せず、御社にてヤフオクへの出品機能も作成する想定であれば、ヤフオク独自の項目はその出品機能にて保持していただくことになると思います。 --- # 伝票更新でシールが反映されない URL: https://developer.next-engine.com/questions/25/ **投稿者:** ネクストエンジン設定代行　**日時:** 2016/12/22 **カテゴリ:** ネクストエンジンAPIについて APIを用いて受注伝票の配送方法を佐川急便に変更する際、 配送方法以外に時間指定やシールも合わせて設定しております。 配送方法、時間指定は反映されますが、 シールの設定内容が反映されません。 設定する値は以前ネクストエンジンサポートの ご担当者様からご提供頂いた CSVをもとに設定しています。 設定方法やAPIの使用方法について間違いがあれば ご教示いただけないでしょうか？ ◯リクエストURL /api_v1_receiveorder_base/update ◯設定内容 1314327 どうぞ、よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/01/05 ご質問の件につきまして 詳細な調査が必要がございます。 お手数ですが、サポートセンターまでお問合せを頂ければと思います。 --- # 汎用：在庫連携APIについて URL: https://developer.next-engine.com/questions/26/ **投稿者:** 後藤　峰利　**日時:** 2017/01/17 **カテゴリ:** ネクストエンジンAPIについて 店舗別マニュアル→汎用にて用いる在庫連携APIについて以下2点ご質問です。 １） ネクストエンジン側から設定したURLに対してリクエストが行われ、在庫更新されるかと思いますが、 そのリクエストのIPは固定になりますでしょうか。 背景としては、在庫更新のURLに対してIP制限を行いたいと考えております。 ２） マニュアル上、在庫連携APIコールURLは「http://ストア様ドメイン名/UpdateStock.php」とのことですが、 管理画面から設定する箇所はフルパスで入力可能なように見えます。 たとえば、その設定箇所に任意のURLを設定したとしても ファイル名にUpdateStock.phpを用いるのは必須になりますでしょうか。 また、プロトコルはhttpのみでhttpsは難しいでしょうか。 お手数ですが、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/01/18 コメントありがとうございます。 こちら、メイン機能の質問になりますので、 お手数ですが、 サポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 ### 後藤　峰利（質問者） — 2017/01/18 ご回答ありがとうございます。 問い合わせ先誤りとのこと、失礼いたしました。 営業担当の方よりこちらで問い合わせをする旨、うかがってた為改めて確認いたします。 --- # RubyのSDKについて URL: https://developer.next-engine.com/questions/27/ **投稿者:** todorokikunkun　**日時:** 2017/01/25 **カテゴリ:** 開発環境・SDKについて 開発予定はございますでしょうか？ --- ## 回答 (3件) ### hamee_sys — 2017/01/26 現時点では開発の予定はございません。 ネクストエンジン公式のSDKではありませんが、公認のSDKがございます。 MIT Licenceとして公開されており、どなたでも利用可能です。 [https://github.com/infinity-octaver/ne_api](https://github.com/infinity-octaver/ne_api) 公式ではありませんのでネクストエンジンとしてSDKのご利用方法をサポートすることはできかねますが、こちらをご利用するのも一つの方法かと思いますのでご検討ください。 ### todorokikunkun（質問者） — 2017/01/26 ありがとうございました ### yuuna — 2017/02/06 @ todorokikunkun RubySDKのownerのyuunaです。 ご要望ありましたら、githubのissueをたてていただけると助かります。 --- # バッチ処理で受注情報取得をしたデータについて URL: https://developer.next-engine.com/questions/357/ **投稿者:** 岡田　光弘　**日時:** 2017/03/03 **カテゴリ:** ネクストエンジンAPIについて 現在、バッチ処理で定期的に受注データ取得を行う処理を開発しております。 そこで一点教えていただきたく思っております。 通常データであれば、受注ステータスが「納品書印刷待ち」のデータを取得し、API機能の「納品書印刷済み」を動かすことで 重複取得されないようにする事が可能だと思っております。 ですが、キャンセルデータ（受注キャンセル区分が'0'以外のデータ）に関しては更新できる機能がありません。 何度も取得対象となってしまいます。 APIで更新可能な項目で、データ取得済が判断できるように使用できる項目はありますでしょうか？ もしくはAPIで取得した場合に自動更新されている項目があるのであれば、そちらを取得条件と致しますので ご教授願えればと思います。 以上、よろしくお願いいたします。 --- ## 回答 (6件) ### hamee_sys — 2017/03/06 受注データ取得時に検索条件に受注キャンセル区分=0を設定することでキャンセルデータを取得しないようにする事が可能です。 ### 岡田　光弘（質問者） — 2017/03/06 ご回答ありがとうございます。 今回行いたいのが 　キャンセルデータを取得したいが、一度取得したキャンセルデータは取得対象外としたい という内容でした。 説明不足で申し訳ございませんでした。 再度ご教授願えますでしょうか。 以上、よろしくお願いいたします。 ### hamee_sys — 2017/03/06 キャンセルデータを一度取得後、取得対象にしないようにするには下記のような方法があるかと思います。 ・キャンセルデータ取得後、受注伝票受注伝票更新apiを利用して、対象データの受注状態区分や削除フラグ等を変更してそれを条件に取得外とする。 ・前回のバッチ起動日時を記録し、受注データ取得時に検索条件として[受注キャンセル日] >= [前回のバッチ起動日時]のように前回のバッチ起動日時以降でキャンセルされたデータを取得する 自動でキャンセルデータを取得済みにする機能はありませんが、このような方法でご検討頂けたらと思います。 ### 岡田　光弘（質問者） — 2017/03/06 ご回答ありがとうございます。 APIリファレンスでのAPI更新可能項目に「受注状態区分」「削除フラグ」は含まれていませんが、更新可能なのでしょうか？ もし、更新不可能であれば、ネクスエンジン様で更新されても問題ない項目等あれば教えていただきたく思っております。 起動時間等、時間での制御は誤差により取得漏れが発生する可能性がある為、極力避けたいと考えております。 以上、よろしくお願いいします。 ### hamee_sys — 2017/03/08 大変申し訳御座いません。ご指摘通り「受注状態区分」「削除フラグ」は受注伝票受注伝票更新APIでは更新することが出来ません。 他の対応としまして「受注分類タグ：receive_order_gruoping_tag」を使う方法をご提案いたします。 １）受注伝票検索でキャンセル受注取得（２で付与したタグの除外を条件にする） ２）受注伝票更新で取得できた受注に受注分類タグを追加 ３）１に戻る 受注分類タグには任意のタグを追加可能ですので、例えば [受注キャンセル確認済み] といったタグを取得済みの 受注伝票に対して受注伝票更新APIを通じて付与し、取得条件からはそのタグが付いているものを除外するという 方法をとれば実現可能です。 こちらでご検討いただけますでしょうか。 ### 岡田　光弘（質問者） — 2017/03/13 ご回答ありがとうございます。 ご提案頂いた「受注分類タグ」を使用する事で、対応を行えました。 お忙しい中、ご教授ありがとうございました。 --- # 複数メイン機能と同一アプリを複数購入している場合のアクセストークン取得について URL: https://developer.next-engine.com/questions/431/ **投稿者:** にしやまつかさ　**日時:** 2017/03/10 **カテゴリ:** ネクストエンジンAPIについて 1アカウントで複数のメイン機能とそれぞれに同じアプリを購入して運用するケースについての質問です。 アプリ側でアクセストークンを取得するのに[API認証フロー](http://api.next-e.jp/auth.php)の通りの流れになると思うのですが 仮に、、 　①メイン機能1 ＋ アプリA 　②メイン機能2 ＋ アプリA のような購入状況でアプリAを直接起動した場合に①②のどちらのアクセストークンが発行されるかはどのように決まるのでしょうか？ 上記のような運用をする場合は別ユーザーにでネクストエンジンにログインする必要がありますか？ --- ## 回答 (2件) ### hamee_sys — 2017/03/14 アプリを起動する際に、①か②かを選択する画面が表示され、そちらのuid,stateがアプリ側に渡るようになります。 ### にしやまつかさ（質問者） — 2017/03/23 ご回答ありがとうございました！ また何かありましたらよろしくお願いいたします！ --- # 受注一括登録ＡＰＩ使用時の実装方法について URL: https://developer.next-engine.com/questions/432/ **投稿者:** 村山　大　**日時:** 2017/03/13 **カテゴリ:** ネクストエンジンAPIについて 受注情報を取り込む為に受注一括登録ＡＰＩを使用しています。 ＡＰＩのレスポンスはresult=successとなっていますが、実際にデータを確認すると取り込めていません。 ＡＰＩで取り込んだデータと同様のデータを画面機能から取り込んだ所、「支払発送変換設定」の区分変換警告が出ていた為、取り込めていませんでした。 【質問1】 受注一括登録ＡＰＩ使用したときの正しい手順を教えてください。 マニュアルを調べて、以下の処理順を想定したのですが、正しい手順を教えてください。 (1)受注一括登録ＡＰＩ 　↓ 　↓　result=succesの場合 　↓ (2)アップロードキュー検索ＡＰＩ 　↓ 　↓　キューステータスの確認（que_status_id=2:全て処理成功の場合） 　↓ (3)次処理 【質問2】 アップロードキュー検索ＡＰＩの使用方法ですが、検索条件に必須の項目があったら教えてください。 以上、よろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2017/03/21 回答が遅くなりまして申し訳ございません。 質問にお答えいたします。 【質問1 回答】 　手順については問題ありません。 【質問2 回答】 検索条件は任意になっております。 支払発送変換設定に登録されていない値では更新されない仕様になっております。　 APIで受注伝票を更新した場合、対象のモールによってエラーであってもresult=successが返る場合があり実際更新されない場合があります。 エラーの発生条件について現在調査、対応検討中でございます。ご不便をお掛けいたしますが宜しくお願い致します。 --- # Java SDKの使い方 URL: https://developer.next-engine.com/questions/433/ **投稿者:** urawareds　**日時:** 2017/03/15 **カテゴリ:** 開発環境・SDKについて 皆さま、NE担当様 お世話になっております。RisukaiのGaoと申します。 近日、Java SDKを使って、データを取りたいですが、 NeApiClientのインスタンスを作成する段階で、失敗しています。 引数は以下： ・request: ServletのGetメソッドの引数request ・response: ServletのGetメソッドの引数response ・client_id: 「アプリを作る」で生成されたclient_id ・client_secret: 「アプリを作る」で生成されたclient_secret ・redirect_url: [https://api.next-engine.org/api_app/company](https://api.next-engine.org/api_app/company) フォローをお願いいたします。 よろしくお願いします。 --- ## 回答 (6件) ### urawareds（質問者） — 2017/03/15 ご教授お願いします。 ### hamee_sys — 2017/03/17 ご不便お掛けしてしまい申し訳ございません。 原因の調査を行う為にもう少し詳しい情報を教えていただけますでしょうか。 以下の情報を頂けると幸いです。 ・SDKの設置方法 ・実行したAPI名とその引数の情報 ・実行した時のエラーメッセージ ・実際に試したコード 宜しくお願い致します。 ### urawareds（質問者） — 2017/03/18 お返事ありがとうございます。 現状を説明させていただきます。 ・SDKの設置が成功：uid・stateが正常に取得できたため。 ただし、clientのコンストラクタの引数redirect_uriはlocalhostのURLを指定した、 コードは以下です。redirect_urlの指定が不正か、使い方が間違ったか、ご指摘ください。 　 @GetMapping(value = "/test") @ResponseBody public Object test(HttpServletRequest request, HttpServletResponse response) { try { NeApiClient client = new NeApiClient(request, response, "N8uUklihEsnAId", "client secret","[http://localhost:8080/api/re](http://localhost:8080/api/re)"); client.neLogin(); } catch (Exception e) { e.printStackTrace(); } return ""; } ・下記の受注伝票検索APIでメイン機能中の受注レコード（ステータスが新規のもの）を取得したいですが、 入力パラメータの使い方が不明です。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 利用しているJava APIメソッドは apiExecute(String path, HashMapapi_params, String redirect_uri)　です。 access_token、refresh_token、wait_flag、fields、offset、limit を上記の引数api_paramsに記入することを理解しておりますが、 fields、比較演算子とoffsetのところは分かりません。 また、redirect_uriはSDK ソースコードには 「ユーザーがネクストエンジンログインをした後のアプリケーションサーバーのURI」と書いてありますが、 Clientのコンストラクタに指定したredirect_uriのように、 ローカルのアドレスで宜しいでしょうか？具体的に何のアドレスを指定すればよいのか 教えていただきたいです。 お忙しいところ恐縮ですが、この2つAPIを使うためのサンプルコードを ご提示いただければ幸いです。 よろしくお願いします。 ### hamee_sys — 2017/03/22 NeApiClientインスタンス作成後のneLoginメソッドの使い方は以下になります。 @param request リクエスト @param response レスポンス @param client_id クライアントID @param client_secret クライアントシークレット @param redirect_uri ログイン後のアプリケーションサーバーのリダイレクト先を指定 　NeApiClient client = new NeApiClient(request,response,client_id,client_secret, redirect_uri); 　client.neLogin(); 実際に試されたコードで問題ないように思われます。 redirect_uriの設定ですが、ログイン後に遷移させたいURIを指定します。アプリの起動直後の場合はTOPページを指定する事になると思います。 redirect_uriはネクストエンジン本体の管理画面のアプリを作るで作成された対象のアプリの[API]タブの[Redirect URI]でTOPページでされたホスト以外を設定する事は出来ません。 以下、受注伝票検索API利用のサンプルコードになります。 　 　*受注日> 2017-01-19 00:00:00 の伝票を3件目から取得 　NeApiClient client = new NeApiClient(accessToken, refreshToken); 　HashMap api_params = new HashMap(); 　api_params.push("receive_order_date-gt", "2017-01-19 00:00:00"); 　api_params.push("offset", "2"); 　HashMap result = client.apiExecute(" /api_v1_receiveorder_base/search", api_params); 条件に指定するためのフィールドはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) フィールド一覧タブを選択していただくと、指定できる項目を確認する事が出来ます。 比較演算子についてはこちらをご覧ください。 [https://developer.next-engine.com/api/param/operator_compare](https://developer.next-engine.com/api/param/operator_compare) offsetですが検索結果のn+1番目から取得する設定になります。 0を設定すると最初から 2を設定すると検索結果の3件目から取得する事になります。 宜しくお願い致します。 ### urawareds（質問者） — 2017/03/24 ご教授ありがとうございました。 実際、私はUIなしのWindowsサービスみたいなのJava プログラムを作ろうとしています。 Loginできて、必要なデータを取れればいいです。つまり redirect_uri指定なしの APIが欲しいです。現在は指定できる redirect_uriがないため、localhostのIISホームページを 指定しています。 よろしくお願いします。 ### hamee_sys — 2017/03/29 方法としては一度アクセストークンを取得してもらう必要があります。 uid・stateを取得できたのであれば取得したuid・stateでアクセストークン取得用のapiでアクセストークンを取得します。 uid・stateは有効期限が5分なので、5分以内にアクセストークンを取得する必要があります。 アクセストークン取得用のapiはこちらをご覧ください。 　[https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) 　[注]アクセストークンを取得するには、https通信が行えるweb環境が必要になります。 アクセストークン取得後、SDKでデータを取得することができます。 　NeApiClient client = new NeApiClient([上記で取得したaccessToken], [上記で取得したrefreshToken]); アクセストークンは有効期限があるため、注意が必要になります。 詳しくはFAQをご参照ください。 　ネクストエンジンAPIはバッチ（コマンドライン）での利用は可能ですか？ 　[https://developer.next-engine.com/faq](https://developer.next-engine.com/faq) --- # 伝票番号を指定して更新する方法について URL: https://developer.next-engine.com/questions/434/ **投稿者:** nextec　**日時:** 2017/03/22 **カテゴリ:** ネクストエンジンAPIについて 汎用ECサイトの利用です。 ステータスなどの更新機能をAPIから利用する場合、伝票番号を指定して更新する方法がありますか？ --- ## 回答 (2件) ### nextec（質問者） — 2017/03/22 このコメントは削除しました ### hamee_sys — 2017/03/24 受注伝票更新APIを使用して更新することが出来ます。 入力パラメータのreceive_order_idに伝票番号を指定します。 一部更新できない項目や受注状態等によって更新できない場合があります。 詳しくはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update#up...](https://developer.next-engine.com/api/api_v1_receiveorder_base/update#update) また、受注状態ステータスを出荷確定にする場合は出荷確定処理API、配送情報ステータスを出力済みにする場合は配送情報出力済みAPIをご利用ください。 詳しくはこちらをご覧ください。 [出荷確定処理API] [https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped](https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped) [配送情報出力済みAPI] [https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted](https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted) --- # 汎用ECサイトの注文番号とネクストエンジンの伝票番号を紐付けについて URL: https://developer.next-engine.com/questions/435/ **投稿者:** nextec　**日時:** 2017/03/22 **カテゴリ:** ネクストエンジンAPIについて 汎用ECサイトの注文番号とネクストエンジンの伝票番号を紐付けする方法はありますでしょうか？ 汎用ECサイトの注文番号で検索や更新を行うことは可能でしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/03/24 受注伝票検索画面の伝票番号がNext-Engine内で受注伝票を管理する番号、受注番号でモールやカートシステムで採番される注文番号を管理します。この伝票番号と受注番号で紐付けすることになります。 ネクストエンジンの受注伝票の各項目についてはこちらをご覧ください。 [http://manual.ec-doc.net/jyuchu-denpyo/](http://manual.ec-doc.net/jyuchu-denpyo/) --- # 発送番号の取得について URL: https://developer.next-engine.com/questions/436/ **投稿者:** nextec　**日時:** 2017/03/22 **カテゴリ:** ネクストエンジンAPIについて APIの「検索」機能を使えば、日付と状態などで絞り込むことにより発送番号（配送会社の伝票番号）を取得することができますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/03/24 はい、受注伝票検索API利用すれば取得することが出来ます。 receive_order_delivery_cut_form_idが配送先の伝票番号になります。 受注伝票検索APIについてこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) --- # access_token取得時のレスポンスに有効期限切れ日時の値は含まれていますか？ URL: https://developer.next-engine.com/questions/462/ **投稿者:** suehiro　**日時:** 2017/03/24 **カテゴリ:** ネクストエンジンAPIについて 「access_token取得時」APIリファレンスの出力パラメータをみると、有効期限切れ日時は記載されておりません。 実際は値はあるのでしょうか？ 無い場合は、なぜ無いのでしょうか？ [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) 初回にアクセストークン取得時には、有効期限切れ日時は知り得無い？ 他の検索系のエンドポイントだと含まれています。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/count](https://developer.next-engine.com/api/api_v1_receiveorder_base/count) --- ## 回答 (1件) ### hamee_sys — 2017/03/27 確認したところ「NEログインaccess_token取得」では 有効期限切れ日時は含まれていませんでした。 実際の仕様とリファレンスは一致しているのですが [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) 含まれていないのは意図していない挙動ですので、 改修したいと思います。 取り急ぎは検索など他のAPI実行時に含まれる有効期限切れ日時を 参照いただければと思います。 --- # 商品マスタアップロード 時のエラーについて URL: https://developer.next-engine.com/questions/465/ **投稿者:** toshi　**日時:** 2017/03/30 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 商品マスタアップロード 時のエラーについてお聞きしたい点がございます。 以下ののようなコードにて在庫数をアップデートするプログラムを走らせていましたが エラーが出るようになってしました。 エラーコード:006005 エラーメッセージ:内部エラー（原因不明）が発生しました。お手数ですがサポートまでご連絡下さい。 $query = array(); $query['data'] = gzencode($csv, 9) ; $query['data_type'] = 'gz' ; $query['wait_flag'] = '1'; $data = $this->neapiclient->apiExecute('/api_v1_master_goods/upload', $query); csvはShiftJISで以下ののような形式になっております。 "syohin_code","zaiko_su","nyusyukko_riyu" "3232","2","" エラーの原因等なに考えられますでしょうか? 以前までは問題なく動作しておりました。 よろしくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2017/03/30 本日14:00頃にリリースを行ったメイン機能の修正によりAPIの一部の処理でエラーが発生しておりました。 今回のエラーの原因は上記によるものと思われます。ご迷惑をおかけして申し訳ありません。 15:40頃に復旧しておりますので再度問題が起こっていないかご確認いただけますでしょうか。 --- # 汎用での在庫連携で設定する在庫更新用URLについて URL: https://developer.next-engine.com/questions/466/ **投稿者:** nextec　**日時:** 2017/04/02 **カテゴリ:** ネクストエンジンAPIについて 汎用で店舗情報を新規登録する場合、在庫更新用URLの項目について 特定の名称を使用しなければならないと言ったルールがあればお教え下さい。 例えば以下の「UpdateStock.php」等、決まったファイル名にする必要がありますか？ http://ストア様ドメイン名/UpdateStock.php また、php以外にjspでも問題はないでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/04/04 ファイル名や拡張子、使用言語に特に指定はございません。 また、コーディングに関する注意点についてはこちらをご覧ください。 [https://developer.next-engine.com/api/secure](https://developer.next-engine.com/api/secure) ネクストエンジンマニュアルに在庫連携APIの仕様書がありますので こちらもご参照いただければと思います。 [http://manual.ec-doc.net/startup/hanyo/](http://manual.ec-doc.net/startup/hanyo/) 「設定に関する資料はこちらからダウンロードしてください」からダウンロードお願いします。 --- # 「情報取得」系のAPIエンドポイントでは、レスポンスに「access_tokenの有効期限切れ日時」は含まないのでしょうか？ URL: https://developer.next-engine.com/questions/467/ **投稿者:** suehiro　**日時:** 2017/04/07 **カテゴリ:** ネクストエンジンAPIについて 例えば下記のエンドポイントには、出力パラメータに「access_tokenの有効期限切れ日時」が記載されておりません。 [https://developer.next-engine.com/api/api_v1_login_user/info](https://developer.next-engine.com/api/api_v1_login_user/info) 出力パラメータに「access_tokenの有効期限切れ日時」が含まれるものと含まれないものがあるようでしたら、教えていただきたいです。 こちらも記載がなかったです。 [https://developer.next-engine.com/api/api_v1_receiveorder_confirm/update](https://developer.next-engine.com/api/api_v1_receiveorder_confirm/update) --- ## 回答 (1件) ### hamee_sys — 2017/04/07 「情報取得」系のAPIですがリファレンスには記載されてはおりませんが実際には「access_tokenの有効期限切れ日時」は含まれます。 リファレンスの記載漏れになります。ご不便おかけし申し訳ございません。 但し、「access_token取得」用のAPIは「access_tokenの有効期限切れ日時」は含まれておりません。 現在「access_tokenの有効期限切れ日時」を含むように改修を検討しております。 --- # アプリの連携に失敗しました。 URL: https://developer.next-engine.com/questions/468/ **投稿者:** 高恩歌　**日時:** 2017/04/11 **カテゴリ:** ネクストエンジンAPIについて ご担当様 お世話になっております。Risukai株式会社のやんです。 こちらは「メイン機能」からNext-engineのREST APIでレコードを取得するアプリケーションを 作成しようとしています。 マニュアルに従って、「アプリを作る」から「メイン機能」連携用のアプリを作って、 そこからclient_id, client_secretを取って、一応「メイン機能（Test）」にあった テスト用レコードを正常に取得できています。★★ ただし、本番「メイン機能」からレコードを取得するには、 審査済みのアプリで生成されたclient_idとclient_secretを使う必要となります。 実際、審査済み、販売中のアプリからclient_idとclient_secretを 取って、上記のテストプログラムを動かそうとしたところ、 「アプリの連携に失敗しました。指定したアプリが見つかりませんでした。」 というエラーメッセージが表示されています。 （添付画像をご参照ください。） Next-engineのAPI資料とエラー一覧表を見ましたが、該当情報が見当たらなかったため、 まだ解決に至っていません。 恐れ入りますが、ご確認のほど、よろしくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2017/04/13 本件エラーメッセーおよび画面キャプチャを見ると、本番アプリの利用権限が付与されていないと思われます。 設定 > アプリ > 利用ユーザー設定にてAPIを利用するユーザーに利用許可をしていただいた上で再度ご確認をお願い致します。 ### aac3 — 2018/05/17 設定 > アプリ > 利用ユーザー設定にてAPIを利用するユーザーに利用許可をしましたが、本番用のアイコンが下に出て来ません。 「TEST」が取れたアイコンが追加されるのでしょうか？？ ### hamee_sys — 2018/05/18 [https://developer.next-engine.com/questions/468](https://developer.next-engine.com/questions/468) アプリの審査は申請されましたでしょうか？ 審査に通り次第、本番用のアプリのアイコンが表示されます。 --- # FiddleによるAPI呼び出しについて URL: https://developer.next-engine.com/questions/469/ **投稿者:** 佐藤　一志　**日時:** 2017/04/12 **カテゴリ:** ネクストエンジンAPIについて 現在C#でネクストエンジンAPIを利用するアプリ作成のため、API呼び出しについて事前検証を行っています。 とりあえず挙動を確認したいと思い、Fiddlerを用いて、クライアントID・クライアントシークレットのみで動作する「アプリ利用企業一覧」のAPIを呼び出そうとしていますが、「code=015001：message=POSTパラメータにclient_idが指定されていません。」となります。 urlパラメータ・メッセージヘッダ・メッセージボディのいずれに設定しても同じ結果です。 何か他に必要事項等があれば、ご教示頂ければと思います。 参考までにRawデータを添付しておきます。 POST [https://api.next-engine.org/api_app/company?client_id=********&client_se...](https://api.next-engine.org/api_app/company?client_id=********&client_secret=########) HTTP/1.1 User-Agent: Fiddler Host: api.next-engine.org Content-Length: 101 client_id: ******** client_secret: ######## {"client_id":"********","client_secret":"########"} --- ## 回答 (1件) ### hamee_sys — 2017/04/13 HTTPメソッドのPOSTで送るリクエストボディの値はJSON形式では受け付けておりません。 レスポンスはJSONで返されます。 また、クライアント環境によってはContentTypeの指定が必要になります。 Content-Type: application/x-www-form-urlencoded URLエンコードした値として送信する必要があります。 --- # APIにより出品失敗について URL: https://developer.next-engine.com/questions/470/ **投稿者:** エリー　ティン　**日時:** 2017/04/18 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 LISUTO株式会社のEllieと申します。 先日新しいNext Engineアカウントを作成をして、 弊社システムLISUTO!でNext Engine の本番環境のAPIと連結をして、 ログインID/PW/API IDなども入力間違いないよういに確認してました。 何回かテスト出品をしたが、いつも以下のエラーで出品失敗になります。 "{\"message\":\"line:64. message:Not sign in to the next engine.\"}" 0300013100 貴社の担当の方よりアプリを作る方法からを教えて頂きまして、 しかしこの問題に起こす理由が見つからないので、連絡いたしました。 メイン機能にアクセスしたいので、直す方法を教えて頂けますでしょうか。 note: 「テスト環境」のAPIでしたら、いつも出品成功です。 弊社ロボットが見える画像も添付いたします。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/04/19 本番環境でのアプリの利用権限の問題の可能性がございます。 設定 > アプリ > 利用ユーザー設定にてAPIを利用するユーザーに利用許可をしていただいた上で再度ご確認をお願い致します。 利用権限に問題なくまだエラーが発生しているようでしたらお手数ですが、サポートセンターまでお問合せを頂ければと思います。 --- # 受注更新系処理の「受注取込中のため、更新出来ません。」のエラーについて URL: https://developer.next-engine.com/questions/471/ **投稿者:** suehiro　**日時:** 2017/04/24 **カテゴリ:** ネクストエンジンAPIについて 「受注取込中のため、更新出来ません。」のエラーは、具体的にどのような場合に発生しますでしょうか？ 更新しようとしている伝票以外でも、受注一括登録処理をしていると発生しますでしょうか？ また、「受注取込中」の状態はどれくらいの時間になりますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/05/01 >「受注取込中のため、更新出来ません。」のエラーは、具体的にどのような場合に発生しますでしょうか？ エラーが発生する条件は以下のパターンがあります。
・メイン機能本体[受注一括登録]実行中に各更新系のapi(受注伝票更新・納品書印刷済み・出荷確定処理・配送情報出力済み)を実行
・一括登録api実行中に各更新系のapiを実行
・メイン機能本体での受注取込(注：CSVおよびメイン機能本体でのAPI連携）、受注伝票有効化、集計照会中に各更新系のapiを実行 >更新しようとしている伝票以外でも、受注一括登録処理をしていると発生しますでしょうか？ 一括更新系（受注取込(注：CSVおよびメイン機能本体でのAPI連携）・受注伝票有効化・集計照会中）の処理中であれば更新対象でない伝票でもエラーが発生します。 >また、「受注取込中」の状態はどれくらいの時間になりますでしょうか？ 取込処理が完了まで続きます。取込処理が完了次第解放されます。 --- # Javaバッチによる受注データ取り込みにつきまして URL: https://developer.next-engine.com/questions/472/ **投稿者:** cam　**日時:** 2017/04/24 **カテゴリ:** 開発環境・SDKについて NE担当様 大変お世話になります。camと申します。 [https://developer.next-engine.com/sdk](https://developer.next-engine.com/sdk) SDKについてのJAVA SDKマニュアルを参考に Javaの受注データ取り込みのバッチ処理を作成しております。 ■ 質問１ > NeApiClient > インスタンス生成時にSDKの必須パラメータを指定します。バッチ（非同期）ではない場合は、必ずredirect_uriも指定して下さい 「バッチではない場合、redirect_uriも指定」とあるのですが redirect_uriを指定しない場合のNeApiClientの生成方法があるのでしょうか。 どうしても見つけることができません。。 ■ 質問２ > バッチ処理をする場合は、access_token及びrefresh_tokenのみ指定し、最後に認証した時の値を指定して下さい。詳細はSDKのソースを参照下さい uidを取得してaccess_tokenの取得となると思うのですが どのように記述するのかわかりません。サンプルなどはありますでしょうか。 ```java NeApiClient client = new NeApiClient(req, resp, clientId, clientSecret, redirectUri); HashMap map = client.neLogin(); String uid = (String)map.get("uid"); // --> NullPointerException ``` --- ## 回答 (4件) ### hamee_sys — 2017/04/26 回答いたします。 ■回答1 バッチでAPIを利用するには、利用されているアプリから予めアクセストークンとリフレッシュトークンを取得する必要があります。アプリ経由で取得したアクセストークンとリフレッシュトークンをDBなどに保存しバッチ実行時に保存したアクセストークンとリフレッシュトークン利用してAPIを実行してください。 アクセストークンは有効期限があるため、注意が必要になります 詳しくはFAQをご参照ください。 　ネクストエンジンAPIはバッチ（コマンドライン）での利用は可能ですか？ 　[https://developer.next-engine.com/faq](https://developer.next-engine.com/faq) アクセストークンとリフレッシュトークン取得後は以下のようなコードでインスタンスを生成することが出来ます。 NeApiClient client = new NeApiClient(accessToken, refreshToken); ■ 回答２ 各APIのレスポンス値に最新のアクセストークンとリフレッシュトークンが取得できます。 APIリファレンスをご覧ください。 参考ページ:[https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search](https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search) 出力パラメータ[access_token][refresh_token]より取得できます。 ### cam（質問者） — 2017/04/27 NE担当様 ご回答ありがとうございます。 > ■回答1 > 予めアクセストークンとリフレッシュトークンを取得する アクセストークン取得用に画面作成するものでしょうか。 もしくは "アプリ経由で取得"とは、管理画面から行えるものでしょうか。 >■ 回答２ >各APIのレスポンス値に最新のアクセストークンとリフレッシュトークンが取得できます。 了解しました。ありがとうございます。 ### hamee_sys — 2017/04/27 >アクセストークン取得用に画面作成するものでしょうか。 >もしくは "アプリ経由で取得"とは、管理画面から行えるものでしょうか。 はい、取得用に画面を作成する事になります。 uid・state取得APIでredirect_uriに作成した画面のuriを設定してリダイレクト先のGETパラメータでuid,stateを取得します。 　uid・state取得APIの利用方法はこちら [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) 取得したuid,stateを利用してaccess_token取得APIでアクセストークンを取得します。 　access_token取得APIの利用方法はこちら　[https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) ### cam（質問者） — 2017/04/27 ご回答ありがとうございます。 > 取得用に画面を作成する 了解しました。 --- # 検索APIのレスポンス時間につきまして URL: https://developer.next-engine.com/questions/473/ **投稿者:** cam　**日時:** 2017/04/27 **カテゴリ:** ネクストエンジンAPIについて NE担当様 大変お世話になります。camと申します。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) > 検索速度について > 入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります > 検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい > 大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します /api_v1_receiveorder_base/search のAPIの検証を行うとレスポンスが返ってきません。(4/27 10:30 頃実施しました) ・対象テストデータは 2件 ・fields <- 「全項目」 ・wait_flag <- 「1:メイン機能過負荷でも可能な限りエラーにせず実行」 下記のような情報を確認する方法はありますでしょうか。 ・現在の負荷状況 ・時間帯毎のおおよそのレスポンス時間 定期的に取得するバッチを検討しており 処理が時間内に終わるかを検証しております。 以上、どうぞよろしくお願いいたします。 --- ## 回答 (3件) ### cam（質問者） — 2017/04/28 NE担当様 大変お世話になります。camと申します。 すみません、補足です。 メイン機能（テスト環境）で実行しております。 wait_flag を1以外で実行しますと下記が返ってきます。 003002 : 現在メイン機能サーバーが混み合っておりますので、再度時間を置いてからアクセスして下さい。 本番及びテスト環境で下記のような情報を確認する方法はありますでしょうか。 ・現在の負荷状況 ・時間帯毎のおおよそのレスポンス時間 -- 追記 -- 本日(4/28 11:00 )は メイン機能（テスト環境）接続できるようになりました。 ### hamee_sys — 2017/04/28 昨日、メイン機能の検証用環境（sandbox01.next-engine.com）が高負荷のため応答が遅くなっておりました。 現在は高負荷になる問題は現在解消しております。 大変ご不便をおかけし申し訳ございませんでした。 >・現在の負荷状況 >・時間帯毎のおおよそのレスポンス時間 こちらの件ですが申し訳ございませんが確認する方法はございません。 ### cam（質問者） — 2017/04/28 > 昨日、メイン機能の検証用環境（sandbox01.next-engine.com）が高負荷のため応答が遅くなっておりました。 > 現在は高負荷になる問題は現在解消しております。 ご対応ありがとうございます。 > こちらの件ですが申し訳ございませんが確認する方法はございません。 承知いたしました。 --- # 受注状態区分につきまして URL: https://developer.next-engine.com/questions/474/ **投稿者:** cam　**日時:** 2017/05/08 **カテゴリ:** ネクストエンジンAPIについて NE担当様 大変お世話になります。camと申します。 受注状態区分につきまして 下記、APIで取得できる区分のid及び名称はプログラムで固定値でしょうか。 /api_v1_system_orderstatus/info [https://developer.next-engine.com/api/api_v1_system_orderstatus/info](https://developer.next-engine.com/api/api_v1_system_orderstatus/info) data : [ {order_status_id=0, order_status_name=取込情報不足}, {order_status_id=1, order_status_name=受注メール取込済}, {order_status_id=2, order_status_name=起票済(CSV/手入力)}, {order_status_id=20, order_status_name=納品書印刷待ち}, {order_status_id=30, order_status_name=納品書印刷中}, {order_status_id=40, order_status_name=納品書印刷済}, {order_status_id=50, order_status_name=出荷確定済（完了）} ] 管理画面等でカスタマイズできるものなのでしょうか。 使い方マニュアル 受注伝票の画面 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/) 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/05/11 受注状態区分のidと名称は固定値になります。 管理画面などでのカスタマイズは不可となります。 ### cam（質問者） — 2017/05/11 ご回答ありがとうございます。承知しました。 --- # 受注APIドキュメントなど URL: https://developer.next-engine.com/questions/475/ **投稿者:** 小池 徳生　**日時:** 2017/05/09 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 マークシティー小池です。 現在弊社で取り扱っているDecoNetworkとのAPI連携で 受注API連携を開発しているのですが開発が海外の方にお願いするので APIドキュメントの英語バージョンをお願いしたいのですがよろしいでしょうか お手数お掛けしますが宜しくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2017/05/12 APIドキュメントの英語バージョンですが、申し訳ございませんがご用意する事ができません。 今後、公式での提供予定もありませんので、ブラウザ翻訳機能などを駆使して頂き、対応していただけると幸いです。 --- # 受注伝票検索結果の並び順につきまして URL: https://developer.next-engine.com/questions/476/ **投稿者:** cam　**日時:** 2017/05/10 **カテゴリ:** ネクストエンジンAPIについて NE担当様 大変お世話になります。camと申します。 受注伝票検索の並び順につきまして [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) receive_order_id-in "1, 2, 3 ..." と渡した場合に data"検索結果の連想配列(JSONのオブジェクト型)"は 渡した検索キー順で並んでおりますでしょうか。 また、並び順を指定することはできますでしょうか。 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/05/12 受注伝票検索の並び順ですが、現状キーで並び替えてはおらず伝票の作成順にレスポンスされます。 また、並び順の指定は出来ないので並び替えを行うにはアプリ側で処理を行う必要があります。 ### cam（質問者） — 2017/05/12 >伝票の作成順 承知しました。レスポンスをアプリ側加工しで対応しようと思います。 ご回答ありがとうございました。 --- # 受注伝票受注伝票の大量一括API更新につきまして URL: https://developer.next-engine.com/questions/477/ **投稿者:** cam　**日時:** 2017/05/10 **カテゴリ:** ネクストエンジンAPIについて NE担当様 大変お世話になります。camと申します。 たびたびの質問すみません。 受注伝票受注伝票更新につきまして /api_v1_receiveorder_base/update 受注伝票受注伝票更新をバッチで 10分毎に 1,000商品ほど更新したいです。 1回の呼び出しで複数受注伝票の更新をする方法はないでしょうか。 以上、どうぞよろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/05/12 受注伝票更新ですが、1回の呼び出しで1伝票の更新までとなっております。 更新する際は、1伝票毎に受注伝票更新apiを呼び出して処理を行うようにお願い致します。 ### cam（質問者） — 2017/05/12 ご回答ありがとうございます。承知しました。 --- # API利用料について URL: https://developer.next-engine.com/questions/478/ **投稿者:** うなぎ　**日時:** 2017/05/12 **カテゴリ:** ネクストエンジンAPIについて はじめまして。 「特定の企業に公開」のアプリを２つ作った場合、 (A) API利用料は２つ分必要になりますか？ (B) ２つのアプリのAPI呼び出し回数の合計により計算されますか？ --- ## 回答 (1件) ### hamee_sys — 2017/05/12 ＞(A) APIのご利用料金はアプリごとに計算しているので、 アプリが2つあれば2つ分のご利用料金を頂戴することとなります。 ＞(B) 恐れ入りますが、それぞれのアプリごとにご利用料金を算出するため、 合計はいたしません。 例えば、APIリクエスト回数が4000回のアプリが2つなら10000円 * 2となります。 特定企業にのみ公開アプリ料金表 [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) --- # アプリの公開範囲の変更 URL: https://developer.next-engine.com/questions/479/ **投稿者:** 八つ橋　**日時:** 2017/05/12 **カテゴリ:** その他 非公開アプリ（特定企業アプリ）を、後から公開に変えられますでしょうか？ また、変更できるのであれば、非公開⇒公開に変更する場合の条件は何かありますか？ --- ## 回答 (1件) ### goromaru — 2017/05/12 知見があるので、回答したいと思います。 アプリを作成するときの「販売形態選択」フォームの説明に書いてあるとおり、販売形態は初回登録時のみ選択できます。 非公開から公開に変更する場合はまた新しいアプリを作成して, 申請をだすと良いと思います。 --- # 接続先メイン機能の選択について教えてください URL: https://developer.next-engine.com/questions/480/ **投稿者:** 岩さん　**日時:** 2017/05/12 **カテゴリ:** その他 アプリ作成で「特定企業に公開」を選択すると、接続先メイン機能が選べるようになりますが、自社の他にゲスト招待していればその企業の接続先メイン機能も表示されますか？ それとも、アプリを作成した企業しか表示されないのでしょうか？ --- ## 回答 (1件) ### たけやま — 2017/05/12 貴社の他にゲスト招待をされていれば、その企業の接続先メイン機能も表示されると思います。 --- # 「自社サービスアプリ」の時のAPIタブについて URL: https://developer.next-engine.com/questions/481/ **投稿者:** 桑マン　**日時:** 2017/05/12 **カテゴリ:** その他 「自社サービスのアプリ」の場合、アプリを作る＞編集のAPIタブが表示されないのですが、APIタブを表示させることはできますでしょうか？ --- ## 回答 (1件) ### たけやま — 2017/05/12 「自社サービスのアプリ」はAPIタブが表示されないので、それ以外の「メイン機能と連携するアプリ」、「ネクストエンジンログインのみのアプリ」を選択すると良いと思います。 アプリの種別はアプリ作成後に変更できません。 マニュアルも貼っておきます。 [http://manual.next-e.jp/screen/make/new/tabb1/](http://manual.next-e.jp/screen/make/new/tabb1/) --- # メイン機能のテスト環境が表示されない URL: https://developer.next-engine.com/questions/482/ **投稿者:** ぱたぱた　**日時:** 2017/05/12 **カテゴリ:** 開発環境・SDKについて 役割が一般(開発者, アプリのみ)のユーザーでログインしています。 「メイン機能（テスト環境）の利用が許可されました」というお知らせが出ているのですが メイン機能（テスト環境）が選択できません。（アイコン表示がされない） メイン機能（テスト）の利用は許可されています。 要因として考えられることってなんでしょうか？ --- ## 回答 (1件) ### たけやま — 2017/05/12 コメントさせていただきます。 該当ユーザーの役割が「アプリのみ利用」のユーザーはメイン機能へのアクセスが制限されます。 上記の可能性が考えられますので、一度、確認してみるといいかもしれません。 【設定】＞「メンバー」タブ＞(該当のユーザー)編集 から 「アプリのみ利用」のチェックを外していただけるとアクセスできるようになると思いますよ。 --- # バッチ処理による定期受注伝票取得につきまして URL: https://developer.next-engine.com/questions/483/ **投稿者:** cam　**日時:** 2017/05/16 **カテゴリ:** ネクストエンジンAPIについて 大変お世話になります。camです。 受注伝票検索APIを使用して定期的にバッチで受注データを取得をしています。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) 前回APIで取得したデータを除き取得する方法はありますでしょうか。 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/05/19 取得した伝票に対して「受注分類タグ：receive_order_gruoping_tag」を更新して利用する方法をご提案いたします。 １）受注伝票検索で伝票を取得（２で付与したタグの除外を条件にする） ２）受注伝票更新で取得できた受注に受注分類タグを追加 ３）１に戻る 受注分類タグには任意のタグを追加可能ですので、例えば [受注伝票取得済み] といったタグを取得済みの受注伝票に対して受注伝票更新APIを通じて付与し、取得条件からはそのタグが付いているものを除外するという方法をとれば実現可能です。 こちらでご検討いただけますでしょうか。 ### cam（質問者） — 2017/05/23 > 受注分類タグ ご提案ありがとうございます。お返事遅れて申し訳ありません。 この方式で検討いたします。 --- # access_token情報の更新はどのようなAPIを呼べばいいのか？ URL: https://developer.next-engine.com/questions/492/ **投稿者:** 八つ橋　**日時:** 2017/05/19 **カテゴリ:** ネクストエンジンAPIについて APIの仕様によるとaccess_tokenの有効期限は1日となっているので、サイトから受注データがなくても24ｈ以内にアクセスする事を考えていますが、どのようなAPIを呼べばaccess_tokenの有効期限がリセットされますか？ --- ## 回答 (2件) ### パックマン — 2017/05/19 はじめまして。 パックマンと申します。 自分が知っていることをコメントしたいと思います。 いずれかのエンドポイントにリクエストしてただければ、access_tokenがリセットされます。 リファレンスにも記載のあるとおり、リフレッシュトークンを使えば アクセストークンの期限切れ後に新しいトークンが取得可能です。 [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) ### 八つ橋（質問者） — 2017/05/19 パックマンさん コメントありがとうございます。 改めて、リファレンスを確認したいと思います。 --- # トークン更新時の値に関しての質問 URL: https://developer.next-engine.com/questions/493/ **投稿者:** ★富士山★　**日時:** 2017/05/19 **カテゴリ:** ネクストエンジンAPIについて access_token値は、継続されますか？ また、最初の採番から24h後に必ずリセットされますか？ --- ## 回答 (2件) ### たけやま — 2017/05/19 >access_token値は、継続されますか？ 24h以内はトークン値は継続されますが、有効期限を過ぎ更新されるとトークン値も更新されます。 アクセストークンは発行から24h後に利用できなくなります。 ただし、24h後の最初のリクエストにアクセストークンとリフレッシュトークンを渡して いただければ新しいアクセストークンとリフレッシュトークンが取得できます。 リフレッシュトークンにも72hという期限がありますのでご注意ください。 ### ★富士山★（質問者） — 2017/05/19 なるほど。 トークン値も更新されるのですね。 コメントありがとうございました。 --- # APIエラーコード002002はどのような場合に返却されますか？ URL: https://developer.next-engine.com/questions/494/ **投稿者:** goromaru　**日時:** 2017/05/19 **カテゴリ:** ネクストエンジンAPIについて こんにちわ。 弊社サービス経由での御社APIへのアクセスについて、アクセストークンが有効期限切れ / リフレッシュトークンが有効期限内のときに、両トークンを指定してアクセスを行った時に、 { "result": "error", "code": "002002", "message": “access_token[xxxxx…xxxx]が不正です。" } が返ってくる場合があるのですが、これはどういう時に起きうる挙動でしょうか。 対策のために原因等ご教示頂けましたら幸いです。 --- ## 回答 (2件) ### たけやま — 2017/05/19 知見があるので、コメントします。 >これはどういう時に起きうる挙動でしょうか。 アクセストークン情報が更新されたのにもかかわらず、古いアクセストークン情報でリクエストしているときにこちらのエラーが返却される場合があります。 リクエストごとにアプリ側でもトークン情報を保存して、常に新しいトークン情報を保持して頂くことで対応できると思います。 ### goromaru（質問者） — 2017/05/19 ご教授ありがとうございます！ --- # 504 GATEWAY_TIMEOUT エラーの原因について URL: https://developer.next-engine.com/questions/50/ **投稿者:** 松尾　**日時:** 2017/02/03 **カテゴリ:** ネクストエンジンAPIについて 2017-02-02 15:24:07にネクストエンジンAPIが次のエラーを返しました。 exception 'Exception_Fatal' with message 'exception 'Exception' with message システムエラーが発生しました(curlの実行に失敗[The requested URL returned error: 504 GATEWAY_TIMEOUT])。 これってどんなときに起こるのでしょうか？サーバーのが重いとき？ --- ## 回答 (1件) ### hamee_sys — 2017/02/06 504 GATEWAY_TIMEOUTの原因は複数考えられるため断定はできませんが、アプリからAPIへの接続がタイムアウトにより切れた可能性があります。 タイムアウトの要因も単純に処理に時間がかかりタイムアウトとなった、お客様がアプリを動作させているサーバー環境のタイムアウトの設定がAPIサーバーのタイムアウトの設定よりも短かったなどが考えられます。 APIサーバーやネクストエンジンメイン機能が高負荷により一時的にレスポンスが遅くなっている場合もありますので、時間をおいてアクセスしていただくと解決することもあるかと思います。 継続してタイムアウトが発生する場合はお手数ですが再度お問い合わせをお願いいたします。 --- # nextengine側の在庫数の取り扱いについて URL: https://developer.next-engine.com/questions/501/ **投稿者:** yaoqingmei　**日時:** 2017/05/25 **カテゴリ:** ネクストエンジンAPIについて nextengine側の在庫数の取り扱いについて ある商品が 在庫10個 受注0個 の状態から受注3個を受け取った場合 在庫10個 受注3個 となり、EC在庫は7個となりますが 自社が作成したアプリから在庫連携すべき数値は 10個oｒ7個のどちらになりますか？ --- ## 回答 (1件) ### hamee_sys — 2017/05/29 アプリで在庫連携を行う場合は7個が正しいです。 在庫更新を行うには商品マスタアップロードAPIで行います。 APIの使い方についてはこちらをご覧ください。 　　[https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) 在庫の更新は、在庫数ではなく在庫数の加算/減算値を設定します。 10→7に減らす場合は -3 を設定します。設定についてはこちらの"zaiko_su"欄をご覧ください。　 　[http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) なお、ご参考までにネクストエンジン本体で在庫連携を行う場合はこちらをご覧ください。 [http://manual.ec-doc.net/operation/zaiko/](http://manual.ec-doc.net/operation/zaiko/) --- # 受注一括登録の汎用パターン URL: https://developer.next-engine.com/questions/504/ **投稿者:** suehiro　**日時:** 2017/05/25 **カテゴリ:** ネクストエンジンAPIについて 受注一括登録の汎用パターンにおいてCSVの文字列を指定するかと思いますが、 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) 文字コードは何に対応しておりますでしょうか？ --- ## 回答 (5件) ### hamee_sys — 2017/05/29 対応する文字コードはShift_JIS(SJIS)のみになります。 ### suehiro（質問者） — 2017/05/29 UTF-8やEUC-JPで画面からアップロードすると正常に処理されるように見受けられますが、APIでは対応していないということでしょうか？ ### hamee_sys — 2017/06/02 申し訳ございません。 再度確認したところ、Shift_JIS(SJIS)の他にUTF-8とEUC-JPに対応しておりました。 メイン機能の画面からのアップロード、APIからのアップロードどちらも対応しております。 ### inouema — 2018/11/15 MS932（SJIS＋機種依存文字）にも対応していると考えて良いでしょうか？ また、APIリファレンスでは、未だに、 要SJIS と記載されているままで、UTF-8、EUC-J についての記載が無いようです、改訂されないのでしょうか？ ### hamee_sys — 2018/11/21 ご指摘をいただき、まことに恐縮でございます。 ＞MS932（SJIS＋機種依存文字）にも対応していると考えて良いでしょうか？ 申し訳ございません。現在はShift_JISまたはUTF-8のみ推奨させていただいております。 機種依存文字やそのほかの文字コード群につきましては、仮にアップロードができましても、非推奨という立場でございます。 混乱をおかけしましたこと、誠にお詫び申し上げます。 下記の通り、記載を変更いたしました。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) 何卒よろしくお願いいたします。 --- # エラーコード: 002006がレスポンスとして返ってきた時の対応に関して URL: https://developer.next-engine.com/questions/505/ **投稿者:** うなぎ　**日時:** 2017/05/25 **カテゴリ:** ネクストエンジンAPIについて access_tokenとrefresh_tokenについての質問があります。 処理自体はエラーで返ってきていて、エラーコード002006です。 原因はわかるのですが、対応方法を知りたいです。 --- ## 回答 (2件) ### たけやま — 2017/05/25 エラーコードからアクセス元ホストとネクストエンジンで指定したredirect_uriが一致していないそうです。 [https://developer.next-engine.com/api/param/message](https://developer.next-engine.com/api/param/message) アクセス元のホスト名がRedirectURIと異なっていることが原因と考えられます. アプリを作る>該当アプリ「編集」を押下>APIタブのRedirectURIを アクセス元のホスト名と同じに設定すると、このエラーは解消されますよ. ### うなぎ（質問者） — 2017/05/25 試してみます コメントありがとうございます --- # API の接続タイプを教えてください URL: https://developer.next-engine.com/questions/506/ **投稿者:** 八つ橋　**日時:** 2017/05/25 **カテゴリ:** ネクストエンジンAPIについて API の接続タイプを教えてください --- ## 回答 (2件) ### たけやま — 2017/05/25 接続プロトコルとか（httpとかsとか）の事ですかね？ もしそうだとしたら証明書が必要ななるため、プロトコルはhttpsでの接続です。 ・[http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd](http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd) ・[http://api.next-e.jp/sample-fuelphp/](http://api.next-e.jp/sample-fuelphp/) 辺りに最低限のAPIを叩く環境を叩く為の環境構築例がありますので、そこを良く見てもらえれば理解できると思います。 ### 八つ橋（質問者） — 2017/05/25 >接続プロトコルとか（httpとかsとか）の事ですかね？ そうです！ ありがとうございます。 参考文献見てみます。 --- # API料金についての質問 URL: https://developer.next-engine.com/questions/507/ **投稿者:** 岩さん　**日時:** 2017/05/25 **カテゴリ:** ネクストエンジンAPIについて テスト環境でのAPI呼び出しは課金されますか？ --- ## 回答 (2件) ### たけやま — 2017/05/25 テスト環境では課金されません. 審査通過後、本番環境での運用になった場合から課金されることになります. ### 岩さん（質問者） — 2017/05/25 なるほど。 コメントありがとうございます。 助かりました。 --- # フィールド名の一覧CSVやExcelファイルが欲しい URL: https://developer.next-engine.com/questions/51/ **投稿者:** yuuna　**日時:** 2017/02/06 **カテゴリ:** ネクストエンジンAPIについて どうでもいい要望なのですが、仕様書を作成するときに、毎回Webサイトからコピーすると field nameだけの選択ができずに毎回加工するはめになっています。 細かくupdateなどもあり、公式でファイルを用意してもらえるとすごく助かります。 よろしくお願いします。 --- ## 回答 (1件) ### hamee_sys — 2017/02/06 ご意見ありがとうございます。 現状、対応の予定はありませんが、貴重なご意見として受けとめたいと思っております。 お手数をおかけいたします。 --- # バッチ処理アプリの審査方法について URL: https://developer.next-engine.com/questions/510/ **投稿者:** rokuhira　**日時:** 2017/05/31 **カテゴリ:** その他 お世話になります。 掲題の件でお尋ねいたします。 現在、「特定の企業に公開アプリ」を開発中なのですが、このアプリがバッチ処理で実行するものである場合、 審査はどのように実施されるのでしょうか。 [http://manual.next-e.jp/how_use/make_buy/](http://manual.next-e.jp/how_use/make_buy/) 「審査の基準について」に「なお、審査にあたり審査対象のアプリケーションを操作するため、審査用のアカウントのご用意、操作方法についてご説明をお願いすることがありますのでご留意ください。」と 記載がございますが、バッチ処理の場合はアプリケーションのURLは存在しないため、ブラウザでの確認はできません。 上記を踏まえて、バッチ処理アプリの審査方法についてご教授いただけますと幸いです。 どうぞよろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/06/02 審査の内容についてはお手数ですが、弊社サポート窓口まで個別にご相談ください。 ### rokuhira（質問者） — 2017/06/02 承知いたしました。 サポート窓口にご連絡いたします。 --- # バッチ処理の多重化について URL: https://developer.next-engine.com/questions/511/ **投稿者:** 村山　大　**日時:** 2017/05/31 **カテゴリ:** その他 お世話になります。 バッチ処理の実装方式について確認いたします モールとネクストエンジンの連携アプリを作成し、主処理はバッチとして実装しています。 現在、稀にアクセストークンのエラーが発生することがあります。 リフレッシュトークンも指定しているため、トークンエラーは想定していなかったのですが、 ログを確認すると同時実行による弊害が出ていると想定されます。 ※バッチ自体はレスポンス向上のため、マルチスレッドで処理しています。 今回の様なバッチ処理を想定した場合、実装方式として処理の多重化は望ましくないのでしょうか？ 002002のエラーを無視する事も可能ですが、少し乱暴なような気がします。 何か良い実装／対処方法がありましたら、ご教示頂きたくお願い致します。 --- ## 回答 (1件) ### hamee_sys — 2017/06/02 同一ユーザーに対してマルチスレッドでAPIを利用する事は可能ではありますが、推奨しておりません。 access_token,refresh_tokenが更新されたタイミングで、同一ユーザーに対する全スレッドのaccess_token,refresh_tokenも更新された値に変更する必要があり、アプリ側のaccess_token,refresh_tokenの管理が困難になる為です。 こちらのページの補足説明もご覧ください。 [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) --- # 受注メール取り込みについて URL: https://developer.next-engine.com/questions/512/ **投稿者:** nextec　**日時:** 2017/06/01 **カテゴリ:** その他 受注取り込みメールについて質問です。 現在「汎用」でネクストエンジンとの連携を進めております。 受注取り込みメールで記載したカラムと、ネクストエンジンで起票済み後に 「受注伝票管理」の明細に入るカラムが異なりました。 クーポンによる割引やポイントが全て税金に取り込まれました。 割引を他費用に取り込むにはどのように指定すれば良いでしょうか？ 【ネクストエンジンへ送信したメール】 ------------------------------------------------------------ 商品合計：￥1000 税金：￥56 送料：￥864 手数料：￥205 その他費用：▲￥600 ポイント利用額：▲￥525　(525) ------------------------------------------------------------ 合計金額(税込)：￥1000 ------------------------------------------------------------ 【ネクストエンジンでの明細】 商品計[税抜]：1,000 税金[8%]：-1069 手数料[税込]：205 発送代[税込]：864 他費用[税込]：0 ポイント数：0 総合計：1,000 --- ## 回答 (1件) ### hamee_sys — 2017/06/05 本件はメイン機能の仕様に関するご質問になりますので、お手数ですがサポートセンターまでお問い合わせいただくようお願いいたします。 --- # 申請時のダウンロードURLについて URL: https://developer.next-engine.com/questions/514/ **投稿者:** たけし　**日時:** 2017/06/02 **カテゴリ:** その他 ドットネットで開発しています。 エグゼファイルでrest通信するのは可能でしょうか？ 可能な場合、審査時の「アプリを作る」から設定できる、アプリURLには何を入力すればよいでしょうか？ エグゼファイルのダウンロードURLを載せる形でよいでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2017/06/02 > エグゼファイルで > rest通信するのは可能でしょうか？ 可能です。 > 可能な場合、審査時の > アプリを作る　の　画面　のアプリURLには　何を、いれればよいか？ > エグゼファイルのダウンロードURLを載せる形でよいか？ ダウンロードURLでも問題ありません。 ただし、以下の注意点があります。 １）本アプリは特定企業のみアプリ（自社のみ利用）ということでよろしいでしょうか？ 　　基本的にネクストエンジンAPIはWebアプリケーションを想定しているため、公開アプリの場合、 　　アプリを購入した第3者からでも利用できるURLが必要となります。 　　※もし公開アプリの場合、サポートまでご連絡ください。 ２）自社のみのアプリでも公開アプリの場合でも弊社での審査があるため、動作を確認するための 　　環境（ソースコードまたはexeファイルのご提供など）をご用意いただく場合があります。 ご承知おきください。 ### たけし（質問者） — 2017/06/02 回答ありがとうございます。 特定企業のみアプリで開発しております。 注意点を参考に致します。 今後共よろしくお願いいたします。 --- # 接続できるメイン機能がない問題 URL: https://developer.next-engine.com/questions/515/ **投稿者:** goromaru　**日時:** 2017/06/02 **カテゴリ:** その他 ある企業（NEユーザー）に依頼され、アプリを開発しています。 プラットフォーム画面の「アプリをつくる」から審査申し込みを行いたいのですが、接続できるメイン機能がなく申し込みができません。 この場合、どうすればいいのでしょうか？ --- ## 回答 (2件) ### パックマン — 2017/06/02 はじめまして。 自分も経験があるので、コメントさせていただきます。 開発企業さんが利用企業さんのユーザを招待することでアカウントが紐付き、開発企業さんが利用企業さんのメイン機能と接続できるようになります。 ご参考になれば。 ### goromaru（質問者） — 2017/06/02 なるほど.... ありがとうございます。 大変参考になりました。 --- # サーバーメンテナンス時のレスポンス結果について URL: https://developer.next-engine.com/questions/516/ **投稿者:** 桑マン　**日時:** 2017/06/02 **カテゴリ:** ネクストエンジンAPIについて サーバーメンテナンス中に、アプリからNEのサーバーにリクエストした場合、エラーが返ってくるのでしょうか？ それともサーバーメンテが終わってから、エラーが返ってくる？ それともサーバーメンテが終わった後、いつものデータが返ってくる？ 教えてほしいです。 --- ## 回答 (2件) ### たけやま — 2017/06/02 ・サーバーメンテ中に、アプリから、NEのサーバーにリクエストがかかるとエラーが返ってくるのでしょうか？ エラーが返ってきます。 メンテナンス中にネクストエンジンＡＰＩへリクエストされた場合、 メッセージコード「003005」または「003004」が返ってきます。 以下のリファレンスにエラーコードが記述されています。 [https://developer.next-engine.com/api/param/message](https://developer.next-engine.com/api/param/message) ### 桑マン（質問者） — 2017/06/02 回答ありがとうございます！ リファレンスに書いて有りましたね。 教えて頂いたリンク見てみます。 ありがとうございました。 --- # アプリ公開の際の利用料と審査の際の注意点 URL: https://developer.next-engine.com/questions/517/ **投稿者:** 傭兵　**日時:** 2017/06/06 **カテゴリ:** その他 アプリの公開についてお教えください。 現在、自社アプリを作成して運用効率を上げようと考えております。 このように他社への販売前提ではない場合でも、 社内アプリの利用料などが必要になってくるのでしょうか? また、アプリ審査について、具体的にどのような箇所に注意すればよろしいでしょうか? 自社専用アプリなので、できればベータバージョン想定で本番環境で早く使用して、 UI などは随時バージョンアップをしていきたいと考えております。 --- ## 回答 (2件) ### たけやま — 2017/06/07 >社内アプリの利用料などが必要になってくるのでしょうか? 必要になります。 アプリ区分が「特定企業のみアプリ」となりますので、APIリクエスト量に応じた料金が発生致します。 該当マニュアルはこちらです。 [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) >また、アプリ審査について、具体的にどのような箇所に注意すればよろしいでしょうか? 以下の点を注意するようにとリファレンスに書いてあります。 ・「アプリ説明文」に対象アプリの概要やできることの記載があること ・「アプリ説明文」と実際のアプリとで動作が一致していること ・過度なアクセスや連続した高負荷処理などシステム的な連携に問題がないこと ・その他，当社が不適切と判断する事項がないこと 該当リファレンスはこちらです。 [http://manual.next-e.jp/how_use/make_buy/#inspection](http://manual.next-e.jp/how_use/make_buy/#inspection) ### 傭兵（質問者） — 2017/06/13 返信おくれました.....申し訳ありません。 丁寧に教えて頂き感謝しています！ ありがとうございます！ --- # アプリ販売形態について URL: https://developer.next-engine.com/questions/518/ **投稿者:** goromaru　**日時:** 2017/06/06 **カテゴリ:** その他 リファレンスでは確認できなかったので、教えてください。 [http://manual.next-e.jp/how_use/buy/](http://manual.next-e.jp/how_use/buy/) 1： アプリを作成して販売した場合、複数のメイン機能を保持している企業に対して、1つアプリを購入してもらえば、メイン機能の数だけ同じアプリを購入してもらわなくても済むような販売は可能でしょうか？ 2： アプリを作成して販売した場合の課金方法ですが、企業ID単位ではなく、ユーザー単位、メイン機能単位での課金も可能でしょうか？ --- ## 回答 (2件) ### 岩さん — 2017/06/07 はじめまして。岩と申します。 知っているので、参考になればと思い、コメント致します。 同じ会社でもメイン機能が複数あれば、メイン機能毎にアプリを契約・購入する必要があります。 請求の単位ですが、ユーザー単位ではなく、メイン機能単位になります。 ### goromaru（質問者） — 2017/06/13 なるほど。 アプリはメイン機能単位で、請求もメイン機能単位になるのですね。 ありがとうございます。 --- # 企業情報取得のAPIを利用した場合について質問です URL: https://developer.next-engine.com/questions/519/ **投稿者:** ぱたぱた　**日時:** 2017/06/06 **カテゴリ:** ネクストエンジンAPIについて [https://developer.next-engine.com/api/api_v1_login_company/info](https://developer.next-engine.com/api/api_v1_login_company/info) メイン機能企業ID: company_id について「アプリを起動した企業の「メイン機能単位」で一意になるID。１つの企業が複数のメイン機能を所有することがあります」とありますが、 メイン機能を複数持つ企業様がアプリを起動した際には、 ネクストエンジン側で接続先アプリを選ぶUIが表示されるかと思います。 その際の上記 企業情報取得APIの結果は、 選択済みのメイン機能企業IDのみ返却される、という理解で合っていますでしょうか。 （複数件の結果がかえるようなことはない、と考えて問題ないでしょうか）" --- ## 回答 (1件) ### パックマン — 2017/06/07 おっしゃる通りで、フィールド一覧における「メイン機能企業ID(company_id)」はアプリを作成する際に、 接続先メイン機能より選択したメイン機能企業IDが返却されます。 ＞複数件の結果がかえるようなことはない、と考えて問題ないでしょうか） 複数件の結果が返却されることはありません。 --- # 返品、在庫処理について URL: https://developer.next-engine.com/questions/520/ **投稿者:** Kenny Loo　**日時:** 2017/06/07 **カテゴリ:** ネクストエンジンAPIについて 返品の処理をAPIから利用したいですが、、方法を教えていただけませんでしょうか。 また、以下のAPIを使用したら、在庫数が自動的に更新されますか。 [https://api.next-engine.org/api_v1_receiveorder_base/upload](https://api.next-engine.org/api_v1_receiveorder_base/upload) [https://api.next-engine.org/api_v1_receiveorder_base/update](https://api.next-engine.org/api_v1_receiveorder_base/update) 以上、よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/06/08 商品マスタアップロード(/api_v1_master_goods/upload)を利用する事によりAPIより返品処理を行う事ができます。 在庫数の加算/減算値(zaiko_su)で返品数を設定し、入出庫履歴の事由(nyusyukko_riyu)に返品理由を設定します。 apiについてはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) アップロード用のcsvファイルについてはこちらをご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) --- # 審査後のメイン機能の接続先についての質問 URL: https://developer.next-engine.com/questions/521/ **投稿者:** だーやま　**日時:** 2017/06/13 **カテゴリ:** 開発環境・SDKについて 自社で新しいアプリを開発しています。 現在、NEのテスト環境に対してテスト用のアプリを接続して、開発しています。 また、別途、このアプリについて「審査」を依頼しています。 プラットフォーム画面の「アプリを作る」をクリックして、自社アプリ一覧というところから、テスト用のアプリの詳細をクリックすると、 接続先メイン機能は本番の環境となっているが、審査が通った後はどのようになりますでしょうか？ また、どのようにすればよいでしょうか？ 下記、3点について確認の上、審査後の動きについて、ご教示下さい。 ① 現在設定されている　（アプリを作る　>　API　>　本番環境設定） 本番環境用のメイン機能に自動的に接続は切り替わるのでしょうか？ ②本番メイン機能、テストメイン機能両方ともに接続されるのでしょうか？ ③それとも、テスト環境用のメイン機能に接続されたままとなり、で、 テスト環境用のクライアントIDなどを手動で削除しなくてはいけませんか？ お教えいただけましたら幸いです。 --- ## 回答 (2件) ### oseo — 2017/06/13 はじめまして。oseoと申します。 私も開発者です。 気になったので、コメント致します。 ①② プラットフォームのマニュアルの以下ページをご案内いただければと思います。 3.2.1.5. 「API」タブ [http://manual.next-e.jp/screen/make/new/tabb5/](http://manual.next-e.jp/screen/make/new/tabb5/) ③それとも、テスト環境用のメイン機能に接続されたままとなり、で、 テスト環境用のクライアントIDなどを手動で削除しなくてはいけませんか？ アプリの作りにもよるので一概には言えませんが、クライアントIDとシークレットは アプリの本番とテストそれぞれ別にありますので、 アプリ側で接続先を設定（切り替えて）していただく必要があると思います。 テスト環境用　、本番環境用のクライアントID、クライアントシークレットの確認は ・PF＞アプリを作る＞該当アプリの「詳細」ボタン「API」タブ　で確認できます。 ご参考になれば幸いです。 ### だーやま（質問者） — 2017/06/13 oseoさん コメントありがとうございます！ とてもわかり易く教えて頂き助かりました。 テスト用と本番用でクライアントID&シークレット情報を切り替えれば、実現できるのですね。 参考にさせていただきます。 --- # APIの呼び出し回数について教えてほしいです。 URL: https://developer.next-engine.com/questions/522/ **投稿者:** シャア　**日時:** 2017/06/13 **カテゴリ:** ネクストエンジンAPIについて 今、アプリを作っているのですが、 ログインに関しては、APIの呼び出し回数 としてカウントされるでしょうか？ バッチでリフレッシュトークンを取り続ける仕様にする予定なので、気になっています。 --- ## 回答 (1件) ### 岩さん — 2017/06/13 こんにちわ！私もアプリ開発者です。 ログインに関しては、APIの呼び出し回数 としてカウントされるでしょうか？ 認証エンドポイントに対するリクエストは請求対象外になります。 --- # 受注伝票更新の際のエラー URL: https://developer.next-engine.com/questions/523/ **投稿者:** ★富士山★　**日時:** 2017/06/13 **カテゴリ:** ネクストエンジンAPIについて 開発中のアプリにて伝票を更新した際、エラーが返っています。 原因はわかりますでしょうか。 リクエストURL： receive_order_id query [""offset""]=> string(1) ""0"" [""limit""]=> string(5) ""10000"" [""wait_flag""]=> string(1) ""1"" [""receive_order_id""]=> string(4) ""1152"" [""receive_order_last_modified_date""]=> string(19) ""2017-06-11 01:04:52"" curl のerror 内容： [ Couldn't resolve host 'api.next-engine.orgapi_v1_receiveorder_base ] --- ## 回答 (2件) ### たけやま — 2017/06/13 ＞ [ Couldn't resolve host 'api.next-engine.orgapi_v1_receiveorder_base ] エラーがこのままの内容で正しければ、 ※ドメインとパスがつながっている状況（ＵＲＬが正しいがご確認する必要有り）だと思います。 誤: api.next-engine.orgapi_v1_receiveorder_base 正: api.next-engine.org/api_v1_receiveorder_base ### ★富士山★（質問者） — 2017/06/13 まさか....と思ったんですが、ご指摘のとおりでした...とほほ。 助かりました。 ありがとうございます。 --- # 受注明細行の並び順について URL: https://developer.next-engine.com/questions/529/ **投稿者:** ネクストエンジン設定代行　**日時:** 2017/06/17 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 株式会社インキュービックです。 当社で開発中のアプリにおいて、 伝票分割要求時にエラーコード：016019 （有効でない受注明細行の指定があるか、受注明細行の並び順が昇順ではありません。）　 が発生しました。 ・リクエストURL /api_v1_receiveorder_base/divide 調査したところ、APIで受注明細を取得した段階で、 明細行が昇順に並んでいないようでした。 以前はうまく動いていたため、 APIで取得した明細行情報は整列している認識でしたが、 たまたま伝票の状態がよかっただけで、 明細行の並び順は保証されていないのでしょうか？ もしくは、API側の動作仕様が変わったのでしょうか？ ご教示いただけますと幸いです。 どうぞ、よろしくお願い致します。 --- ## 回答 (3件) ### hamee_sys — 2017/06/19 受注伝票受注明細をAPIで取得した場合の並び順ですが、API側ではソート処理は行なっていないため昇順に並ばない場合もあります。 並び替えを行うにはアプリ側で処理を行う必要があります。 ### ネクストエンジン設定代行（質問者） — 2017/07/03 ご回答ありがとうございます。 問題がおきたのはテスト用に作った伝票で、いろいろと処理したため 明細行が昇順に並んでいない状況が発生したものと思われます。 （問題を再現させようとしましたが、簡単には再現しませんでした） 通常利用でソートされていないことはなさそうであり、 伝票処理のたびにソートするのはコストがかかりますので、 特に並び替えを行う必要はない　との認識に達しました。 もし認識に誤りがありましたら、ご指摘頂けますと幸いです。 どうぞ、よろしくお願いいたします。 ### hamee_sys — 2017/07/05 基本的には登録順に並ぶので通常であれば明細行の昇順に並びますが、内部でソートは行なっていないので、アプリ側でソートしていただく方が確実かと思われます。 --- # 出力パラメータのStateの有効期限が切れたかどうかについては、どのように知りますか？ URL: https://developer.next-engine.com/questions/53/ **投稿者:** 本　晋　**日時:** 2017/02/10 **カテゴリ:** ネクストエンジンAPIについて 出力パラメータのStateの有効期限が切れたかどうかについては、どのように知り得ますか？ --- ## 回答 (8件) ### 本　晋（質問者） — 2017/02/10 Restful Callを使用して、UIDとStateを取得できますか？ ### hamee_sys — 2017/02/13 UIDとState取得についてはuid・state取得用のapiをご利用ください。 詳細についてはこちらをご覧ください。 [http://api.next-e.jp/param_uid_state.php](http://api.next-e.jp/param_uid_state.php) ### hamee_sys — 2017/02/13 access_token取得取得時に有効期限が切れたかどうかを確認することができます。 resultがerror、メッセージコード(code)が001004を返した場合、stateの有効期限が切れた状態になります。 stateの有効時間は5分になります。 エラーの一覧についてはこちらをご覧ください。 [http://api.next-e.jp/message.php](http://api.next-e.jp/message.php) ### 本　晋（質問者） — 2017/02/20 GET requestをuid/stateに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？ また、これは結果がRedirect uriに送られたということでしょうか？ また、例えば、HTML ログインページが返ってくるのではなく、Status.OK、Status.Failed、Rejectedなどのレスポンスが 返ってくる、ことが正常ですか？ ### 本　晋（質問者） — 2017/02/20 GET requestをuid/stateに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？ また、これは結果がRedirect uriに送られたということでしょうか？ また、例えば、HTML ログインページが返ってくるのではなく、Status.OK、Status.Failed、Rejectedなどのレスポンスが 返ってくる、ことが正常ですか？ ### 本　晋（質問者） — 2017/02/20 GET requestをuid/stateに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？ また、これは結果がRedirect uriに送られたということでしょうか？ また、例えば、HTML ログインページが返ってくるのではなく、Status.OK、Status.Failed、Rejectedなどのレスポンスが 返ってくる、ことが正常ですか？ ### hamee_sys — 2017/03/08 回答が遅くなり大変申し訳ございません。 まず、HTMLログインページが返ってきた件ですが起動したユーザーがネクストエンジンにログインされていない場合、ログイン画面へ遷移いたします。その後、ログインを行うとRedirect uriに指定されたページへ遷移されます。 起動したユーザーがネクストエンジンにログインされている場合は直接Redirect uriに指定されたページへ遷移します。 また、レスポンスについてですがredirect_uriにGETパラメータとして返されます。 レスポンスされる項目ですが 　uid ・・・　アプリを起動したユーザーのuid 　state　・・・　アプリを起動したユーザーのstate 　入力パラメータに渡したパラメータ　・・・　上記パラメータ以外に、入力パラメータに渡したパラメータがそのまま返却されます 詳しくはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) ### 本　晋（質問者） — 2017/03/08 ご回答誠に有難うございます。 --- # アプリ料金プランの変更 URL: https://developer.next-engine.com/questions/530/ **投稿者:** ash1naga　**日時:** 2017/06/22 **カテゴリ:** その他 失礼します。 現在、アプリを販売中なのですが、「現在販売中の料金プラン」を 変更(削除)するためにはどうすればよいでしょうか？ 例えば、「現在販売中の料金プラン」が以下の2つあった場合、1だけを削除したい場合はどうすればよいでしょうか？ 1.初期費用：10,000 　月額費用： 5,000 2.初期費用： 0 　月額費用： 5,000 --- ## 回答 (1件) ### oseo — 2017/06/22 oseoと申します。 料金プランの削除とは違いますが、 「アプリを作る」>該当アプリ編集>販売タブの「料金プランの変更」から、 新たな料金プラン(2.初期費用：0　月額費用： 5,000プランのみ)で審査申し込みをすることで対応できます。 ただし、既存のアプリユーザー企業様に対して、新しい料金プランに変更してもらうのか、 現行のままの料金プランで管理するのかは判断&調整する必要がありますね。 --- # 受注ステータスに関連した受注の取得方法 URL: https://developer.next-engine.com/questions/531/ **投稿者:** heihei000　**日時:** 2017/06/22 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIを最近利用使い始めた者です。 受注伝票の件数取得、検索などのAPIは頂いたURLに記載されていたのですが、 例えば受注ステータス「新規受付」内にある受注の 全ての情報(明細やお届け先住所など) を取得するにはどうしたらいいですか？ --- ## 回答 (1件) ### oseo — 2017/06/22 oseoと申します。 開発中に私も同様の疑問を持ち、問い合わせたことがあります。 >受注伝票の件数取得、検索などのAPIは頂いたURLに記載されていたのですが、例えば受注ステータス「新規受付」内にある受注の >全ての情報(明細やお届け先住所など)を取得するにはどうしたらいいですか？ 「新規受付」というステータスで検索をかけることできませんが、「新規受付」は「受注状態が1、受注キャンセル区分が0」のものを表していますので、 受注状態区分(receive_order_order_status_id )と受注キャンセル区分(receive_order_cancel_type_id)を条件に指定することで同等のことが実現可能です。 メイン機能＞受注管理＞詳細検索画面上部の「検索補助」からステータスを選択することで、そのステータスの条件を見ることができます。 --- # APIについておしえてください。 URL: https://developer.next-engine.com/questions/532/ **投稿者:** シャア　**日時:** 2017/06/22 **カテゴリ:** ネクストエンジンAPIについて アプリ開発中です。 GETリクエストをuid/stateに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？ また、これは結果がRedirect uriに送られたということでしょうか？ --- ## 回答 (1件) ### パックマン — 2017/06/22 アクセスしたユーザーがネクストエンジンにログインしているかどうかで結果が異なりますが、 ログインしていない場合はHTMLログインページが返ってくるのが正常な動きです。 すでにネクストエンジンにログインしている場合、アプリを作るで設定したRedirectURIにリダイレクトします。 APIリファレンス [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) --- # APIリクエスト回数について URL: https://developer.next-engine.com/questions/533/ **投稿者:** 長屋　祐希　**日時:** 2017/06/27 **カテゴリ:** ネクストエンジンAPIについて APIリクエスト回数のカウントのされかたについて教えてください。 APIのエンドポイントにリクエストする度に加算されるのでしょうか？ 例えば、1000件のクレジット承認区分を更新しようとした場合、 【受注伝票受注伝票更新】（/api_v1_receiveorder_base/update） に1000回リクエストを送信すると思いますが、 この場合はAPIリクエスト回数は1000回という事になりますか？ --- ## 回答 (1件) ### hamee_sys — 2017/06/28 はい、リクエスト回数は1000回になります。 --- # 「アプリを作る」について URL: https://developer.next-engine.com/questions/534/ **投稿者:** ぱたぱた　**日時:** 2017/06/27 **カテゴリ:** その他 開発中のアプリを本番環境で使いたいので、審査を申し込む必要があるのですが、アプリケーションが自社サーバーにおいてあります。 ローカルIPをホストにしたURLで登録しています。 となると、審査申し込んでも、ソースを確認することができないと思われます。 このような状態で審査していただけるのでしょうか？ できない場合、どのような対処をすればよいのでしょうか？ --- ## 回答 (1件) ### 岩さん — 2017/06/27 私も同様のことを経験したことがあるので、コメントすると.... 公開するアプリでなければそのまま審査に出していただいて大丈夫です。 説明文等がしっかり書かれていれば基本的には問題ありません。 もし、問題があった場合は担当者から連絡があると思います。 ただし、場合によってはサポート経由でソースの提出を求めさせていただく場合があるかも。 --- # access_tokenの有効期限に関する質問 URL: https://developer.next-engine.com/questions/535/ **投稿者:** ★富士山★　**日時:** 2017/06/27 **カテゴリ:** ネクストエンジンAPIについて アプリを開発中の者です。 APIの仕様によるとaccess_tokenの有効期限は1日となっているので、 サイトから受注データがなくても24ｈ以内にアクセスする事を考えていますが、どのようなAPIを呼べばaccess_tokenの有効期限がリセットされますか？ --- ## 回答 (1件) ### 岩さん — 2017/06/27 マニュアルの「refresh_tokenについて」に記載のあるとおり、リフ レッシュトークンを使えば アクセストークンの期限切れ後に新しい トークンが取得可能です。 [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) >>access_token値は、継続されますか？ 　はい。24h以内はトークンは継続（同じ値）されます。 >>最初の採番から24h後に必ずリセットされますか？ 　はい。アクセストークンは発行から24h後に利用できなくなります。 ただし、24h後の最初のリクエストにアクセストークンとリフレッシュ トークンを渡していただければ新しいアクセストークンとリフレッシュ トークンが取得できます。 リフレッシュトークンにも72hという期限がありますのでご注意ください。 --- # 自社で作成・公開したアプリのカテゴリについて URL: https://developer.next-engine.com/questions/536/ **投稿者:** 八つ橋　**日時:** 2017/07/04 **カテゴリ:** その他 PF画面の「アプリを探す」からアプリを見たときに「カテゴリで探す」というのがありますが、アプリにカテゴリを付けるにはどうしたらいいでしょうか？ マニュアルを探しましたが検索結果が1件もヒットしなくて困っています...... --- ## 回答 (1件) ### パックマン — 2017/07/04 開発者がアプリをカテゴライズすることはできないですね。 カテゴリは運営の担当者が付けているものとなるので、もし 要望がある場合は、どのカテゴリを希望されているかサポート センターまでお問い合わせする流れになります。 私も問い合わせたことがありますが、 ・必ずしもその要望通りにカテゴリを付与できないこともある ということを共有していただいて、お願いしました。 --- # SDKについてのご質問 URL: https://developer.next-engine.com/questions/537/ **投稿者:** 傭兵　**日時:** 2017/07/04 **カテゴリ:** 開発環境・SDKについて 提供SDKのJaveSDKでNEアプリクライエントクレフ（neApiClientクラス？）でメイン機能が取得できるのかどうかを確認したい。 ＜具体的には＞ 提供SDKのJaveSDK中のNEアプリクライエントクレフ（neApiClientクラス？）は受注情報を取得できるのか？できるのであればその手順を教えてほしい。 --- ## 回答 (1件) ### hamee_sys — 2017/07/04 受注情報はネクストエンジンAPIで取得可能です。 以下がAPIが提供しているエンドポイントになりますので、ご参照ください。 [https://developer.next-engine.com/api](https://developer.next-engine.com/api) アプリ開発の最初の流れは以下の記事をご参照下さい。(PHP版のSDKを使用していますが、流れは同様) [http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd](http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd) SDKでの必須パラメータ情報等は以下のリファレンスに記載されております。 [https://developer.next-engine.com/sdk](https://developer.next-engine.com/sdk) アプリ開発に関するテクニカルな課題に関してはこちらのコミュニティに投稿していただければと思います。 --- # 商品マスタの削除について URL: https://developer.next-engine.com/questions/538/ **投稿者:** 栗林憲一　**日時:** 2017/07/10 **カテゴリ:** ネクストエンジンAPIについて 商品マスタの削除はAPIで可能でしょうか？ --- ## 回答 (3件) ### hamee_sys — 2017/07/11 現状のAPIの仕様上、商品マスタの削除に関するエンドポイントは提供しておりません。 ### imada — 2019/10/08 現状も商品マスタ削除のエンドポイントは提供されていない状況でしょうか？ ### hamee_sys — 2019/10/28 大変恐縮ですが、こちらのAPIの提供はございません。 --- # 接続元IPを知りたいです。 URL: https://developer.next-engine.com/questions/539/ **投稿者:** ash1naga　**日時:** 2017/07/11 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンのAPI利用についての質問となります。 弊社本番環境と接続するにあたり、本番環境においてIP制限がかけられております。 ネクストエンジンのAPIは、初回アクセス時にuidとstateを取得する必要があり、情報が弊社指定のURLにリダイ レクトされてくるかと思います。 その際の接続元IPを許可する必要があるため、教えて頂けますか。 よろしくお願いします。 --- ## 回答 (2件) ### oseo — 2017/07/11 想定している認証の流れは以下の流れだと思います。 クライアント=>プラットフォーム基盤(ネクストエンジンサーバー)=>アプリ しかし、ネクストエンジンAPIの認証の流れは クライアント=>プラットフォーム基盤(ネクストエンジンサーバー)=>クライアント=>アプリなので、 (リダイレクト処理されるので)プラットフォーム基盤(ネクストエンジンサーバー)からアプリにアクセスすることはないです。 ですので、接続元IP(ネクストエンジンサーバーのIPアドレス)の許可設定は不要かと思います。 ### ash1naga（質問者） — 2017/07/11 oseoさん、ご教授ありがとうございます。 >クライアント=>プラットフォーム基盤(ネクストエンジンサーバー)=>アプリ こちらを想定していました。 理解できました！ --- # API(/api_v1_receiveorder_base/labelprinted)を呼び出す際、エラーメッセージが出る。 URL: https://developer.next-engine.com/questions/54/ **投稿者:** 栗林憲一　**日時:** 2017/02/13 **カテゴリ:** ネクストエンジンAPIについて 【対象のAPIのパス】 /api_v1_receiveorder_base/labelprinted 【言語・SDK使用の有無】 SDK使用あり 言語: PHP 以下のパラメータで実行を行うとエラーが発生します。 ケース1 ・INPUT receive_order_id = 1 receive_order_last_modified_date = 2017-01-18 00:00:00 ・結果 010008: receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 ケース2 ・INPUT receive_order_id = 1 receive_order_last_modified_date = 2017-01-20 00:00:00 ・結果 010008: receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 ケース3 ・INPUT receive_order_id = 1 receive_order_last_modified_date = 2017-01-19 12:55:38 ・結果 010008: receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 receive_order_last_modified_dateが更新できる条件を教えていただけますでしょうか。 また、メイン機能でreceive_order_last_modified_dateを更新する方法を教えてもらえますでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2017/02/13 receive_order_last_modified_dateは受注伝票になんらかの変更が発生した場合に自動的に更新されます。 任意の値で更新することが出来ない仕様となります。 API経由であれば、一括アップロードを使用し受注伝票を更新すると現在の日時で更新されます。 メイン機能であれば、例えば出荷確定処理や納品書ダウンロード、受注伝票詳細画面などで変更が行われた場合現在の日時で更新されます。 --- # 従量課金プランについて URL: https://developer.next-engine.com/questions/540/ **投稿者:** heihei000　**日時:** 2017/07/11 **カテゴリ:** その他 ネクストエンジンAPIについて。 アプリを開発し、公開前の段階になります。 アプリはページビュー数で料金が異なる従量課金のモデルを想定しています。 ネクストエンジンの従量課金は受注数によるものですが、このようなページビュー数の従量課金を行いたい場合、「1000PV/日」版、「2000PV/日」版のアプリを別々に公開して、ユーザー様に選んでいただくやり方になりますか？ あるいは現在、ネクストエンジン上で販売中のアプリのように、出荷数単位などの従量課金を設定可能でしょうか？ 従量課金を行えれば、いずれのこだわりもないので、ネクストエンジンのポリシーに即した形にしたいです。 --- ## 回答 (2件) ### hamee_sys — 2017/07/11 公開アプリに従量課金プランを適応することは可能です。 その際はアプリを複数作る方法ではなく(この方法だとプ料金プラン複数用意する方法と変わらない)、 請求に関するフォーマットがあるので、そちらに入力して頂き、毎月提出して頂く方法になります。 プラン適応判断や請求フローの共有など、調整が必要になると思いますので、サポートまでご連絡下さい。 ### heihei000（質問者） — 2017/07/11 ありがとうございます！ 助かります。 --- # アプリ環境にログインできない問題について URL: https://developer.next-engine.com/questions/542/ **投稿者:** まきまき　**日時:** 2017/07/18 **カテゴリ:** その他 特定企業のみアプリを開発しました。 申請は完了しております。(販売中) 本番環境にログインできない状態なのですが、考えられる原因としてはなにがあるでしょうか？ 教えて頂きたいです。 --- ## 回答 (1件) ### oseo — 2017/07/18 まず、アプリの利用許可とアプリに紐づくメイン機能の利用許可がされているかどうかを確認すると良いと思います。 設定＞アプリ(メイン機能)タブ＞「利用ユーザー設定」から、どのユーザーが利用許可されているかどうかを確認することができます。 --- # アプリ販売(初期費用)についての質問 URL: https://developer.next-engine.com/questions/543/ **投稿者:** 九州男児　**日時:** 2017/07/18 **カテゴリ:** その他 アプリ販売に関して質問です。 公開アプリを販売した場合、 月額費用の30％はシステム利用料で引かれるのは認識してるんですが、 初期費用もシステム利用料で30%引かれるのでしょうか？ --- ## 回答 (1件) ### パックマン — 2017/07/18 > 初期費用もシステム利用料で30%引かれるのでしょうか？ はい、初期費用も含めてアプリの請求金額の合計から30%が手数料となります。 --- # UpdateSrock.phpへのリクエストについて URL: https://developer.next-engine.com/questions/544/ **投稿者:** 村山　大　**日時:** 2017/07/24 **カテゴリ:** その他 UpdateSrock.phpへのリクエストについて質問があります。 Stock（在庫数）が空のデータが発生したので、調査した所 「空の場合は無限売りとして判定してください」との記載を見つけました。 この無限売りとは、商品マスタ上どの様な設定の場合に発生するものでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2017/07/24 無限売りとは、商品の在庫が常にモール・カートにあるような状態になります。 商品区分を[予約]、予約在庫数に99999を入力すると”無限売り”の設定にすることができます。 詳しくはこちらをご覧ください。 ・FAQ [http://manual.next-engine.net/faq/stock/faq-1535/](http://manual.next-engine.net/faq/stock/faq-1535/) ・商品マスタ登録・在庫登録（CSV一括） [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/g003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/g003/) ページ一番下の"以下ご確認ください。"参考 ### 村山　大（質問者） — 2017/07/24 無限売りの仕様は理解しました。 ありがとうございました。 --- # アプリ申し込みについて URL: https://developer.next-engine.com/questions/546/ **投稿者:** まきまき　**日時:** 2017/07/25 **カテゴリ:** その他 アプリ開発中の者です。 一点気になったことがあったので、投稿します。 申し込みをしたら、「購入ありがとうございました」という旨のメールは誰に届きますか？？ →『アプリを購入したアカウントの方のみ』でしょうか。 アプリを購入したことは、購入した本人以外知り得ない、ということもあり得ますでしょうか。 →ユーザー設定によって よろしくお願いいたします。 --- ## 回答 (2件) ### パックマン — 2017/07/25 自社の利用状況を共有します。 アプリの購入時に購入者へはメールは送信されません。 トップページのユーザーへのお知らせに購入の旨が表示されます。 [https://base.next-engine.org/](https://base.next-engine.org/) こちらは企業単位のため、購入者以外でも参照可能です。 アプリ提供元（アプリ開発会社）には利用開始された旨のメールが送信されます。 このアドレスは特定のユーザーではなくアプリに登録されているものです。 ### まきまき（質問者） — 2017/07/25 ありがとうございます！ 参考にさせていただきます！ --- # アプリの販売について URL: https://developer.next-engine.com/questions/547/ **投稿者:** 九州男児　**日時:** 2017/07/25 **カテゴリ:** その他 アプリの販売についてお聞きしたいことがあります。 自社で開発したアプリですが、 PF画面下部のアプリアイコンについて、本番アプリについても 「TEST」の帯がついているのはなぜでしょうか？ （アプリのステータスは「販売中」です） ※ アプリの種類は「メイン機能と連携するアプリ」で、販売形態は「すべての企業に公開」です。 --- ## 回答 (2件) ### たけやま — 2017/07/25 アプリを購入されていないのではないでしょうか？ 自社で作成したアプリでも「公開」アプリの場合は購入の手続きが必要です。 ### 九州男児（質問者） — 2017/07/25 TO: たけやまさん ありがとうございます。 やってみましたら、追加されました。 --- # 商品在庫更新について URL: https://developer.next-engine.com/questions/549/ **投稿者:** う　**日時:** 2017/07/26 **カテゴリ:** ネクストエンジンAPIについて 商品在庫数の更新について、 /api_v1_master_goods/uploadを使用している。 加算/減算しかない。 だから、実数値で更新されたいということでどうするでしょうか。 よろしくお願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2017/07/31 ご認識通り在庫数は、実数ではなく加算数または減算数を設定します。 実数で更新したい場合は、一度現在の在庫数を取得し更新したい在庫数の差分で更新することになります。 [例] 　現在の在庫数が 6 更新したい在庫の実数が4 在庫数は -2 で設定 ### inouema — 2018/12/06 /api_v1_master_goods/upload を使って、ネクストエンジン側の商品在庫数を加算/減算できるということですが 在庫数の差分を表すフィールド名を教えてください。 商品コード,在庫数差分 の2列のCSVを商品マスターとしてアップロードすれば、在庫数更新できるという事でしょうか？ ### hamee_sys — 2018/12/07 フィールド名は下記の通りです。 在庫数 ・・・zaiko_su 予約在庫数 ・・・yoyaku_zaiko_su ＞商品コード,在庫数差分 ＞の2列のCSVを商品マスターとしてアップロードすれば、在庫数更新できるという事でしょうか？ はい、ご認識のとおりでございます。詳しくは下記のページを参照の上、設定していただけますでしょうか。 [https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/](https://manual.next-engine.net/main/product/prd_shohin-touroku/8588/) --- # api_v1_receiveorder_paymentdeliveryconvert searchについて教えて下さい URL: https://developer.next-engine.com/questions/55/ **投稿者:** 栗林憲一　**日時:** 2017/02/13 **カテゴリ:** ネクストエンジンAPIについて 【対象のAPIのパス】 /api_v1_receiveorder_paymentdeliveryconvert/search 【言語・SDK使用の有無】 Java + PHP レスポンスの項目について確認させてください。 payment_delivery_convert_text : 決済する銀行 payment_delivery_convert_type : 決済するカードのタイプ このAPIは、受注の決済方法を取得すると認識しておりますが合っていますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/02/22 /api_v1_receiveorder_paymentdeliveryconvert/search ですが支払発送変換設定を取得するapiになります。 支払発送変換設定はメイン機能の設定→受注→支払発送変換より確認することができます。 詳しくは以下マニュアルをご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a009/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a009/) --- # バッチ処理＆API利用にあたっての、各種資格情報の扱いについて URL: https://developer.next-engine.com/questions/551/ **投稿者:** l.h.t　**日時:** 2017/07/28 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 APIに限ったことではないのかもしれませんが……。 ECサイトの在庫管理・連携にNE：ネクストエンジンを既に利用していて、 自社商品マスターや在庫などの操作のためにバッチ処理の作成を検討しています。 想像図としては以下のとおりです。 　　　[ NEサーバ ] 　　　　　↑↓　API経由で商品情報の取得・変更、在庫の変更 　　　[ 自社Webサーバ ] 　　　　　↑↓　在庫数の確認や注文前の確認等 　　　[ 末端顧客 ] また現状では以下の通りと理解しています。 　　・「アプリ」は特定のネクストエンジンID（が使用する商品等データベース）と直接紐付くものではない 　　・client_id & client_secret は「アプリ」を識別するためのもの 　　・（提供SDKがphp/javaのみであったことから） javascriptなどにより利用者が直接APIを叩くことは想定されていない 　　・uid, stateは、以下の流れでNEサーバから利用者を経てアプリに授受される 　　　　1．利用者ブラウザからネクストエンジンへログインを行う 　　　　2．利用者ブラウザに [https://base.next-engine.org/](https://base.next-engine.org/) 以下のcookieとして資格情報がセットされる 　　　　3．利用者ブラウザが [https://base.next-engine.org/users/sign_in/](https://base.next-engine.org/users/sign_in/) に client_id, secret をもってアクセスする（アクセス時にcookie送信） 　　　　4．レスポンス内容中のおよびHTTPレスポンスヘッダのリダイレクト先URLに、uid, state が追加される 　　　　5．リダイレクト先のURL ≒ アプリが uid, state を受け取る 質問は以下の通りです。 　　○ バッチ処理が目的であれば、実際に外部からredirect_urlにアクセスできる必要はなく、 　　　　また、これのためだけに、HTTPS接続できるWebサーバを用意する必要もない、と考えて良いか？ 　　○ バッチ処理を念頭に置いた場合、uid/stateやaccess_token/refresh_tokenが失効した際に 　　　　毎回手動でネクストエンジンへの「ログイン」を行わねばならないとなると 　　　　完全に自動化とならず不便であるため、「ネクストエンジンへのログイン」自体も自動化したいと考えているが 　　　　マニュアルにはこのあたりについての記述を見出せず、 　　　　SDKの中身を見るとNEログイン処理はあくまで画面ベース（ブラウザベース）で行うかたちである模様であった。 　　　　プログラムによる「ネクストエンジンへのログイン」の自動化は可か、不可か？ 　　　　可である場合、やり方など制限や規則はあるか？ 　　　　また、現在のログインの仕組みは将来変更が予定されているか？ 　　○ 上記NEへの自動ログインが不可であった場合特に問題となるが、 　　　　access_token/refresh_token（旧）両方を使用してのAPIアクセス時、 　　　　新規access_token/refresh_token（新）が発行される際に、（旧）の各tokenは失効するか？ 　　　　また、上記および有効期間経過による失効以外に、失効することはありうるか？ 　　　　　　※要するに、自動ログインできない場合、1日数回のAPI利用を確実に行っていれば 　　　　　　　間違いなく永続的にtokenを使用し続けられるのか、ということです 　　　　　　　マニュアル「refresh_tokenについて」に、マルチスレッド絡みで注意事項の記述があったため、もしや、と ご回答よろしくお願い致します。 --- ## 回答 (5件) ### hamee_sys — 2017/08/02 回答いたします。 >バッチ処理が目的であれば、実際に外部からredirect_urlにアクセスできる必要はなく、 >また、これのためだけに、HTTPS接続できるWebサーバを用意する必要もない、と考えて良いか？ →バッチ処理自体はredirect_urlにアクセス必要ありませんが、最初の認証のためにuid/stateでaccess_token/refresh_tokenを取得する必要があるため、　HTTPS接続できるWebサーバを用意する必要があります。 バッチ処理を念頭に置いた場合、uid/stateやaccess_token/refresh_tokenが失効した際に 毎回手動でネクストエンジンへの「ログイン」を行わねばならないとなると 完全に自動化とならず不便であるため、「ネクストエンジンへのログイン」自体も自動化したいと考えているが マニュアルにはこのあたりについての記述を見出せず、 SDKの中身を見るとNEログイン処理はあくまで画面ベース（ブラウザベース）で行うかたちである模様であった。 >プログラムによる「ネクストエンジンへのログイン」の自動化は可か、不可か？ >可である場合、やり方など制限や規則はあるか？ →前述の通り、最初の認証のために必ずWebアプリ(ブラウザベース)をご用意していただく必要があります。 最初にWebアプリでaccess_token/refresh_tokenを取得後、DB等に保持しaccess_token/refresh_tokenを最新の状態にするような仕組みを構築することで、その後は更新された最新のaccess_token/refresh_tokenを利用することにより自動化することが可能です。 また、ご参考までにfuelPHPになりますが access_token/refresh_tokenを更新する仕組みがある、「ネクストエンジンアプリ基盤」を提供しております。 [https://developer.next-engine.com/tutorial/sample-fuelphp](https://developer.next-engine.com/tutorial/sample-fuelphp) >また、現在のログインの仕組みは将来変更が予定されているか？ →現時点では変更の予定はありませんが、将来的に変更を検討する可能性はあります。 >上記NEへの自動ログインが不可であった場合特に問題となるが、 >access_token/refresh_token（旧）両方を使用してのAPIアクセス時、 >新規access_token/refresh_token（新）が発行される際に、（旧）の各tokenは失効するか？ >また、上記および有効期間経過による失効以外に、失効することはありうるか？ >※要するに、自動ログインできない場合、1日数回のAPI利用を確実に行っていれば >間違いなく永続的にtokenを使用し続けられるのか、ということです >マニュアル「refresh_tokenについて」に、マルチスレッド絡みで注意事項の記述があったため、もしや、と →新しいaccess_token/refresh_tokenが発行されると旧のtokenは失効します。 1日数回のAPI利用で最後に利用したaccess_token/refresh_tokenを利用する事によって使用し続けられます。 前述の補足になりますが、API利用後にレスポンスされたaccess_token/refresh_tokenをDB等に保持するような仕組みを構築すれば、永続的にaccess_token/refresh_tokenを利用する事が可能です。 ### l.h.t（質問者） — 2017/08/02 ご回答ありがとうございます。 追加で 4点、質問させて頂きたく、以下申し上げます。 　　※追加の質問 4点につき、質問部分に ● を付させて頂いております ----- ----- ----- > >バッチ処理が目的であれば、実際に外部からredirect_urlにアクセスできる必要はなく、 > >また、これのためだけに、HTTPS接続できるWebサーバを用意する必要もない、と考えて良いか？ > > → バッチ処理自体はredirect_urlにアクセス必要ありませんが、(...) HTTPS接続できるWebサーバを用意する必要があります。 わたくしの記述が曖昧であり申し訳ありません。 ●「サーバ証明書を導入し、HTTPS接続要求を受け入れられる、Webサーバ」を用意する必要の有無はいかがでしょうか？ 　　※「base.next-engine.orgに対してHTTPS接続を投げられる」サーバ、ではなく 　　※「[https://domain-name/path/](https://domain-name/path/)」というURLを提供できるサーバ、という意味合いです ----- ----- ----- > >プログラムによる「ネクストエンジンへのログイン」の自動化は可か、不可か？ > >可である場合、やり方など制限や規則はあるか？ > > →前述の通り、最初の認証のために必ずWebアプリ(ブラウザベース)をご用意していただく必要があります。 ●「プログラムによる「ネクストエンジンへのログイン」の自動化」の許可は頂けない、実施してはいけない、という認識で相違ないでしょうか？ ----- ----- ----- > >また、現在のログインの仕組みは将来変更が予定されているか？ > →現時点では変更の予定はありませんが、将来的に変更を検討する可能性はあります。 ●前項の質問に対するご回答が否であった場合のみですが、変更される/された際に、告知・アナウンス等は行って頂けるのでしょうか？ ----- ----- ----- > →新しいaccess_token/refresh_tokenが発行されると旧のtokenは失効します。 > 1日数回のAPI利用で最後に利用したaccess_token/refresh_tokenを利用する事によって使用し続けられます。 新規tokenが発行されると同時に、即座に旧tokenが失効するということですね。 そしてつまり、実装次第とはいえ、例えば 　　[ 1時間に自動的に1回実行する予定のバッチが、不測のトラブル等により、1時間以上継続的に実行された ] などの場合に、実装したtokenの保存/読み取り 各処理のタイミングによっては、 24時間ないし72時間以内の再アクセスであっても、認証に失敗する可能性がある、ということですね。 　　1．「24時間ないし72時間の有効期限経過」 　　2．「新token発行による失効」 ●上記 2点以外に、tokenが失効する可能性はあるか、ないか、につきましてはいかがでしょうか？ 　 また、ある場合、どのような理由・原因によるものでしょうか？ ----- ----- ----- ### l.h.t（質問者） — 2017/08/02 ※「返信」に切り替えるためコメント削除 ### hamee_sys — 2017/08/02 ご質問ありがとうございます。 追加質問について確認いたしますので、回答までしばらくお待ちいただきますようお願い致します。 ### hamee_sys — 2017/08/07 回答ですが、バッチプログラムによるAPIの利用の流れについて以下QAで纏めておりますので、こちらをご確認いただき再度不明点等ありましたら、ご質問いただければと思います。 [https://developer.next-engine.com/node/47](https://developer.next-engine.com/node/47) 上記のページの項番1で 「少なくとも初回は必ず1）の対応が必要なため、・・・」とあり、1）の方法でアクセストークンとリフレッシュトークンを取得 するためには「サーバ証明書を導入し、HTTPS接続要求を受け入れられる、Webサーバ」を用意する必要があります。 サーバー証明書は必ずしも有償である必要はなく、最初のアクセストークンを取得するだけれあればローカル環境で取得する方法があります。詳しくはこちらをご覧ください。 [https://developer.next-engine.com/questions/19](https://developer.next-engine.com/questions/19) バッチプログラムだけでの自動認証は不可となっております。(初回を上記手順で手動でトークンを取得できれば、その後はプログラムによって最新のトークンを保持することにより可能) >●上記 2点以外に、tokenが失効する可能性はあるか、ないか、につきましてはいかがでしょうか？ >　 また、ある場合、どのような理由・原因によるものでしょうか？ その他にはapiのリクエストがエラーになった時も更新されます。 詳しくは以下、補足説明をご覧ください。 [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) >●前項の質問に対するご回答が否であった場合のみですが、変更される/された際に、告知・アナウンス等は行って頂けるのでしょうか？ API等の仕組みが変更された場合はTOPページの更新履歴でアナウンスしております。 [https://developer.next-engine.com/](https://developer.next-engine.com/) --- # 受注伝票検索時の明細取得について URL: https://developer.next-engine.com/questions/553/ **投稿者:** MSM-03C　**日時:** 2017/08/02 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注伝票検索（/api_v1_receiveorder_base/search）の結果には受注伝票の明細情報はないでしょうか？ 明細情報が欲しい時は、受注明細検索（/api_v1_receiveorder_row/search）を別途呼んで、 自分で受注伝票検索の結果と組み合わせないとダメでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/08/02 受注基本情報と受注明細情報を取得するにはご認識通り、受注伝票検索（/api_v1_receiveorder_base/search）と受注明細検索（/api_v1_receiveorder_row/search）両方を呼ぶ必要があります。 --- # APIでセット商品の商品情報を取得する方法 URL: https://developer.next-engine.com/questions/554/ **投稿者:** segayan3　**日時:** 2017/08/04 **カテゴリ:** ネクストエンジンAPIについて APIを使って商品マスタを取得しても、セット商品として登録した商品の情報が取得できません。 セット商品の商品情報はどのフィールドで取得できるのでしょうか。 --- ## 回答 (9件) ### hamee_sys — 2017/08/04 確認いたしますので、申し訳ございませんがしばらくお待ちください。 ### hamee_sys — 2017/08/15 回答遅くなり申し訳ございません。確認いたしましたところ、現状ではAPIでセット商品を取得する方法はございません。 ### M2 — 2018/06/05 [https://developer.next-engine.com/questions/554](https://developer.next-engine.com/questions/554) 上記の方で、APIでセット商品を取得することが出来ないとコメントございますが、 在庫(在庫マスタ検索API)数についても、現状、セット商品(セット商品コード)の在庫数についてはAPIで取得が出来ないでしょうか。 ### hamee_sys — 2018/06/08 お待たせしてしまい、大変申し訳ございません。 現状では、セット商品コードの在庫数はAPIで取得することができません。 また何かございましたらお問い合わせください。 ### 竹井　浩之 — 2020/04/28 こちら以前のコメントでセット商品の情報取得は現状出来ないとありますが、 現在も出来ないのでしょうか？ 取得できるようになる予定はございますでしょうか。 ### hamee_sys — 2020/04/30 検索・更新できる項目につきましては、リファレンスに 掲載されている項目のみとなっております。 今後の開発予定につきましては、現在は未定でございます。 何とぞよろしくお願いいたします。 ### 綿半三原商店 — 2021/12/23 こちら以前のコメントでセット商品の情報取得は現状出来ないとありますが、 現在も出来ないのでしょうか？ ### 高見沢　徳明 — 2022/05/30 こちらのスレッドで現在は扱いがないとありますが、今後も変更なしでしょうか？また、なぜなのでしょうか？ 弊社では頻繁にセット商品の変更が発生することがあるため機能実装いただけると助かります。 ### KANZAKI — 2022/09/07 子商品にセット商品の商品コードを入れてみてはいかがでしょうか？ --- # ECサイト連携について URL: https://developer.next-engine.com/questions/555/ **投稿者:** う　**日時:** 2017/08/04 **カテゴリ:** その他 ECサイトで受注オーダーを新規して、受注した商品の在庫数を変更しました。 ネクストエンジン側上記で新規したオーダーを取得できる。 でも、ネクストエンジン側上記商品の在庫数と引当数が変更しない。 なぜでしょうか。どうぞよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/08/07 在庫連携がされていない可能性があります。こちらをご覧いただき在庫連携がされているかご確認頂けますでしょうか。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/i002/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/i002/) --- # Let's encryptをアプリの証明書として利用したい URL: https://developer.next-engine.com/questions/56/ **投稿者:** れこ　**日時:** 2017/02/13 **カテゴリ:** 開発環境・SDKについて APIを利用するためにHTTPSが必須と書かれてますが、Let's encryptで作成したDV証明書を使用することはできますか？ Let's encrypt: [https://letsencrypt.org/](https://letsencrypt.org/) --- ## 回答 (2件) ### hamee_sys — 2017/02/15 Let's encryptで作成したDV証明書は利用可能です。 ### れこ（質問者） — 2017/02/16 ありがとうございます。 --- # 受注伝票出荷確定処理 APIにつきまして URL: https://developer.next-engine.com/questions/561/ **投稿者:** hirai.forest　**日時:** 2017/08/17 **カテゴリ:** ネクストエンジンAPIについて 受注の一括処理の自動化に関しまして、質問です。 1. 受注伝票出荷確定処理APIですが、こちらは伝票1件分の処理かと認識しておりますが、複数伝票を一括で出荷確定にするAPIその他、自動化の手段はありますでしょうか。 ※ APIの使用制限があるため、受注数が多くなると1件ごとの処理は現実的ではありません。また、双方のシステムの負荷も相当なものとなります。 2. また、納品書印刷済みから納品書印刷待ちに戻すAPIはありませんでしょうか。 これもまた、複数伝票の一括処理ができる方法があれば素敵です。 よろしくお願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2017/08/18 >1. 受注伝票出荷確定処理APIですが、こちらは伝票1件分の処理かと認識しておりますが、複数伝票を一括で出荷確定にするAPIその他、自動化の手段はありますでしょうか。 >※ APIの使用制限があるため、受注数が多くなると1件ごとの処理は現実的ではありません。また、双方のシステムの負荷も相当なものとなります。 →ご認識通りAPIでは、伝票の一括更新は行えないので1件ごとの処理になります。 >2. また、納品書印刷済みから納品書印刷待ちに戻すAPIはありませんでしょうか。 >これもまた、複数伝票の一括処理ができる方法があれば素敵です。 →申し訳ございません、納品書印刷済みから納品書印刷待ちに戻すAPIは存在しません。メイン機能からのみとなります。 ### hirai.forest（質問者） — 2017/08/18 早速のご回答をいただき、誠にありがとうございます。 承知いたしました。 出荷周りの効率化などは、各社工夫のしどころかと思います。 そのためにAPIの利用価値は大きく、将来的にこのあたりの機能拡充をいただければより一層便利になるかと思っております。 よろしくご検討をいただけましたら幸いです。 ### hamee_sys — 2017/08/21 貴重なご意見、誠にありがとうございます。今後のサービス改善に参考にさせていただければと存じます。 今後とも宜しくお願い致します。 --- # 受注伝票更新APIについえｔ URL: https://developer.next-engine.com/questions/565/ **投稿者:** ecbeingミツモト　**日時:** 2017/08/23 **カテゴリ:** ネクストエンジンAPIについて いつも御世話になっています。 ecbeing三本と申します。 以下、受注伝票更新API機能について確認させてください。 ＜質問１＞ 受注伝票更新APIのパラメータ「receive_order_id（伝票番号）」はネクストエンジン側でデータ生成時に採番される「主キー」の認識で相違ないでしょうか？ 上記が正しい場合、外部システム側がAPIを使用するためには「伝票番号」をユニークデータとして外部システム側において管理する必要があるという認識で相違ないでしょうか？ このキーはネクストエンジン側において自動生成されるタイプでしょうか？ それともネクストエンジン側でユーザーが任意に生成ルールを設定できるタイプでしょうか？ ＜質問２＞ 本APIを使用するときは「伝票番号単位にリクエストする」が正しいでしょうか？ 　⇒　複数の伝票番号をまとめて一回のリクエストで処理できないという意味です。 以上です。 ご回答のほどよろしくお願いします。 --- ## 回答 (4件) ### hamee_sys — 2017/08/24 ＜回答１＞ 受注の伝票番号はネクストエンジン内で一意に付与される番号で、ユーザーが設定できる値ではありません。そのため、外部システムにおいてもユニークな値として扱う必要があります。 ご参考： [https://developer.next-engine.com/api/fields/receiveorder_base](https://developer.next-engine.com/api/fields/receiveorder_base) ＜回答２＞ 申し訳ありませんが一括更新は行えませんので、ご認識通り「１件ごとにリクエストする」という形になります。 ご参考： [https://developer.next-engine.com/comment/229#comment-229](https://developer.next-engine.com/comment/229#comment-229) ### 中間　博章 — 2020/02/11 お世話になります。中間と申します。 相乗りで質問させてください。 現在私のテスト環境では、伝票番号が連番で 1、2、3...と続いて採番がなされています。 これはテスト環境だから1から順に採番されるだけで、本番環境の場合は、異なるメイン機能間でも同じ番号が生じることはない、という認識で間違いないでしょうか？ よろしくお願いします。 ### hamee_sys — 2020/02/12 ご質問ありがとうございます。 > 本番環境の場合は、異なるメイン機能間でも同じ番号が生じることはない いいえ、異なるメイン機能間での一意性は保証しておりません。 複数メイン機能をご導入されており、アプリなどによりデータを一元管理される場合などは、伝票番号（receive_order_id）は重複しますのでご注意ください。 リファレンス上の「ネクストエンジン内で一意に付与される番号」という表現において混乱させてしまい恐縮ですが、「メイン機能内で一意に付与される番号」とご理解いただければ幸いです。 以上、ご質問へのご回答とさせていただきますが、その他ご不明点がございましたらお気軽にお申し出くださいませ。 ### 中間　博章 — 2020/02/13 ご返信ありがとうございます。 >リファレンス上の「ネクストエンジン内で一意に付与される番号」という表現において混乱させてしまい恐縮ですが、「メイン機能内で一意に付与される番号」とご理解いただければ幸いです。 上記の内容を、リファレンスへ反映お願いしたいです。 よろしくおねがいします。 --- # 受注伝票検索の受注番号について URL: https://developer.next-engine.com/questions/567/ **投稿者:** たなたな　**日時:** 2017/08/24 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注伝票検索について質問です。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) フィールド名「receive_order_shop_cut_form_id（受注番号）」は、 以下ページ受注メールの項目名「注文コード」と同一でしょうか。 [http://manual.ec-doc.net/startup/hanyo/dd115/](http://manual.ec-doc.net/startup/hanyo/dd115/) --- ## 回答 (1件) ### hamee_sys — 2017/08/30 ご指摘の「注文コード」は店舗側で付与される受注番号を表しますので、ご認識通り受注伝票検索の「receive_order_shop_cut_form_id」フィールドに相当します。 --- # バッチ開発のアプリ申請について URL: https://developer.next-engine.com/questions/569/ **投稿者:** SYS平　**日時:** 2017/08/24 **カテゴリ:** その他 NE受注伝票の情報を定時バッチで取得する機能と 自社システムの画面からボタン操作で取得する機能の開発を計画しています。 稼働初回にNEログインからaccess_token取得までを実施し、 取得したaccess_tokenは自社DBに格納して各機能で使用する想定です。 初回のみ使用する機能をWEBサーバーに、 バッチやボタン操作の機能をアプリサーバーに置きたいのですが、 アプリとしては纏めて1つの申請で問題ないのでしょうか。 また、その場合の審査方法はどのようになりますか？ --- ## 回答 (4件) ### hamee_sys — 2017/08/25 ご認識通り、一つのアプリとして申請できます。また、審査方法は通常と変わりません。申請する前に必ずaccess_tokenを取得するためのURI（御社の場合はWEBサーバーのURI）を「Redirect URI」に設定してください。 ### SYS平（質問者） — 2017/12/20 引き続き申請について確認させてください。 本アプリが自社のWEBサーバー上でしか動作しない場合、 本番環境のアプリ申請をテスト環境の申請と同様に「[https://localhost](https://localhost)～」で行っても問題ないでしょうか？ ### hamee_sys — 2017/12/20 「[https://localhost](https://localhost)～」でも問題ございません。 ### SYS平（質問者） — 2017/12/21 承知しました。 ご教示ありがとうございました。 --- # アップロードキューについて URL: https://developer.next-engine.com/questions/57/ **投稿者:** 栗林憲一　**日時:** 2017/02/13 **カテゴリ:** ネクストエンジンAPIについて 【対象のAPIのパス】 /api_v1_system_que/search 【言語・SDK使用の有無】 Java + PHP アップロード名(que_upload_name)のレスポンス値について 　　NE_API以外:メイン機能よりアップロード　 　　NE_API:独自アプリ等からのAPI経由からアップロード ということでよいか？　 その場合、ネクストエンジンAPIでアップロードした場合にはどの機能でアップロードされたのか分かりますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/02/13 > アップロード名(que_upload_name)のレスポンス値について > 　　NE_API以外:メイン機能よりアップロード　 > 　　NE_API:独自アプリ等からのAPI経由からアップロード > ということでよいか？　 はい、ご認識の通りです。 > その場合、ネクストエンジンAPIでアップロードした場合にはどの機能でアップロードされたのか分かりますでしょうか？ 同APIの機能名（que_method_name）にて識別可能です。 SYOHIN_KIHON_CSV:商品マスタCSVアップロード JYUCHU_CSV:受注一括アップロード となります。 --- # アプリ開発の際のPHP、フレームワークのバージョンについて URL: https://developer.next-engine.com/questions/570/ **投稿者:** cnet　**日時:** 2017/08/29 **カテゴリ:** 開発環境・SDKについて お世話になっております。 チュートリアルではアプリ作成に必要なバージョンが書いてありましたが、 実際に作成するときに絶対に満たさなければならないPHPやフレームワークの条件はありますでしょうか？ 弊社がPHP 7系、laravel5系を使用してサイトを運営しているため、 そこに組み込みたいのですがもしこの条件ではできない等ありましたらご回答いただければ幸いです。 --- ## 回答 (1件) ### hamee_sys — 2017/08/30 PHP SDKを用いるためのフレームワークの条件はございませんので、FuelPHPやLaravelプロジェクトに組み込むことは可能です。 一方、PHPバージョン5.4以上（7系を除く）で動作確認をしておりますので、PHP 7系で正常に動作することは保障できかねます。 --- # CRON設定で自動ログインできるようにする方法を教えてください。 URL: https://developer.next-engine.com/questions/573/ **投稿者:** giangnt　**日時:** 2017/09/04 **カテゴリ:** ネクストエンジンAPIについて 現在、ネクストエンジンAPIを使った自社システムを開発しております。 現在の設定ですとAPIを取得する際に毎回手動ログインする必要があります。 CRON設定で自動ログインできるようにしたいのですがうまくいきません。 neApiClient.phpにてapiExecuteNoRequiredLoginという関数を発見し 下記のように入力しましたが、 $ guest = $ client-> apiExecuteNoRequiredLogin（ '/ api_v1_receiveorder_base / search'、$ api_params）; これだと上手くいきませんでした。 何卒ご教示お願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2017/09/04 Next Engine APIに発行されるaccess_tokenとrefresh_tokenを利用することで、初回ユーザー認証のみでAPIを利用し続ける事ができます。crontabなどのタスク実行プログラムを使用する必要はございません。 refresh_tokenについて： [https://developer.next-engine.com/api/refresh_token](https://developer.next-engine.com/api/refresh_token) なお「apiExecuteNoRequiredLogin」というメソッドは、ネクストエンジンログインが不要なAPIの場合に用いるメソッドです。受注伝票検索は「メイン機能と連携するアプリ」が利用するエンドポイントですので、リクエスト送信時に「apiExecuteNoRequiredLogin」ではなく「apiExecute」を使用する必要がございます。 neApiClientクラスについて： [https://developer.next-engine.com/sdk#php_neApiClient](https://developer.next-engine.com/sdk#php_neApiClient) ### giangnt（質問者） — 2017/09/05 i want use cron to auto get guest list. but API must have login. how can i use it without login ### hamee_sys — 2017/09/06 In order to use the API from a cron task or from the commandline, you must first obtain an "access_token" and/or "refresh_token" via the web application. Once you have obtained these tokens, you can save them to your database and use them to call the API without having to login before each request. Keep in mind, the access_token and refresh_token both have expiration dates; therefore, if you save them to your database, you must refresh them periodically in order to avoid authentication errors. Each successful API response contains a new access_token and refresh_token with an updated expiration date. For information on using the API from a batch script: [https://developer.next-engine.com/faq](https://developer.next-engine.com/faq) Related issue on the community site: [https://developer.next-engine.com/questions/472](https://developer.next-engine.com/questions/472) --- # 受注一括登録パターンIDについて URL: https://developer.next-engine.com/questions/574/ **投稿者:** yuya-saito　**日時:** 2017/09/05 **カテゴリ:** ネクストエンジンAPIについて 掲題の件について、受注伝票アップロードAPIにて FutureShop2の標準フォーマットで取り込みたい場合に 下記を参照し、receive_order_upload_pattern_id に[19]を指定して実行すると「存在しない受注一括登録パターン[19]です。」 とエラーがでしまう。 仮にIDと店舗の組み合わせで一意になるのであれば パターンIDを確認する方法がわからないでご教示いただきたいです。 [URL] [https://developer.next-engine.com/api/fields/receiveorder_receive_order_...](https://developer.next-engine.com/api/fields/receiveorder_receive_order_upload_pattern_format) --- ## 回答 (2件) ### hamee_sys — 2017/09/06 ネキストエンジンAPIでは「受注一括登録フォーマットパターン」と「受注一括登録パターン」を区別して扱っております。受注伝票アップロードの「receive_order_upload_pattern_id」に入力する値は登録対象の受注一括登録「パターンID」ですが、ご指定の値「19」はFS2標準パターンの「フォーマットパターンID」です。 「受注一括登録パターン情報取得」のエンドポイントから、各フォーマットパターンのパターンIDを取得することができます。レスポンス結果から「FS2標準パターン」のフォーマットパターンIDを調べて頂きますと、それに該当する「パターンID」を取得することができます。 受注一括登録パターン情報取得： [https://developer.next-engine.com/api/api_v1_receiveorder_uploadpattern/...](https://developer.next-engine.com/api/api_v1_receiveorder_uploadpattern/info) ### 田辺 啓介 — 2018/02/20 フォーマットidとパターンidは違う事に気づきました。 --- # redirect_uriへの引数変更について URL: https://developer.next-engine.com/questions/577/ **投稿者:** 野口学夫　**日時:** 2017/09/07 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 昨日から、redirect_uriへの引数がuidとstate以外に、idが追加されたように見受けられます。 そのidは何のidでしょうか？ 公開されているAPI仕様書を確認した限りでは、特に書かれていないようで、内容をご教授していただけますでしょうか？ 宜しくお願い致します。 --- ## 回答 (2件) ### hamee_sys — 2017/09/07 ご質問頂き、ありがとうございます。 本件はただいま調査しております。 申し訳ございませんが、もう少々お待ちください。 ### hamee_sys — 2017/09/11 ご認識の通り、9/6のリリースにより新たに id パラメータが付与されるようになりました。 APIリファレンスへの記載が漏れておりましたので追記いたしました。 [https://developer.next-engine.com/api/auth](https://developer.next-engine.com/api/auth) 番号1. ユーザーがアプリを起動 の備考欄です。 --- # access_token・refresh_token URL: https://developer.next-engine.com/questions/578/ **投稿者:** yaoqingmei　**日時:** 2017/09/07 **カテゴリ:** ネクストエンジンAPIについて APIを実行する時、access_tokenとrefresh_tokenは全部指定する場合、access_tokenが有効期限が切れますが、refresh_tokenの有効期限内であっても、エラーと戻るの原因はなんですか？ --- ## 回答 (5件) ### hamee_sys — 2017/09/11 access tokenが有効期限切れ、refresh tokenが期限内という状態になった場合、初回のAPI実行のみエラーにはならず新しいaccess tokenとrefresh tokenが発行されます。 この時に発行されるaccess tokenとrefresh tokenを保持しておけば、以降のAPIは正常に実行することができます。 ただ、この時のaccess tokenとrefresh tokenを保持せず、今までのaccess tokenとrefresh tokenでAPIを実行するとエラー(002002: access_token[xxxxx]が不正です。)が発生します。 ### atsushi0843 — 2019/05/20 基本的にその通りの動きになっているのですが、1～2週間に一回くらいのペースで「access tokenが有効期限切れ、refresh tokenが期限内という状態になった場合、初回のAPI実行時」にもエラーになるように見えます。 その場合、二度と新しいaccess tokenを貰えないのですが、何かやり方に問題があるか確認すべき点があればご助言願えませんでしょうか。 なお、ネクストエンジンAPIは使い始めたばかりで、まだ本番運用したことはありません。 ### yaoqingmei（質問者） — 2017/09/11 NeApiClient client = new NeApiClient(accessToken, refreshToken); apiResult = client.apiExecute("/api_v1_login_company/info"); ↑のように、ネクストエンジンAPIを呼び出すとき、入力パラメータにaccessTokenとrefreshTokenは指定していない場合、access tokenが有効期限切れ、refresh tokenが期限内という状態になった時、APIを実行すると、access tokenは新たに発行されますか？ ### hamee_sys — 2017/09/21 回答が遅くなり申し訳ございません。 access tokenの有効期限が切れrefresh tokenが期限内の場合については以下の通りになります。 【refresh tokenが指定された場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます。 【refresh tokenが省略された場合】 出力パラメータ「result」の値がredirectになります。 ### maki — 2024/12/03 お世話になります。 本日 2024/12/03 06:13:52 期限のアクセストークンについて、 期限切れ一回目 2024/12/03 06:14:40 の [POST] /api_v1_login_company/info アクセスで 002002 が返却されました。 その後もエラーが続いており、過去のご回答内容と食い違う認識です。 なおリフレッシュトークンの期限は 2024/12/05 06:13:52 です。 取り急ぎご対応いただくことは可能でしょうか？ --- # ネクストエンジンの動作確認に使用できる無料のデモ環境はありますか？ URL: https://developer.next-engine.com/questions/58/ **投稿者:** れこ　**日時:** 2017/02/13 **カテゴリ:** ネクストエンジンAPIについて /api_v1_master_shop/checkconnect ドキュメント: [http://api.next-e.jp/param_checkconnect_shop.php](http://api.next-e.jp/param_checkconnect_shop.php) のAPIを利用しようとしているのですが、弊社ではネットショップの運営をしていないため、動作確認に使用できる店舗がありません。 接続確認APIの動作チェックに使用できるデモ環境はありますか？ もしくは他の代替手段がありますか？ --- ## 回答 (2件) ### hamee_sys — 2017/02/15 接続確認APIの動作チェックに使用できるデモ環境については、ネクストエンジンとして のご用意はありません。 アプリ開発者様ご自身でネクストエンジン対応モール・カートからテスト用のアカウント を取得いただき、接続確認をお願いいたします。 無料体験可能なモール・カート（現在でしたらMakeshopやEC-Cubeなど）もございます のでご検討ください。 ネクストエンジン対応モール・カート一覧 [http://next-engine.net/rstock_manageable_systems](http://next-engine.net/rstock_manageable_systems) ### れこ（質問者） — 2017/02/16 > 無料体験可能なモール・カート（現在でしたらMakeshopやEC-Cubeなど）もございます > のでご検討ください。 ありがとうございます。該当のモール・カートを詳しく調べてみます。 --- # APIサーバーへの接続タイムアウトについて URL: https://developer.next-engine.com/questions/581/ **投稿者:** SYS平　**日時:** 2017/09/11 **カテゴリ:** 開発環境・SDKについて 伝票情報取得・更新機能のバッチ開発を行っていますが、 準備段階として、下記を行うWEBサイトを開発しています。（JAVAのSDK使用） 　（１）NEログイン 　（２）トークン取得 　（３）トークンをDB登録 Windows7 の開発用PC上に eclipse で Tomcat7 のサーバーを立てて開発しており、 アプリは localhost で申請しています。 （１）の neLogin() 後、リダイレクトURIで戻ってから再度（２）で neLogin() をしていますが、 （２）の AuthApi() の post() で接続タイムアウトになってしまいます。 [https://api.next-engine.org](https://api.next-engine.org) への接続ができないようなのですが、 ２回 neLogin() を呼ぶ、など、使い方が間違っているのでしょうか。 あるいは、開発PC上の環境設定の問題なのでしょうか。 （IE に直接 [https://api.next-engine.org/api_neauth/](https://api.next-engine.org/api_neauth/) だとレスポンスがあります。） ご教示いただきたく、宜しくお願い致します。 --- ## 回答 (1件) ### SYS平（質問者） — 2017/09/11 引き続き試行錯誤したところ、 post() の中で改めてプロキシ設定をすると、接続できるようになりました。 プロキシに関しては、特別何もしなければ IE の設定内容がそのまま使用されると認識していたのですが・・・。 疑問は残りますが、とりあえず動くようになりました。 --- # access_token取得でエラー URL: https://developer.next-engine.com/questions/582/ **投稿者:** ロン　**日時:** 2017/09/11 **カテゴリ:** ネクストエンジンAPIについて uidとstatus取得後、アクセストークンを 取得しに行きましたが、「こちらからログインしてください」の画面がもどってきます。 開発ガイドに記載されているように設定したつもりですが 1 リクエストURL:[https://base.next-engine.org/api_neauth](https://base.next-engine.org/api_neauth) 2 入力パラメータ：uid=f03738902525e4618735f71.....&state=rmtPUuMAzY......... 不足 している項目、あるいは不備等をお教えください。 よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/09/21 回答が遅くなり申し訳ございません。 ただいま確認中ですので、お手数ですが今しばらくお待ちください ### hamee_sys — 2017/09/21 「NEログインaccess_token取得」のAPIを呼び出す際に、リクエストURLのホスト名をもう一度ご確認ください。 access_token取得時に「base」ではなく「api」のサブドメインを使用する必要がございます。 （正） [https://api.next-engine.org/api_neauth](https://api.next-engine.org/api_neauth) （誤） [https://base.next-engine.org/api_neauth](https://base.next-engine.org/api_neauth) 詳しくは「NEログインaccess_token取得」のAPIリファレンスをご覧ください： [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) --- # アプリ環境のDB構築について URL: https://developer.next-engine.com/questions/583/ **投稿者:** たなたな　**日時:** 2017/09/11 **カテゴリ:** 開発環境・SDKについて [https://developer.next-engine.com/tutorial/sample-fuelphp/download](https://developer.next-engine.com/tutorial/sample-fuelphp/download) 上記でDLしたアプリ開発基盤にてFuelPHPにて開発を進めております。 ①上記環境で構築した場合、DBの構築は必須でしょうか。 ②必須の場合、DBに作成される各テーブルごとのデータ量は、下記認識で問題ございませんでしょうか。 　USERSテーブル：ログインしたユーザ毎に1レコード作成される 　COMPANIESテーブル：ログインした企業ごとに1レコード作成される --- ## 回答 (6件) ### hamee_sys — 2017/09/12 ① PHP SDKには必要なテーブルやコラム、インデックスなどを構築するためのマイグレーションファイルが同梱されておりますが、DBインスタンスそのものを構築するロジックは含まれておりませんので、開発者が手動でDBサーバーを構築する必要がございます。構築後に「fuel/app/config/development/db.php」に接続設定をご記入の上、「fuel/packages/base/migrations」下のマイグレーションファイルを下記コマンドで実行できます。 php oil r migrate --packages=base ② ログインをしようとしているユーザーのuidに紐づくusersレコードが存在しない場合は、新規usersレコードが作成されます。同じく、ログインしたユーザーが所属する企業の「company_ne_id」と「company_id」に紐づくcompaniesレコードがなければ、新規companiesレコードが作成されます。 詳しくは「fuel/packages/base/classes/controller/auth.php」の「get_callback」メソッドをご覧ください。 ### たなたな（質問者） — 2017/09/13 ご回答ありがとうございます。 アプリをネクストエンジンに公開する際も、外部にDB環境を用意する必要があるということでしょうか。 （ネクストエンジン内にはDB環境の用意されない） その場合、ＤＢのスペックを考慮しなければならないのですが、 Usersテーブル、Companiesテーブル、それぞれ利用ユーザ数×1レコードを見込んでおけばよいでしょうか。 以上、ご確認のほどよろしくお願いします。 ### hamee_sys — 2017/09/22 回答が遅れてしまい、申し訳ございません。 ただいま確認中ですので、恐れ入りますが今しばらくお待ちください。 ### hamee_sys — 2017/09/22 はい、ご認識の通り、ネクストエンジン内にはDB環境が用意されないため、開発者側で用意する必要がございます。 usersテーブルに関しては、利用ユーザ数×1レコードという想定で問題ございません。 一方、一つのcompanyに複数userが所属する可能性があるため、企業数と利用ユーザ数が必ずしも一致するとは限りません。 宜しくお願い致します ### 佐々木　崇 — 2017/10/10 同PHP環境で生成されるテーブル、 companies users ですが、テーブル名を任意のものに変更することは可能でしょうか。 既存のテーブル名と似た名前のため可能であれば変更したいのですが、 だめならDBを変更するしかないかな、と。 よろしくお願いいたします。 ### hamee_sys — 2017/10/11 テーブル名を任意に変更することは可能ではございますが、動作保証は致しかねますのでご了承下さい。 --- # access_token取得について URL: https://developer.next-engine.com/questions/584/ **投稿者:** ロン　**日時:** 2017/09/12 **カテゴリ:** ネクストエンジンAPIについて uidとstateを取得後、access_tokenを取得にいくと 「こちらからログインしてください」の画面情報がレスポンスされて tokenを取得することができません。 このような場合は設定すべき項目の何が不足しているのか お教えください。よろしくお願いいたします。 --- ## 回答 (8件) ### hamee_sys — 2017/09/13 uidとstateをAPI取得後、アプリを起動したユーザーが未ログイン状態の場合ログイン画面が表示されます。 ログイン後のredirect_uri先のページでtokenを取得する流れになります。 詳細はAPIリファレンスをご覧ください。 [https://developer.next-engine.com/api/param/uid_state](https://developer.next-engine.com/api/param/uid_state) ### ロン（質問者） — 2017/09/13 ご回答ありがとうございます。 uidとstateを取得する際に、ログインしております。 ただ、アプリで自動的にIDとパスワードをセット後 自動的に「ログイン」ボタンを押しています。 このような場合、未ログインとなるのでしょうか ### hamee_sys — 2017/09/15 tokenを取得するには、ネクストエンジンのログイン完了後になります。 取得のための処理の流れは以下の通りになります。 1.uid、stateを取得 2.未ログインの状態の場合、ネクストエンジンログイン画面表示 → 3へ ログインされている場合はredirect_uri先のページに遷移 → 4へ　 3.ネクストエンジンログイン画面で認証 認証OKの場合 redirect_uri先のページに遷移 → 4へ 4.redirect_uri先のページでaccess_tokenを取得 access_tokenはuid、stateを取得後すぐに行うのではなく、redirect_uri先のgetパラメータでuid、stateを取得後、APIやSDKを利用してaccess_tokenを取得します。 ### ロン（質問者） — 2017/09/16 たびたびの質問で申し訳ありません。 Webサーバがいないクラウド上のアプリから IEを起動して、ログインし、 別のWEBサーバ（redirect_uri）上のphpで uidとstatusを取得しています。その後、access_tokenを 取得しに行ってもログイン画面が出てきます。 ログイン画面がでるということは、何がいけないのでしょうか よろしくお願いいたします。 ### ロン（質問者） — 2017/09/18 302 Found Cache-Control: no-cache Content-Type: text/html・・・・・・・Location: [https://base.next-engine.org/users/sign_in/](https://base.next-engine.org/users/sign_in/) のエラーが戻ってきます。どのような原因が考えられますでしょうか？ ### hamee_sys — 2017/09/19 uid・state取得APIでuid・state取得後アプリを起動したユーザがネクストエンジンにログインされていないとログイン画面が表示されます。 その場合はログイン画面でログイン後、redirect_uriのページでaccess_tokenを取得することができます。 以下の点について確認させてください。 ・"Webサーバがいないクラウド上のアプリからIEを起動して、ログインし" というのはとは具体的にはどのようなログインを行なっているのでしょうか？ ・ログイン画面が表示された後に表示されたログイン画面でログインした場合はredirect_uriのページでaccess_tokenを取得することは出来ますでしょうか？ ### ロン（質問者） — 2017/09/19 ご回答ありがとうございます。 ＞Webサーバがいないクラウド上のアプリからIEを起動して、ログインし は、当方のWindowsアプリから、IEを起動し、ログイン画面 （[https://base.next-engine.org/users/sign_in](https://base.next-engine.org/users/sign_in)）へナビゲートすると ネクストエンジン様のログイン画面が表示されます。 この画面にIDとパスワードをセットし、「ログイン」ボタンを押下させると redirecr_uriで指定した、当方のWEBサーバ（アプリサーバとは別サーバです）に uidとstateが返却されます。 これを用いてaccess_tokenをWinアプリから取得しに行くのですが 毎回ログイン画面情報が戻ってきます。 access_tokenを取得しにいっているので、画面上にログイン画面が 表示されるのではなく、レスポンスとしてログイン画面情報が戻ってきておりますので、 ここで、ログインすることはできないです。 何かわかることがあればお教えください。 ### hamee_sys — 2017/09/20 uidとstateですがstateは有効期限(5分)があり、永続的に使用することは出来ません。 ネクストエンジンログイン後、Winアプリからではなくredirecr_uriで指定したWEBサーバ上でuid・state取得後、直ぐにaccess_tokenを取得するようにしてください。 その後は取得したaccess_tokenを利用してWinアプリ上からAPIを実行する流れになるかと思います。 なお、access_token、refresh_tokenにも有効期限(access_token:1日、refresh_token:3日)があります。 各APIのレスポンス値に最新のaccess_token、refresh_tokenが返却されるので、それを常に保持することにより永続的に使用することが可能となります。 --- # アプリのテスト環境について URL: https://developer.next-engine.com/questions/585/ **投稿者:** たなたな　**日時:** 2017/09/12 **カテゴリ:** 開発環境・SDKについて 現在、ローカル環境にてネクストエンジンアプリ開発を行っております。 実際にネクストエンジンのサーバ上に公開された状態で動作テストを行いたいのですが、 そういったテスト環境のようなものはございますでしょうか。 --- ## 回答 (4件) ### hamee_sys — 2017/09/13 恐れ入りますが、他ユーザーが購入できる一般公開されているアプリは、規則として本番環境に接続する必要がございます。 ### たなたな（質問者） — 2017/09/13 ご回答ありがとうございます。 念のための確認ですが、アプリに関しては下記の認識で相違ございませんか。 ・開発環境 　→開発者のローカル環境 ・ネクストエンジンサーバ内の環境 　→本番環境のみ 　→テスト環境は無い また、開発者同士で共有の環境を用意する場合は、 それぞれローカル環境を構築する必要があるのでしょうか。 ### hamee_sys — 2017/09/22 回答が遅れてしまい、申し訳ございません。 ただいま確認中ですので、今しばらくお待ちください。 ### hamee_sys — 2017/09/22 当方の説明が不足しており、申し訳ございません。 ネクストエンジンは、アプリの稼働するサーバを開発者に提供致しません。 アプリをWeb上で公開するためのWebサーバは、動作環境（開発/検証/本番）に関わらず、開発者が用意する必要がございます。 そのため、開発者同士で共有の環境を用意する場合は、以下のどちらかが必要になると考えております。 ① それぞれのローカル環境を構築する ② それぞれの開発者がアクセスできるWebサーバ上でテストアプリを公開する 宜しくお願い致します --- # アプリログの確認方法について URL: https://developer.next-engine.com/questions/586/ **投稿者:** たなたな　**日時:** 2017/09/12 **カテゴリ:** 開発環境・SDKについて アプリのログファイルの確認などを行いたいのですが、 一度公開されたアプリのソースを確認する手段はございますでしょうか。（外部からSSH接続する等） --- ## 回答 (1件) ### hamee_sys — 2017/09/15 申し訳ございませんが、Next EngineのAPIサーバーに配置されているログファイルを開発者向けに公開しておりません。 用途によって、アプリのWebサーバーまたはご利用の開発フレームワークのログからAPIリクエストに関する有用な情報を取得することができます。公式サンプルアプリではFuelPHPを使っており、ログファイルの配置場所を自由に設定できます。 FuelPHPのLogクラスについて： [http://fuelphp.jp/docs/1.7/classes/log.html](http://fuelphp.jp/docs/1.7/classes/log.html) --- # 「受注明細検索」APIによる同梱受注の検索について URL: https://developer.next-engine.com/questions/587/ **投稿者:** 沼尻　淳　**日時:** 2017/09/13 **カテゴリ:** ネクストエンジンAPIについて 同梱受注の検索について質問がありますので回答願います。 受注情報の商品名、単価、数量等の情報が必要で以下の「受注明細検索」APIを利用し明細を取得しています。 /api_v1_receiveorder_row/search しかし、同梱処理を行った受注の親受注の「受注番号（receive_order_row_shop_cut_form_id）」で検索したところ、親受注の明細の み取得でき、子受注の明細は取得できませんでした。 親受注の受注番号による検索で子受注の明細を取得したいと考えています。 ネクストエンジンAPIで同梱の親受注を指定し、子受注の明細を取得するには、 どのようにしたらいいのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2017/09/19 「受注明細検索」APIをご利用の場合は、親受注の伝票番号（receive_order_row_receive_order_id）を「-eq」の演算子で検索すれば、同梱受注の明細情報を取得することができます。 例）receive_order_row_receive_order_id-eq=123456 --- # 在庫連動の署名コードに関しての質問 URL: https://developer.next-engine.com/questions/589/ **投稿者:** ひろ　**日時:** 2017/09/14 **カテゴリ:** ネクストエンジンAPIについて 「在庫連携API仕様書.pdf」を元にして、在庫連動機能をEC-CUBE上にて作成しております。 「在庫連携API仕様書.pdf」のP6において、「署名コード」の説明で、 認証キーを「リクエスト パラメータの末尾に結合した文字列」との記載がありますが、 実際はどういった文字列の連結になるのでしょうか？ PDF記載の例ですと、 リクエストパラメータの連結は、 「strapya364-abc1020120211300832」 となりますでしょうか？ 宜しくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2017/09/21 回答遅くなりまして申し訳ございません。 確認いたしますので今しばらくお待ちください。 ### ひろ（質問者） — 2017/09/21 運営の方より返答いただいておりました。 ここのコミュニティではなかったようです。 --- # アプリの解約通知について URL: https://developer.next-engine.com/questions/59/ **投稿者:** Hank Ehly　**日時:** 2017/02/15 **カテゴリ:** ネクストエンジンAPIについて ユーザがアプリを解約した場合、どのapiを利用して取得することが出来ますか？ --- ## 回答 (1件) ### hamee_sys — 2017/02/22 現在、解約したユーザーを直接取得することができません。 ただし「/api_app/company」の結果を定期的に確認することによって、調べることができます。 購入停止ボタンを押し「解約予定」とされた企業も月末まで「利用中企業」と認識されるため、「/api_app/company」の結果に含まれてしまいます。そのため、確認は月に一回で十分です。 毎月初日に「/api_app/company」の結果を取得し、前の月との差分を比較することによって、企業の解約状況が分かります。詳細については「[http://api.next-e.jp/param_app_company.php](http://api.next-e.jp/param_app_company.php)」をご覧ください。 そして、ユーザーがアプリの利用停止ボタンを押した時点で、アプリ開発者向けに以下の内容がメールで通知されます。（[ ]内は動的に変更） 利用停止を押した日に通知であって、利用停止したことを通知するわけではないのですが、アプリ開発者が事前に利用停止しようとしているユーザーを知ることはできます。 通知先はアプリ作成時に登録するメールアドレスです。 ``` Subject 【ネクストエンジン】アプリ利用停止のお知らせ Body アプリが利用停止になりました。 以下の利用停止理由をご確認下さい。 ■□━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━□■ 　　　　　　　　　アプリ利用停止理由 ■□━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━□■ 企業ID： [企業ID] 企業名： [企業名] ログインユーザー： [ユーザー名] アプリ名: [アプリ名] 利用停止理由: [アプリ利用停止理由] ``` --- # アプリのタイムアウト時間について URL: https://developer.next-engine.com/questions/592/ **投稿者:** J　**日時:** 2017/09/14 **カテゴリ:** ネクストエンジンAPIについて 現在、ネクストエンジンアプリ開発を行っております。 受注データの更新を以下APIを使用して大量（100件以上）に行う処理を開発しておりますが、 アプリにてネクストエンジンへAPI通信を行う場合、最大タイムアウト時間はどのくらいでしょうか？ ローカル環境にてphp.iniのmax_execution_timeの設定を変更済みですが、60秒で504タイムアウトエラーとなってしまいました。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) --- ## 回答 (4件) ### hamee_sys — 2017/09/21 回答が遅くなり、申し訳ございませんでした。 ただいま確認しておりますので、今しばらくお待ちください。 ### hamee_sys — 2017/09/21 申し訳ございませんが、タイムアウトの原因がはっきりしないため、以下の2点をご確認頂けないでしょうか？ 1) 処理件数を減らして実行した場合は、エラーが発生しますか？ 発生する場合は、どのようなエラーが発生しますでしょうか？ 2) アプリの稼働するサーバーからネクストエンジンへプロキシなどを経由してアクセスしているのでしょうか？ もしそうでしたら、プロキシサーバによるタイムアウトなど、504エラーが発生する可能性が他に存在しますでしょうか。 お手数をお掛けしますが、宜しくお願い致します ### たなたな — 2017/09/26 ご確認いただき、ありがとうございます。 また、返信が遅くなり申し訳ございません。 本件、私のほうで代理で返信させて頂きます。 >1) 処理件数を減らして実行した場合は、エラーが発生しますか？ >発生する場合は、どのようなエラーが発生しますでしょうか？ 更新処理が20件くらいまではエラー無く実行されます。 >2) アプリの稼働するサーバーからネクストエンジンへプロキシなどを経由してアクセスしているのでしょうか？ >もしそうでしたら、プロキシサーバによるタイムアウトなど、504エラーが発生する可能性が他に存在しますでしょうか。 現在ローカル環境で開発しているため、プロキシなどの経由はございません。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) 処理概要としては、上記、受注伝票受注伝票更新APIをデータ件数分投げている状態です（100件なら100回APIを投げている） その他不足している情報などございましたら、ご連絡ください。 以上、ご確認のほど、よろしくお願いします。 ### hamee_sys — 2017/09/26 ご回答頂き、ありがとうございます。 > 更新処理が20件くらいまではエラー無く実行されます。 20件くらいで必ずエラーになってしまうのでしょうか？ また、発生するエラーのエラーメッセージを確認したいのですが、メッセージの内容をできるだけ詳しく教えて頂けないでしょうか？ 宜しくお願い致します --- # offsetとlimitについて URL: https://developer.next-engine.com/questions/593/ **投稿者:** shintaro　**日時:** 2017/09/15 **カテゴリ:** ネクストエンジンAPIについて 在庫マスタAPI offset :0 limit:10000 →正常終了 offset :10000 limit:20000 →004002エラー limitに上限値などあるのでしょうか？ ご確認よろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2017/09/21 回答遅くなり申し訳ございません。 確認いたしますので今しばらくお待ちください。 ### hamee_sys — 2017/09/21 お待たせいたしました。 limitの上限値は10000になります。 上限値以上の場合、エラーが発生致します。 --- # 自動ログインについて URL: https://developer.next-engine.com/questions/594/ **投稿者:** hoka　**日時:** 2017/09/20 **カテゴリ:** ネクストエンジンAPIについて C#、PHPでWEBアプリの開発を行っております。 初回からログイン画面を開かずに、アクセストークン取得する方法はありませんか？ ID、ﾊﾟｽﾜｰﾄﾞを送ったら、ログインできるような仕組みはないのでしょうか？ 以上、よろしくお願いいたします。 --- ## 回答 (4件) ### hamee_sys — 2017/09/20 申し訳ございませんが、本APIはWebアプリケーションを想定した仕組みのため、初回は必ずログイン画面にてネクストエンジンIDとパスワードでの認証が必要になります。 詳しくはFAQをご覧ください [https://developer.next-engine.com/faq](https://developer.next-engine.com/faq) ### hoka（質問者） — 2017/09/20 分かりました。ご回答ありがとうございます。 追加で質問なのですが、 アクセストークンが有効期限切れで、リフレッシュトークンも有効期限切れの場合、 アクセストークンの再取得が必要かと思いますが、これも、手動でしかできないのでしょうか？ ### hamee_sys — 2017/09/21 はい、ご認識の通りです。 手元のアクセストークンとリフレッシュトークンのどちらも有効期限切れの場合は、ログイン画面での再認証が必要です。 一方、アクセストークンをバッチ処理で定期的に更新することで、IDとパスワードを取得せずに有効期限を延ばすことが可能です。 詳しくは「アクセストークンのリフレッシュバッチ」をご覧ください： [https://developer.next-engine.com/tutorial/sample-fuelphp/api-refresh](https://developer.next-engine.com/tutorial/sample-fuelphp/api-refresh) ### hoka（質問者） — 2017/09/21 アクセストークン初回取得の場合と、アクセストークンとリフレッシュトークンが有効期限切れの場合は、 ログイン画面で再取得する必要があるのですね。 ご回答、ありがとうございました。 --- # 同じアプリを使用する複数ユーザーにそれぞれaccess_tokenを割り振る方法 URL: https://developer.next-engine.com/questions/595/ **投稿者:** SYS平　**日時:** 2017/09/21 **カテゴリ:** ネクストエンジンAPIについて 自社で使用するAPIアプリ（バッチ）を並行稼働させたいため、 複数ユーザーでそれぞれにaccess_tokenを取得しようとしています。 アプリで「/users/sign_in/」を呼び出すのですが、 最初のユーザーがログインして以降は呼び出してもログイン画面が表示されないため、 目的を果たすことができずにいます。 複数ユーザーで同じアプリに対してそれぞれ別のaccess_tokenを取得するのは そもそも無理なのでしょうか。 --- ## 回答 (8件) ### hamee_sys — 2017/09/22 別ユーザーであれば、同じアプリでもaccess_tokenは別になります。 「/users/sign_in/」で取得するuid,stateはアプリを起動したユーザーのuid,stateになる為、access_tokenはアプリを起動したユーザー用になります。 以下確認させてください。 >最初のユーザーがログインして以降は呼び出してもログイン画面が表示されない →具体的にどのような操作でアプリを起動されているのでしょうか？ ### SYS平（質問者） — 2017/09/22 ご回答ありがとうございます。 アプリはユーザー一覧とログイン用ボタンを表示したWEB画面からスタートするのですが、 JAVAで開発しているため、SDKの公開ソースを参考にさせていただいています。 ボタンを押す度に「new NeApiClient(・・・)」でインスタンスを生成し、 「neLogin()」を実行しています。 「/users/sign_in/」の入力パラメータにはログインIDが無いので、 どうやってユーザーを判断するのか疑問ではあったのですが・・・。 ### hamee_sys — 2017/09/22 ネクストエンジン本体のログイン情報でユーザーを識別します。 「/users/sign_in/」実行後ネクストエンジンにログインされていない端末の場合、ネクストエンジンのログイン画面が表示されます。 ### SYS平（質問者） — 2017/09/22 >ネクストエンジンにログインされていない端末の場合、ネクストエンジンのログイン画面が表示されます。 → 複数ユーザー分のaccess_tokenを取得するためには 別々の端末から異なるユーザーIDでログインしなければならないということですね。 では、そのようにして取得した複数ユーザー分のaccess_tokenを並行稼働のバッチで使用する場合ですが、 1台のPC上で動いても問題ないのでしょうか。 ### hamee_sys — 2017/09/22 >複数ユーザー分のaccess_tokenを取得するためには >別々の端末から異なるユーザーIDでログインしなければならないということですね。 →はい、その通りです。または、同じ端末で取得する場合は一旦ログアウトして別ユーザーでログインする必要があります。 >では、そのようにして取得した複数ユーザー分のaccess_tokenを並行稼働のバッチで使用する場合ですが、 >1台のPC上で動いても問題ないのでしょうか。 →バッチプログラムを稼働するPCは1台でも問題ないです。 ### SYS平（質問者） — 2017/09/22 >同じ端末で取得する場合は一旦ログアウトして別ユーザーでログインする必要があります。 → この「ログアウト」とは、ネクストエンジンのログアウトでしょうか？ APIでログアウトはできますか？ ### hamee_sys — 2017/09/22 「ログアウト」とはネクストエンジンのログアウトになります。 APIでログアウトすることは出来ません。 ### SYS平（質問者） — 2017/09/22 access_tokenの取得はバッチの本番稼働前に実施し、 その後は周期的にAPIでリフレッシュする計画ですので、 最初の取得時は一旦ログアウトする手順にしようと思います。 ご教示ありがとうございました。 --- # 受注確認内容設定について URL: https://developer.next-engine.com/questions/597/ **投稿者:** コモック青木　**日時:** 2017/09/27 **カテゴリ:** その他 お世話になります。 受注確認内容設定に代金引換で自由に金額を設定できる項目があればと考えています。 現在ある項目としては「総合計で金額いくら」と「代金引換で30万以上」のみです。 受注確認内容設定へはAPIを使って開発し、項目を追加できるのでしょうか？ もし可能ならどのようにすればよろしいでしょうか？ 情報をお持ちでしたら、教えて頂けますと幸いです。 聞くだけになってしまい、申し訳ございません。 どうぞよろしくお願いします。 --- ## 回答 (2件) ### hamee_sys — 2017/09/27 申し訳ございませんが、ネクストエンジンでは受注確認内容設定項目を追加することはサポートされておりません。しかし、受注伝票検索APIで受注伝票の支払方法と総合計を簡単に取得することができます。 ある伝票の支払方法が「代金引換」で総合計が一定の金額を超えているかどうかを特定するために、以下の”フィールド"を付与したリクエストを受注伝票検索APIに送信してください。 receive_order_payment_method_id（ 支払方法：“1” の場合は代金引換 ） receive_order_total_amount（総合計） 受注確認内容設定は、出荷前に内容確認が必要な受注伝票を[確認待ち]ステータスに止めることが目的です。出荷確定処理を進める前に上記チェックを行えば、機能的に受注確認内容設定と同じようなことができるのではないかと思います。 受注伝票検索： [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) ### コモック青木（質問者） — 2017/09/27 返信ありがとうございます。 了解しました。 繁忙期が終わるまでは、出来るだけ現在の機能をうまく使い、工夫して運用してみます。 --- # アプリの設定・審査について URL: https://developer.next-engine.com/questions/598/ **投稿者:** hoka　**日時:** 2017/09/28 **カテゴリ:** ネクストエンジンAPIについて アクセストークン・リフレッシュトークンを取得するためだけのアプリを作成しています。 （初回のみこのアプリを使用してアクセストークンを取得し、あとはバッチで受注情報取得などを行う予定です） 「本番環境設定」と「テスト環境設定」がありますが、本番のメイン機能に接続するには、 このアクセストークン取得アプリを「本番環境設定」に設定し、審査を受ける必要があるのでしょうか？ （このアプリは、他ユーザへの公開はしません。） また、WEBサーバは、localhost以外でもSSLが入ったLAN内サーバで問題ないでしょうか？ --- ## 回答 (4件) ### hamee_sys — 2017/09/28 申し訳ございませんが、本番環境の「クライアントID」と「クライアントシークレット」はアプリの公開後（販売中）に初めてご利用可能となるため、審査を受ける必要がございます。 アプリのWEBサーバに関しては、ネクストエンジンのAPIサーバとの間でHTTPS通信さえできれば、ローカルネットワークの構成やWEBサーバへのアクセス権をご自由に設定できる認識です。 ### hoka（質問者） — 2017/09/28 >　申し訳ございませんが、本番環境の「クライアントID」と「クライアントシークレット」はアプリの公開後（販売中）に初めてご利用可能となるため、審査を受ける必要がございます。 アプリから本番のメイン機能に接続するには、審査を受ける必要があるという認識でよろしいですか？ 「テスト環境設定」のクライアントIDとクライアントシークレットでは、テストのメイン機能にしか接続できないということでしょうか？ >　アプリのWEBサーバに関しては、ネクストエンジンのAPIサーバとの間でHTTPS通信さえできれば、ローカルネットワークの構成やWEBサーバへのアクセス権をご自由に設定できる認識です。 こちらの件は、了解しました。ご回答ありがとうございます。 ### hamee_sys — 2017/09/28 説明が不足しており、申し訳ございませんでした。 > アプリから本番のメイン機能に接続するには、審査を受ける必要があるという認識でよろしいですか？ はい、アプリから本番環境のメイン機能に接続するために審査を受ける必要がございます。 > 「テスト環境設定」のクライアントIDとクライアントシークレットでは、テストのメイン機能にしか接続できないということでしょうか？ はい、テスト環境設定の「クライアントID」と「クライアントシークレット」はテストのメイン機能にしか接続できません。同じく本番環境設定の「クライアントID」と「クライアントシークレット」は本番のメイン機能にしか接続できません。 宜しくお願い致します ### hoka（質問者） — 2017/09/28 詳しくご説明いただき、ありがとうございます。 本番のメイン機能に接続するには、審査を受ける必要があり、 また、本番かテストかは、クライアントIDとクライアントシークレットで判断されるということですね。 ご回答ありがとうございました。 --- # 汎用店舗の在庫更新用URLについて URL: https://developer.next-engine.com/questions/599/ **投稿者:** yskysmr　**日時:** 2017/10/02 **カテゴリ:** その他 汎用店舗での「在庫更新用URL」の設定例として、以下のように説明されていますが、 http://ストア様ドメイン名/UpdateStock.php URL は必ず ”実行するファイル名” でなければいけないでしょうか。 例えば、サイトトップの URL として、 http://ストア様ドメイン名/ と指定してもよいのでしょうか。 --- ## 回答 (2件) ### hamee_sys — 2017/10/02 在庫更新用URLのファイル名や拡張子に指定はありませんが、 「http://ストア様ドメイン名/」はディレクトリを指すため、 "実行するファイル”を呼び出すリダイレクト処理が必要な場合があります。 ### yskysmr（質問者） — 2017/10/03 ご回答ありがとうございます。 参考にさせていただきます。 --- # アップロードキューのエラーについて URL: https://developer.next-engine.com/questions/60/ **投稿者:** 栗林憲一　**日時:** 2017/02/17 **カテゴリ:** ネクストエンジンAPIについて アップロードキューの検索api(/api_v1_system_que/search)でエラー処理について que_status_id=-1の場合、処理失敗（失敗あり/全て失敗）になりますが、複数行エラーがある場合 以下、どのパターンで処理されますか？ 　・最初に見つかったエラーのみ返す、すべてのデータは更新されない。 　・最初に見つかったエラーのみ返す。最初に見つかったエラーの1件前までデータは更新。エラー後のデータは更新されない。 　・最初に見つかったエラーのみ返す。正常のデータは全て更新される。 　・全てのエラーを表示、エラーが1件でもあった場合はすべてのデータは更新されない。 　・全てのエラーを表示、正常のデータは全て更新される。 　・その他 --- ## 回答 (1件) ### hamee_sys — 2017/02/27 現在提供しているAPIでアップロードキューの検索api(/api_v1_system_que/search)に対応しているのは以下のapiになります。 1)商品マスタ予約一括登録（/api_v1_master_goods/upload） 2)受注一括登録（/api_v1_receiveorder_base/upload） 1)については「・全てのエラーを表示、エラーが1件でもあった場合はすべてのデータは更新されない。」のパターンになります。 2)についてはショップによって処理が変わります。ご確認されたいショップを教えて頂きましら個別に調査しご回答差し上げます。 --- # [受注検索]受注ステータスについて URL: https://developer.next-engine.com/questions/600/ **投稿者:** yuya-saito　**日時:** 2017/10/10 **カテゴリ:** ネクストエンジンAPIについて [受注伝票検索]APIなどで「管理画面→受注伝票管理TOPのステータス？」 [新規受付][確認待ち]...などの状態を特定するフィールド等はございますでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2017/10/10 受注状態区分:receive_order_order_status_id、受注状態名称:receive_order_order_status_nameで取得する事が可能です。 以下APIリファレンスの[受注伝票検索]APIのフィールド一覧タブでご確認いただけます。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/search](https://developer.next-engine.com/api/api_v1_receiveorder_base/search) ### yuya-saito（質問者） — 2017/10/10 ご回答ありがとうございます。 受注伝票更新から[receive_order_gruoping_tag]を更新しようとしたところ 「受注状態がメール取込済のため更新できません」とエラーが返ってきたのですが どのような現象でしょうか？ 更新可能な受注状態は限定されているのでしょうか？ お手数ですがご確認のほどよろしくお願い致します。 ### hamee_sys — 2017/10/10 受注状態区分が「1 : 受注メール取込済」の伝票に対して更新を行なった場合に発生するエラーになります。 「1 : 受注メール取込済」は受注メールの情報をもとに作成された段階の受注伝票で、一部情報が欠如している状態になります。 受注状態区分が「1 : 受注メール取込済」の場合　受注キャンセル区分、作業用欄のみ更新可能となります。 以下受注伝票受注伝票更新APIリファレンスの更新仕様をご確認いただければと思います。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) --- # 同梱自動判定 URL: https://developer.next-engine.com/questions/602/ **投稿者:** FJT　**日時:** 2017/10/10 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンには住所などで同梱自動判定がありますが、 受注伝票の同梱候補伝票番号(receive_order_include_possible_order_id)に反映されると思います。 これ複数あった場合はどのような動きをするのでしょうか? 確定した同梱先伝票番号(receive_order_include_to_order_id)についても同様の考え方なのでしょうか? 数値型であることから、ひとつのみの同梱とは予想しています。 --- ## 回答 (3件) ### hamee_sys — 2017/10/11 確認致しますので、今しばらくお待ちください。 ### hamee_sys — 2017/10/12 お待たせいたしました。 同梱候補伝票番号が複数あった場合は、メイン機能で「同梱候補を検索」を押下したときの１番目の候補が返されます。 同梱先の伝票は複数にまたがることはないので、 確定した同梱先伝票番号は一つのみになります。 ### FJT（質問者） — 2017/10/12 ちなみに同梱先の伝票については、再度 API が必要ですね。 検索などの API の引数に同梱を含めるフラグを加えれば便利かと思います。今後の改善を期待します。 --- # 送り状の変更 URL: https://developer.next-engine.com/questions/605/ **投稿者:** FJT　**日時:** 2017/10/19 **カテゴリ:** ネクストエンジンAPIについて 送り状の変更を一括で行いたいと考えていますが、 API 仕様書を見ると以下の項目があるようです。 「送り状名」receive_order_invoice_id 「送り状区分」receive_order_invoice_name 「区分」なのでマスター化されているのかなと思っているのですが、 両方修正する必要があるのでしょうか? また、どのように修正する必要があるのでしょうか? たとえば「発払い」から「コレクト」に変更する場合はどのようにするのでしょうか? --- ## 回答 (3件) ### hamee_sys — 2017/10/19 確認致しますので、今しばらくお待ちください。 ### hamee_sys — 2017/10/20 お待たせ致しました。 receive_order_invoice_idを更新すればreceive_order_invoice_nameが自動的に更新されますので、両方修正する必要はございません。 実際に(※1)の更新仕様をご覧になりますと、更新可能な項目一覧にはreceive_order_invoice_nameが含まれておりません。 更新方法ですが、受注伝票受注伝票更新APIをご利用ください。具体的に、入力パラメータのdataにreceive_order_invoice_idを更新するためのXMLを作成する必要がございます。詳しくは(※2)のXMLサンプルをご覧ください。 なお、receive_order_invoice_idに指定可能な値を発送方法別区分検索API(※3)にてお調べ頂けます。forwarding_agent_type=okurijyo_kbnという風に送り状のデータだけ返してもらうように絞り込めば、「コレクト」という送り状名に該当する送り状区分(forwarding_agent_type_id)を取得できます。 (※1) APIで指定出来るフィールドの一覧 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update#no...](https://developer.next-engine.com/api/api_v1_receiveorder_base/update#note_base) (※2) XMLサンプル（receive_order_invoice_idの値を2に更新する） ``` 2 ``` (※3) 発送方法別区分検索API [https://developer.next-engine.com/api/api_v1_receiveorder_forwardingagen...](https://developer.next-engine.com/api/api_v1_receiveorder_forwardingagent/search) ### FJT（質問者） — 2017/10/20 詳細なご返答ありがとうございます。疑問点はすべてクリアになりました。 --- # 商品マスタのメール便可否、メール便最大数量はAPIで取得できますか URL: https://developer.next-engine.com/questions/606/ **投稿者:** 山岸　弘基　**日時:** 2017/10/21 **カテゴリ:** ネクストエンジンAPIについて /api_v1_master_goods/search のフィールド一覧には、商品マスタのメール便可否、メール便最大数量が記されていません。 （/api_v1_master_pagebase/search にも。） APIで取得できますでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2017/10/23 --- 質問者様が自己解決しました --- さきほど、投稿させていただきました商品マスタのメール便可否、メール便最大数量のAPI取得、自己解決しました。 メール便可否は、 　メール送信フラグ 　goods_delivery_mail_flag 　数値型 メール便最大数量は、 　メール送信数 　goods_delivery_mail_maximum_quality 　文字列型 が、何故にこういう項目名？ さきの投稿にコメントで自己解決を入れようとしても、現時点では、投稿が見つからないのですが、自分が投稿した一覧を見る方法はありますでしょうか？ ステートが下書きなら見られるのですが、投稿してしまうと、公開されるまで見られないのでしょうか。 ### hamee_sys — 2017/10/23 自己解決をご投稿頂き、ありがとうございます。 おっしゃる通りで、DevNetに投稿される質問は管理者によって公開されるまでコミュニティに反映されません。 --- # 在庫マスタの引当数について URL: https://developer.next-engine.com/questions/608/ **投稿者:** Sugi　**日時:** 2017/10/26 **カテゴリ:** ネクストエンジンAPIについて 在庫マスタ検索のＡＰＩ（/api_v1_master_stock/search）にて、引当数を取得しようと思います。 メイン機能で受注明細情報の数量変更とか受注キャンセルした場合にリアルに更新された引当数が 取得できますか？ --- ## 回答 (1件) ### hamee_sys — 2017/10/26 申し訳ありませんが、引当数などという在庫情報の更新は、フリー在庫数が変動したタイミングで約10分程度の間隔で行われるため、リアルタイムに更新された情報は取得できかねます。 詳しくは以下のFAQをご覧ください [http://manual.next-engine.net/faq/stock/faq-1484/](http://manual.next-engine.net/faq/stock/faq-1484/) --- # 企業情報取得で「002002 access_tokenが不正です」のエラーが出る URL: https://developer.next-engine.com/questions/61/ **投稿者:** れこ　**日時:** 2017/02/20 **カテゴリ:** ネクストエンジンAPIについて 現在ネクストエンジンアプリの認証処理を実装しています。 ネクストエンジンからアプリへリダイレクトし、アクセストークンの取得まではできているのですが、 取得できたアクセストークンを使用して /api_v1_login_company/info のAPIをコールすると 002002 access_token[xxxxx]が不正です。 のエラーが返ってきてしまいます。 アクセストークンはAPIから返却されたものをそのまま使用しており、キャッシュやデータベース等の値は参照しておりません。 何を間違えているか教えて頂けると幸いです。 アプリのIDは69856です。 --- ## 回答 (4件) ### hamee_sys — 2017/02/22 アプリの種類が「ネクストエンジンログインのみのアプリ」が選択されている可能性があります。 メイン機能のデータを利用するアプリを作成する場合は「メイン機能と連携するアプリ」を選択するようにしてください。 一度アプリを登録するとアプリの種類を変えることができないため、お手数ですが再登録を行うようお願いいたします。 アプリの種類についてはこちらをご覧ください。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) ### れこ（質問者） — 2017/02/27 > アプリの種類が「ネクストエンジンログインのみのアプリ」が選択されている可能性があります。 > メイン機能のデータを利用するアプリを作成する場合は「メイン機能と連携するアプリ」を選択するようにしてください。 ご指摘の通りログインのみのアプリになっていました。 メイン機能と連携するアプリのアプリを作って試してみたところ情報が取得できました。 エラーの内容からこの原因は察せませんでした。回答ありがとうございます ログインのみのアプリにした場合、APIを使用して企業情報を取得できないということでしょうか？ 企業情報はメイン機能のデータの何某かを使用しているということですよね？ ### hamee_sys — 2017/02/28 エラーの内容が分かりにくくご不便おかけして申し訳ございません。 企業情報はメイン機能のデータより取得しております。 メイン機能のメニュー「設定」→「基本」→「企業」より企業情報を確認することが出来ます。 ### れこ（質問者） — 2017/02/28 回答ありがとうございました。 --- # APIアクセストークンの更新について URL: https://developer.next-engine.com/questions/611/ **投稿者:** yuya-saito　**日時:** 2017/10/30 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 アクセストークンの期限が切れた際、保持しているリフレッシュトークン が有効期限内であれば再度アクセストークンを取得する仕様だと思うのですが 上記条件内でもアクセストークンが更新されないケースなど ありますでしょうか？ 例えばサーバー負荷による更新エラーなど... その場合はエラーコード002002以外になるのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2017/10/30 以下のメッセージ一覧には、リクエストが失敗する原因と対応するエラーコードが記載されておりますので、ご覧ください。 [https://developer.next-engine.com/api/param/message](https://developer.next-engine.com/api/param/message) 「NEログインaccess_token取得」エンドポイントをご利用の場合は、以下の分類のメッセージが返ってくる可能性がございます。 ・共通 ・AccessToken取得 ・API共通処理(ネクストエンジン) ・API共通処理(メイン機能) ・例外 --- # 商品検索APIの取得結果 URL: https://developer.next-engine.com/questions/612/ **投稿者:** yaoqingmei　**日時:** 2017/11/01 **カテゴリ:** ネクストエンジンAPIについて 商品検索APIは、削除された「削除フラグ＝1」の商品は取得できますか？ --- ## 回答 (7件) ### hamee_sys — 2017/11/01 商品マスタ検索APIでは、削除された商品を取得することは可能です。 「削除フラグ＝1」で絞り込み検索を行うには 入力パラメータに「goods_deleted_flag-eq=1」を追加してください。 詳しくは「商品マスタ検索」のフィールド一覧をご覧ください。 [https://developer.next-engine.com/api/api_v1_master_goods/search](https://developer.next-engine.com/api/api_v1_master_goods/search) ### yaoqingmei（質問者） — 2017/11/01 「goods_deleted_flag-in＝"0,1"」で、削除された商品は取得できないです、 HashMap dataStockCount1 = new HashMap(); dataStockCount1.put("fields", "goods_id,goods_deleted_flag,goods_last_modified_null_safe_date"); dataStockCount1.put("goods_deleted_flag-in", "0,1"); 「goods_deleted_flag-eq=1」で、削除された商品も取得できないです、特別な制限条件はありますか？ dataStockCount1.put("goods_deleted_flag-eq", "1"); ### hamee_sys — 2017/11/01 確認致しますので、少々お待ちください。 ### yaoqingmei（質問者） — 2017/11/02 確認したから、教えてお願いします ### yaoqingmei（質問者） — 2017/11/07 すみませんが、削除された商品の取得については、まだ確認していないですか？ ### hamee_sys — 2017/11/07 大変申し訳ございませんが、削除された商品の取得方法について不明点があるため、確認に時間がかかっております。 誠に恐縮ですが、今しばらくお待ちください。 ### hamee_sys — 2017/11/09 大変お待たせ致しました。 結論から申し上げますと、商品マスタを削除すると物理削除されるため、削除された商品マスタを検索することはできません。 リファレンスの記載だと削除フラグ「goods_deleted_flag」を指定することで削除された商品マスタを検索できるふうに見えますが、 実際のところ、このフィールドはシステム側で利用されておりません。リファレンス上では非表示に致しました。 記載に誤りがあったことは、こちら側の考慮不足でお詫び申し上げます。 宜しくお願い致します --- # 在庫連携 URL: https://developer.next-engine.com/questions/616/ **投稿者:** 君　**日時:** 2017/11/06 **カテゴリ:** ネクストエンジンAPIについて こんにちは 現在ECモールREDとネクストエンジンのapi連携をしようとしています。 ①ネクストエンジン側在庫変動があるときに、REDにリクエスト送ります。 RED側は、こちらで用意したstockupdate.phpでREDの在庫を更新行います。 このときに下記のようにパラメータを送りますよね？ こちらは自動ときに10分おきに下記のようなリクエスト送るって事ですか？ http://ストア様ト?メイン名/UpdateStock.php?StoreAccount=strapya&Code=364-abc &Stock=10&ts=20120211300832&.sig=6e17b3d0a1891 ②正常に処理された場合は、XMLの0が帰ってきたら正常に終了ですよね？ XMLのレスポンスはネクストエンジン側はどう受け取りますか？ ③また、RED側が在庫変動する際、ネクストエンジンに在庫更新のリクエスト送ります。 ネクストエンジンはどう受けて、在庫更新を行いますか？ よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/11/07 > ① はい、ネクストエンジン側から送られるリクエストは「在庫連携 API 仕様書 」の「リクエストするURLの例」と同じ形式のGETリクエストになります。モール・カートへの在庫情報の更新は、ネクストエンジン側で在庫変動があったタイミングで約10分程度の間隔で行われます。 > ② ネクストエンジン側でレスポンスを受け取る際、レスポンスボディーに`0`というXMLタグが返却されているかを確認します。確認ができた場合は正常に終了と判定します。サイトから返すXMLの形式について「在庫連携 API 仕様書 」の「4. 在庫更新のレスポンスについて」をご覧ください。 > ③ 商品マスタアップロードAPIを通じて在庫更新を行うことができます。 APIの使い方についてはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) --- # 店舗作成APIのtest_flagについて URL: https://developer.next-engine.com/questions/62/ **投稿者:** れこ　**日時:** 2017/02/21 **カテゴリ:** ネクストエンジンAPIについて 店舗作成（/api_v1_master_shop/create）について質問です。 [http://api.next-e.jp/param_create_shop.php](http://api.next-e.jp/param_create_shop.php) `test_flag`というパラメータがあり、実際に使用してみるとメイン機能に店舗が作られないことはわかったのですが、このパラメータの用途はなんでしょうか？ 使い方や使った結果は分かったのですが、何のためにこのパラメータがあるか分からなかったので質問しました --- ## 回答 (2件) ### hamee_sys — 2017/02/27 メイン機能は50店舗まで作成可能ですが、一度登録した店舗について削除することが出来ません。 その為、テストで必要のない店舗を作成してしまうとメイン機能で削除をすることが出来ないので管理が煩雑になってしまいます。 test_flag=1で設定すると実際に店舗作成はしないが、APIが正しく呼び出せていることの確認を行うことができます。 また、制限数に達してしまうとそれ以上の店舗を作成することができない為、開発時はtest_flag=1で設定することをお勧めいたします。 もし、店舗数が最大になってしまった場合はこちらをご覧ください。 [http://api.next-e.jp/param_create_shop.php#max_case](http://api.next-e.jp/param_create_shop.php#max_case) ### れこ（質問者） — 2017/02/27 なるほど、店舗をつくりすぎると問題が起きるのですね。ありがとうございました。 --- # C#のログインについて URL: https://developer.next-engine.com/questions/620/ **投稿者:** 磯　孝之　**日時:** 2017/11/14 **カテゴリ:** ネクストエンジンAPIについて ①.NET環境でのバッチ処理でのAPI利用を考えていますが、次の認識で合っていますでしょうか？ 　　(1) アクセストークンとリフレッシュトークンの初回取得にはネクストエンジンIDとパスワードでの認証が必要で、 　　　　そのログインおよびトークン情報の取得・保持をするためのシステムは利用者側で作らなければならない。 　　(2) HTTP通信ができれば、ASP.NETなどの環境でも問題なくログインやトークンの取得はできる。 　　(3) バッチ処理でのAPI利用を考えている場合、アプリ申請の際のリダイレクトｕｒｌはlocalhostでも問題ない。 ②上記①のようなバッチ処理を行う場合、アプリ審査に相当するものは具体的にどのようになりますでしょうか？ --- ## 回答 (3件) ### hamee_sys — 2017/11/14 確認致しますので、しばらくお待ちください。 ### hamee_sys — 2017/11/15 お待たせいたしました。 ①については全てご認識通りです。 審査の内容については弊社サポート窓口まで個別にご相談ください。 ### 磯　孝之（質問者） — 2017/11/15 ご回答ありがとうございます。 審査関連の質問については、早速サポートに連絡してみます。 --- # キューＩＤの有効期間について URL: https://developer.next-engine.com/questions/621/ **投稿者:** 磯　孝之　**日時:** 2017/11/16 **カテゴリ:** ネクストエンジンAPIについて キューIDの保存期間はありますでしょうか？ あるとすれば、どのくらいの期間でしょうか？ --- ## 回答 (2件) ### hamee_sys — 2017/11/16 受注伝票アップロードAPIの出力パラメータ「que_id」の保存期間はありません。 アップロードキュー検索APIなどで過去のキュー情報を参照することが可能です。 ### 磯　孝之（質問者） — 2017/11/16 早々のご回答ありがとうございました。 問題解決いたしました。 --- # 売上返品処理を実装したい URL: https://developer.next-engine.com/questions/624/ **投稿者:** jack　**日時:** 2017/11/21 **カテゴリ:** ネクストエンジンAPIについて アプリに受注伝票のメニューにある「売上返品処理」を実装したいのですが、 「[https://developer.next-engine.com/api](https://developer.next-engine.com/api)」内のどれが「売上返品処理」に当たりますか。 --- ## 回答 (5件) ### hamee_sys — 2017/11/21 ご連絡ありがとうございます。 確認致しますので、今しばらくお待ちください。 ### hamee_sys — 2017/11/21 お待たせ致しました。 返品処理専用のAPIはございませんが、商品マスタアップロードAPI(※1)によって返品処理行うことが可能です。 アップロード用のCSVファイル(※2)に 在庫数の加算/減算値「zaiko_su」で返品数を設定し 入出庫履歴の事由「nyusyukko_riyu」に返品理由を設定してください。 (※1) 商品マスタアップロードのAPIリファレンス [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) (※2) アップロード用のCSVファイルの項目一覧 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) ### jack（質問者） — 2017/11/22 在庫数で返品数を設定とは、１個返品する際は「-1」とすればいいのでしょうか。 それとも「nyusyukko_riyu」により在庫数「1」追加ということでしょうか。 また、受注伝票上対象の商品は返品扱いになるのでしょうか。 よろしくお願いいたします。 ### hamee_sys — 2017/11/22 ただいま確認しておりますので、今しばらくお待ちください。 ### hamee_sys — 2017/11/24 お待たせ致しました。 > 在庫数で返品数を設定とは、１個返品する際は「-1」とすればいいのでしょうか。 > それとも「nyusyukko_riyu」により在庫数「1」追加ということでしょうか。 N個の商品を在庫数に戻す場合は、在庫数の加算になるため正の値「N」を設定してください。 例）4個返品 → zaiko_suに「4」を設定します > また、受注伝票上対象の商品は返品扱いになるのでしょうか。 説明が不足しており、申し訳ございません。 メイン機能の「売上返品処理」を実行する際に、在庫の更新に加えて受注明細のキャンセルや不良返品数の更新など様々な処理が行われますが、APIで実現できるのは「在庫の更新と入出庫理由の記載」のみで、不良返品数の更新や受注明細のキャンセルを行うためのAPIは現在提供しておりません。 よろしくお願い致します --- # 在庫マスタ検索APIに関して URL: https://developer.next-engine.com/questions/625/ **投稿者:** 磯　孝之　**日時:** 2017/11/22 **カテゴリ:** ネクストエンジンAPIについて 在庫マスタ検索APIにおいて、検索条件を指定しない場合は全件取得されるという理解で合っていますでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2017/11/22 はい、その認識で問題ありません。 在庫マスタ検索APIにおいて検索条件を指定しない場合は、全件または”limit”で指定された取得数まで取得します。 ### 磯　孝之（質問者） — 2017/11/22 早々のご回答ありがとうございました。 疑問解消しました。 --- # 受注伝票出荷確定処理APIの複数件数処理について URL: https://developer.next-engine.com/questions/626/ **投稿者:** 磯　孝之　**日時:** 2017/11/24 **カテゴリ:** ネクストエンジンAPIについて 受注伝票出荷確定処理APIにて、出荷確定データを連携しようと考えておりますが、 仕様を見る限り、1件ずつ（1受注ずつ）処理するような形式と見て取れます。 今回、1件ずつではなく、数百件単位で一括で出荷確定処理を行いたいと考えており、 サポートデスクに確認をしたところ、MAX1,000件まで連携できると回答をいただきました。 その一括で処理する方法を教えていただきたいです。 --- ## 回答 (4件) ### hamee_sys — 2017/11/24 メイン機能での操作の場合は、ステータスに応じた受注伝票の一括操作を行えますが、APIでは1伝票ずつの更新になります。 例）[受注] → [受注伝票管理] → ( チェックボックスを複数選択 ) → [この結果に対して実行したい処理を選択] → [出荷確定] ### 磯　孝之（質問者） — 2017/11/27 >メイン機能での操作の場合は、ステータスに応じた受注伝票の一括操作を行えますが、APIでは1伝票ずつの更新になります。 ⇒　現状、楽天RMSに対して、出荷確定データをCSVにてアップロードし、出荷確定しておりますが、 　　そこで必要な項目としては、「楽天受注番号」、「配送会社」、「配送伝票番号（お荷物伝票番号）」、「配送日」を連携しております。 　　今回、出荷確定処理ＡＰＩで出荷確定させるのに、上記の項目として、「楽天受注番号」と「配送日」しかありません。 　　「配送会社」と「配送伝票番号」の項目値連携はどうすればよろしいでしょうか？ 　　別のＡＰＩを使用すればよろしいのでしょうか？それはどれでしょうか？おしえていただけますでしょうか？ ### hamee_sys — 2017/11/28 確認致しますので、今しばらくお待ちください。 ### hamee_sys — 2017/11/28 お待たせ致しました。 > 「配送会社」と「配送伝票番号」の項目値連携はどうすればよろしいでしょうか？ > 別のＡＰＩを使用すればよろしいのでしょうか？それはどれでしょうか？おしえていただけますでしょうか？ 受注伝票受注伝票更新APIで指定可能です。 「配送伝票番号 (お荷物伝票番号)」は発送伝票番号：receive_order_delivery_cut_form_id 「配送会社」は 発送方法区分：receive_order_delivery_id 詳しくは受注伝票受注伝票更新のAPIリファレンスをご覧ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) メイン機能の使い方マニュアルにもRMSと受注APIの連携に関する情報がございますので、リンクを共有致します。 [http://manual.ec-doc.net/startup/rakuten/jyuchu/dd002/](http://manual.ec-doc.net/startup/rakuten/jyuchu/dd002/) --- # FutureShop２受注CSVの取り込み項目について URL: https://developer.next-engine.com/questions/629/ **投稿者:** yuya-saito　**日時:** 2017/11/30 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 管理画面内の受注-受注一括登録にてCSVをアップロードする際、 下記FS2項目の取り込み情報の扱いについて ・入出荷予定日 CSV取り込み後に受注明細画面にて確認したところ 上記の項目を見つけることができませんでした。 この情報はどこに持っているのでしょうか。 お手数ですがご教示頂きたく存じます。 --- ## 回答 (4件) ### hamee_sys — 2017/11/30 ご連絡ありがとうございます。本件は、ネクストエンジンアプリ開発を行う上でのご質問という認識でしょうか？ ### yuya-saito（質問者） — 2017/11/30 そうです。 ### hamee_sys — 2017/11/30 確認致しますので、今しばらくお待ちください。 ### hamee_sys — 2017/12/01 FutureShop２の「入出荷予定日」ですが、ネクストエンジンには取り込みされない項目となります。 ネクストエンジンへの取り込み対象となる項目については、以下をご覧ください。 [http://manual.ec-doc.net/operation/jyuchu/jyuchulist/futureshop2/ee048/](http://manual.ec-doc.net/operation/jyuchu/jyuchulist/futureshop2/ee048/) --- # PHP版SDKのバージョン管理について URL: https://developer.next-engine.com/questions/63/ **投稿者:** れこ　**日時:** 2017/02/21 **カテゴリ:** 開発環境・SDKについて PHP版SDKについて質問です。 SDKはzip経由でしか入手できないのでしょうか？ SDKがアップデートされているか否かが都度DLしてdiffを見ないと分からず、アップデートの管理が面倒です。 SDKがバージョン管理されているリポジトリはありますか？それを公開することはできますか？ もしくは、例えばpackagist.orgに登録し、composer経由でSDKインストールできるようにできないでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2017/02/27 ご意見ありがとうございます。 現状zip形式でのダウンロードのみのご提供となっておりますが、アプリ開発者の皆様がご利用しやすいよう提供方法を前向きに検討させていただきたいと思います。 --- # バッチ処理のみでの情報取得について URL: https://developer.next-engine.com/questions/64/ **投稿者:** 岡田　光弘　**日時:** 2017/02/27 **カテゴリ:** ネクストエンジンAPIについて 現在、バッチ処理(PHP)にて定期的に受注データを取得する機能を作成しようとしております。 ですが、どうしてもaccess_token、refresh_tokenが取れません。 一旦、画面を使用してのログイン結果で取得できたaccess_token（512byte）、refresh_token(512byte)を指定して バッチ処理を実行すると 　API通信でエラーが発生しました。以下詳細
code:002002
message: access_token[*********]が不正です。 　　※[*********]にはaccess_token（512byte）が表示されています。 とエラーとなってしまいます。 何か手順として間違っているのか、ご教授願えますでしょうか。 --- ## 回答 (1件) ### 岡田　光弘（質問者） — 2017/02/27 自己解決できました。 access_tokenが、作成していたログイン後の処理使用上、３件分纏まっておりました。 １件分で取得して使用したところ、バッチ処理で受注データの取得が行えました。 --- # 在庫の入出庫API URL: https://developer.next-engine.com/questions/645/ **投稿者:** colony　**日時:** 2017/12/07 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 現在差配業務を効率化するシステムをAPIを使って開発しようとしています。 受注データの取得等はできたのですが、 在庫の増減（入出庫）を登録するにはどのAPIを使用するのでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2017/12/07 在庫の増減/加減を行うAPIは商品マスタアップロード(エンドポイント　/api_v1_master_goods/upload)をご利用ください。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) 商品マスタCSVを作成してアップロードを行います。 在庫の増減/加減を行う項目はzaiko_suになります。加算する場合は正の値、減算する場合は負の値を設定して下さい。 商品マスタCSVの詳しい情報についてはこちらをご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) --- # ログイン URL: https://developer.next-engine.com/questions/647/ **投稿者:** 小林由尚2　**日時:** 2017/12/11 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 APIを利用してアプリを製作中です。 トークンの取得で、NextEngineへログインしているので 現在ログイン中（いま誰がログインしたか）を取得する 方法はございますか？ ログイン後に取得可能なuidかと思いましたが、これも長さ的に違うようでした。 --- ## 回答 (1件) ### hamee_sys — 2017/12/12 NEログインuid・state取得API(エンドポイント /users/sign_in/)でログインされているかどうかを確認することができます。 ログインされている場合、uid,stateがレスポンスされます。このuid,stateでNEログインaccess_token取得(エンドポイント /api_neauth)を呼ぶことでログインされたユーザーを取得することができます。 　pic_ne_id：ユーザーID 　pic_name：ユーザーの氏名 　pic_kana：ユーザーの氏名かな 　pic_mail_address：ユーザーのメールアドレス 詳しくはこちらをご覧ください。 [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) --- # 受注伝票書き込みについて URL: https://developer.next-engine.com/questions/648/ **投稿者:** colony　**日時:** 2017/12/14 **カテゴリ:** ネクストエンジンAPIについて 受注情報を取得し、出荷業務（アプリ）をして、ネクストエンジンに書き戻す、という一連の処理が必要なアプリを開発中です。 以前、御社のご担当者様とお話しさせていただいた際には、データの送受信は、複数行まとめて可能というお話しを ざっくりお聞きしておりましたが、受注伝票受注伝票更新APIを複数伝票を一度のコールで行うことはできますか？ またAPI以外のメイン機能でもすでに登録済みの受注伝票を一括アップデートするような機能はいまのところ 見つけられておりません。 ご教示いただけると幸いです。呼び出し回数がかなりの数になってしまいます。 更新対象の項目はある程度絞れます。特記事項や送料や発送方法、ポイント、支払い方法などです。 よろしくお願いいたします。 また特記事項は納品明細書に印字したいがために利用しているので、別項目が出力できるようなら、 特記事項にはこだわりません。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2017/12/14 申し訳ございませんが、受注伝票受注伝票更新APIでは複数更新することは出来ません。 1件ずつの更新になります。 新規データの場合であれば受注伝票アップロードで複数登録することは出来ますが、登録済みの受注データを複数更新することは不可となります。 ご不便をおかけいたしますが1件ずつ更新するようお願い致します。 --- # 受注伝票の削除フラグについて URL: https://developer.next-engine.com/questions/654/ **投稿者:** SYS平　**日時:** 2017/12/19 **カテゴリ:** ネクストエンジンAPIについて 毎々お世話になります。 受注伝票検索ＡＰＩで取得できる「削除フラグ」について確認させていただきたいのですが、 「１：有効　１以外：無効」の意味合いは 　・削除フラグ＝１　⇒　有効伝票 　・削除フラグ＜＞１　⇒　無効伝票（＝削除伝票） でよろしいのでしょうか？ ご教示宜しくお願い致します。 --- ## 回答 (4件) ### hamee_sys — 2017/12/19 申し訳ございません。リファレンスには記載しておりますが、現在削除フラグは利用する事が出来ません。 リファレンスからは削除するように致します。 また、伝票自体は削除することは出来ません。伝票を無効にするにはキャセル機能を利用する形になります。 ### SYS平（質問者） — 2017/12/20 承知しました。 検索ＡＰＩで取得する項目から外します。 ご教示ありがとうございました。 ### kawakami — 2019/07/03 現時点でもリファレンスに記載はありますが、 その後も利用されていない認識でよろしいでしょうか？ ### hamee_sys — 2019/07/11 はい、こちら現在も利用はできません。 レスポンスに値は返ってきてしまうため、サンプルへの記載は残しております。 --- # 比較演算子 -in について URL: https://developer.next-engine.com/questions/657/ **投稿者:** scp_dev　**日時:** 2017/12/27 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 御社サイトの比較演算子一覧に以下の記述があります。 例えば、商品コードgoods_idがabc,def,efgのいずれかであること、と指定する場合パラメータ"goods_id-in"に"abc, def, efg"を指定します。 そこで、文字列型のフィールドに対してブランクを含めた検索を -in 演算子で行うにはどのように記述すればよいでしょうか？ 例えば、入力パラメータに$query['xxxxx-in'] = "abc,'',def,efg"; のようにしましたが実現できません。abc,のあとはシングルコーテーション二つです。（最初と最後はダブルコーテーション） 実現したいクエリをMySQLで記述すると select * from table1 where xxxxx in ('abc', '', 'def', 'efg'); となります。 -in 演算子でブランクを含めた検索を行う方法についてご教示のほどよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/01/05 -in ではnullや空白の検索は行えないため、-blankを利用するようお願いいたします。 --- # テスト環境における受注受注データについて URL: https://developer.next-engine.com/questions/662/ **投稿者:** 中川　峻一　**日時:** 2018/01/10 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 テスト環境で受注API(/api_v1_receiveorder_base/search) を access_token = 'xxxx' refresh_token = 'yyyy' fields = receive_order_shop_id,receive_order_id,receive_order_shop_cut_form_id で実行したところレスポンスが { "result": "success", "count": "0", "data": [], "access_token": "xxxx", "access_token_end_date": "2018-01-11 12:23:09", "refresh_token": yyyy", "refresh_token_end_date": "2018-01-13 12:23:09" } となり1件もデータを取得出来ませんでした。 テスト環境用の受注データはどうすれば用意できるのでしょうか？ --- ## 回答 (3件) ### hamee_sys — 2018/01/10 テスト環境のアカウント発行することで、テスト環境でテストデータを作成することができます。 詳しくはこちらをご覧ください。 [http://manual.next-e.jp/how_use/make/](http://manual.next-e.jp/how_use/make/) ### 中川　峻一（質問者） — 2018/01/11 ご回答ありがとうございます。 リンク先の画像にあるような「アプリを作る」タブの「メイン機能（テスト環境）のアカウント発行」項目が表示されないのですがどうすればよいでしょうか？ [https://qiita-image-store.s3.amazonaws.com/0/71154/a71f2fb9-d690-69da-86...](https://qiita-image-store.s3.amazonaws.com/0/71154/a71f2fb9-d690-69da-8617-4515d4b56cd2.png) ### hamee_sys — 2018/01/12 表示されていないという事はすでにテストアカウントが発行されていると思われるので、アプリ一覧より「メイン機能(テスト環境)」があるかご確認ください。 「メイン機能(テスト環境)」からテストデータを作成することが出来ます。 --- # 受注伝票のラベル発行フラグについて URL: https://developer.next-engine.com/questions/663/ **投稿者:** SYS平　**日時:** 2018/01/10 **カテゴリ:** ネクストエンジンAPIについて 毎々お世話になります。 受注伝票検索ＡＰＩで取得できる「ラベル発行フラグ」について確認させてください。 『配送伝票の印刷対象か否か 　　0:対象外 　　1:対象 　　2:発行済み』 印刷待ちの伝票情報をＡＰＩで取得すると、フラグの値が「0:対象外」となっています。 ヤマトのＢ２用ＣＳＶファイルを作成する際の条件で使用する項目だと想定していたのですが、 用途が違うのでしょうか？ このフラグが「1:対象」となる条件はどのようなものでしょうか。 ご教示宜しくお願い致します。 --- ## 回答 (2件) ### hamee_sys — 2018/01/12 値と条件の関係は以下になります。 0:対象外　　1と2以外の状態 1:対象　　　出荷確定した場合 or 納品書ダウンロードで「配送情報のダウンロード対象に更新する（出荷確定処理は行われません）」を選択して出力した場合 2:発行済み　配送情報を出力した場合 ### SYS平（質問者） — 2018/01/12 「0:対象外」と「1:対象」の違いは、 配送情報の出力が可能なステータスになったかどうかなのですね。 ご教示ありがとうございました。 --- # APIにアクセスできない事象について URL: https://developer.next-engine.com/questions/667/ **投稿者:** 磯　孝之　**日時:** 2018/01/15 **カテゴリ:** ネクストエンジンAPIについて テスト用の開発環境からネクストエンジンAPIの「アップロードキュー検索」「在庫マスタ検索」にアクセスしたところ、 ログインページが返ってきますが、考えられる原因は何かわかりますでしょうか？ （「設定ナビ」を見ると必須設定項目が3項目残っていますが、それが原因でしょうか？ 　なお、上記３項目は 　　　「6. 【在庫】各店舗のID・パスワードを登録する」 　　　「8. 【在庫】在庫数を登録する」 　　　「10. 【在庫】受注メールの取込設定を行う」 　となります。それぞれ楽天RMS側の設定で楽天側の問合せ待ちとなっています） テスト状況： ①テスト環境用の「クライアントID」と「クライアントシークレット」を「[https://base.next-engine.org/users/sign_in/](https://base.next-engine.org/users/sign_in/)」にGET送信。 ②ログインページが表示されるので、ログインを行って、リダイレクトURLから「uid」と「state」を取得。 ③取得した「uid」と「state」を使って、バッチ処理で「アクセストークン」と「リフレッシュトークン」を取得。 ④取得した「アクセストークン」と「リフレッシュトークン」を使って、バッチ処理で「アップロードキュー検索」または「在庫マスタ検索」APIにアクセス。→どちらもログインページが返ってくる。 ご確認よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/01/16 確認いたしますのでしばらくお待ちください。 因みに④のバッチ処理では、バッチ処理自体には認証処理は行なっていないでしょうか？ バッチ処理で/users/sign_in/を実行するとログインページが返ってきます。 ### 磯　孝之（質問者） — 2018/01/16 自己解決いたしました。 (再度確認いたしましたところ、④のバッチ処理でホストがapi.next-engine.orgでなくbase.next-engine.orgとなっておりました。) ありがとうございました。 --- # 在庫更新のアクセス元IPについて URL: https://developer.next-engine.com/questions/669/ **投稿者:** hoge　**日時:** 2018/01/18 **カテゴリ:** 開発環境・SDKについて ネクストエンジンの在庫数が減った際に飛んでくる在庫更新APIの テスト環境のIPを教えて頂きたいです。 --- ## 回答 (1件) ### hamee_sys — 2018/01/18 こちらはアプリ開発、開発用のネクストエンジンAPIのサポートになりますので、ネクストエンジン本体の在庫連携に関するお問い合わせはサポートセンターまでお願い致します。 --- # テスト環境用のＩＰアドレス（ネクストエンジン側）について URL: https://developer.next-engine.com/questions/670/ **投稿者:** 磯　孝之　**日時:** 2018/01/19 **カテゴリ:** ネクストエンジンAPIについて 現在、在庫連携に関してAPIを用いて、弊社基幹システムとネクストエンジン間の連携処理を進めるべくテスト中なのですが、 弊社基幹システムからメイン環境（テスト環境）へデータ連携ができない状況です。 以前、サポートデスクよりＩＰアドレス（153.XXX.XXX.XXXの形式）を共有いただいたのですが、このＩＰでは連携できない状態です。 [https://api.next-engine.org](https://api.next-engine.org)に弊社テスト環境からアクセスしてAPIを利用することは問題なくできているのですが、 弊社の基幹システムからバッチでアクセスするためにURLではなくIPアドレスを教えていただく必要があります。 （なお、弊社インフラとして、ファイアーウォールを用いて、特定のＩＰのみ通信可能としているため） テスト用IPを教えてください。 （さきほどサポートデスクにも同依頼したのですが、コミュニティに確認してほしいとのことでしたので、こちらに記載しました） --- ## 回答 (4件) ### hamee_sys — 2018/01/19 確認いたしますのでしばらくお待ちください。 ### hamee_sys — 2018/01/23 お待たせして申し訳ございません。 1点ご確認したいことがあります。 在庫連携とありますが、「商品マスタアップロード」のエンドポイントのことでしょうか？ ご確認いただいた、エンドポイントについてご教示いただければと思います。 ### 磯　孝之（質問者） — 2018/01/23 >在庫連携とありますが、「商品マスタアップロード」のエンドポイントのことでしょうか？ ⇒　在庫連携のＡＰＩとして、以下の３点を使用しています。 　　　・商品マスタアップロード 　　　・在庫マスタ検索 　　　・アップロードキュー検索 　　　よろしくお願いいたします。 ### hamee_sys — 2018/01/24 大変申し訳ございませんが、IPにつきましては予告なく変更される場合がございますのでお伝えいたしかねます。 以下のコマンドで今現在のIPを調べることが可能です。 nslookup base.next-engine.org nslookup api.next-engine.org --- # 受注データの取得および明細取得について URL: https://developer.next-engine.com/questions/671/ **投稿者:** colony　**日時:** 2018/01/22 **カテゴリ:** ネクストエンジンAPIについて APIのコール件数を気にしているのですが、受注伝票データと明細データは一度に検索できない？ようなので 受注伝票を１件ずつ明細を取得しているのですが、これは受注伝票の件数だけコールしているということには ならないでしょうか？ 一度に取得する方法はございませんか？ --- ## 回答 (1件) ### hamee_sys — 2018/01/22 受注明細検索API(エンドポイント:/api_v1_receiveorder_row/search)で同時に受注伝票データと明細データ、商品データを取得することができます。 マニュアルをご覧ください [https://developer.next-engine.com/api/api_v1_receiveorder_row/search](https://developer.next-engine.com/api/api_v1_receiveorder_row/search) フィールド一覧をご確認いただければと思います。 --- # アクセス情報[システム情報取得]について URL: https://developer.next-engine.com/questions/672/ **投稿者:** 中川　峻一　**日時:** 2018/01/22 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 テスト環境で /api_v1_receiveorder_confirm/search を実行すると { "result": "error", "code": "004001", "message": "アクセス情報[システム情報取得]の許可が必要です。", ... } のエラーが返るのですがアクセス情報[システム情報取得]の許可はどこでできるのでしょうか？ 因みに /api_v1_receiveorder_base/search のエンドポイントはcsvデータを取り込んだもので正常に動作しています。 --- ## 回答 (1件) ### hamee_sys — 2018/01/23 ネクストエンジンの「アプリを作る」より、対象のアプリを選択していただき「APIタブ」にて、許可の設定を行うことが出来ます。 システム情報取得項目を確認していただき、許可しないを許可するに変更してください。 --- # 受注状態について URL: https://developer.next-engine.com/questions/673/ **投稿者:** colony　**日時:** 2018/01/25 **カテゴリ:** ネクストエンジンAPIについて 受注伝票情報を取得した際、引当待ちや出荷済みなどの状態を取得するにはどの項目を参照したらよいでしょうか。 --- ## 回答 (1件) ### うなぎ — 2018/01/25 colonyさん 受注伝票検索APIで受注状態区分(receive_order_order_status_id)と受注状態名(receive_order_order_status_name)で参照する事ができると思います。 --- # 商品マスタアップロードAPIでアップロードに失敗したがsuccessで返却されるケースの対応について URL: https://developer.next-engine.com/questions/674/ **投稿者:** 遠田　**日時:** 2018/01/26 **カテゴリ:** ネクストエンジンAPIについて 現在ECサイトとモールの商品マスタを連携するために、 "商品マスタアップロードAPI"を使用した商品マスタを連携するバッチプログラムを設計しております。 商品マスタアップロードAPI実行でデータ内に使用されている文字種などによりネクストエンジン側への商品データアップロードが失敗した場合、 レスポンス結果がerrorではなく「result:success」として返却されております。 上記事象の対応方法に関して、以下の3点についてご回答頂けますでしょうか。 (1)使用されている文字種などにより商品データアップロードに失敗したがレスポンスが「result:success」として返却された場合、 　APIを実行したシステム側でデータが正常にアップロードできなかったことを検知する方法はありますでしょうか。 (2)(1)で検知する方法が無い場合、他に利用されているシステムでは一般的にどのような対応をされているのでしょうか。 (3)(2)で特に対応などが無い場合、ECサイト側システム内での対応としては予め文字種や必須項目でのファイルのチェックを厳密に行っておく他ないと思われますが、 　下記に記載されている「機種依存文字」「旧漢字」とはSJIS範囲外の文字の認識で相違ないでしょうか。 　[http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/](http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/) --- ## 回答 (1件) ### hamee_sys — 2018/01/29 商品データアップロードAPIの成否については、マスタの更新結果ではなくファイルアップロードが成功したか否かの結果になります。 更新処理の結果については、アップロードキュー検索API(エンドポイント /api_v1_system_que/search)を参照してください。 また、ご利用できない文字種に関してはマニュアルに記載されている通り、以下が利用することができません。 　機種（環境）依存文字、半角カタカナ、半角コロン（:）、半角カンマ（,）、半角ハテナ（?） --- # 安全在庫機能について URL: https://developer.next-engine.com/questions/675/ **投稿者:** 磯　孝之　**日時:** 2018/01/26 **カテゴリ:** ネクストエンジンAPIについて 在庫連携APIを用いて、弊社基幹システムからネクストエンジンに在庫数を連携しているのですが、 その際、在庫数（フリー在庫）を、その在庫数から全件マイナスn個といったように変換するような 仕組みはありますでしょうか？ 例　：　基幹システム　　　Ａ商品　１０個 　　　　　　　　　　　　　　　　Ｂ商品　１５個 　　　　　↓　データ連携 　　　　ネクストエンジン　 　　　　　　　安全在庫設定　－３個　を適用 　　　　　↓ 　　　　楽天市場（楽天ＲＭＳ） 　　　　　　　　結果　　　　　Ａ商品　　７個 　　　　　　　　　　　　　　　　Ｂ商品　１２個 --- ## 回答 (1件) ### hamee_sys — 2018/01/29 大変申し訳ございませんが、こちらはアプリ開発、開発用のネクストエンジンAPIのサポートになりますので、ネクストエンジン本体の在庫連携に関するお問い合わせはサポートセンターまでお願い致します。 お手数お掛け致しますが宜しくお願い致します。 --- # 受注伝票アップロードについて URL: https://developer.next-engine.com/questions/677/ **投稿者:** colony　**日時:** 2018/01/30 **カテゴリ:** ネクストエンジンAPIについて 海外からの受注で、郵便番号に英字が入っていると「郵便番号の形式が違います」が出て失敗します。 モール（楽天）からのCSVインポートではNEに取り込まれております。APIでSearchした結果をUploadしたいのですがどうしたらよいでしょうか。 郵便番号を投げないようにするしかないでしょうか。 --- ## 回答 (4件) ### hamee_sys — 2018/01/31 確認致しますので、しばらくお待ちください。 ### hamee_sys — 2018/02/01 郵便番号に英字が含まれていても、アップロードは可能です。 調査いたしますので、NEにアップロードしてエラーになったcsvファイルを以下アドレスに送っていただけますでしょうか。 [info+devnet@next-engine.jp](mailto:info+devnet@next-engine.jp) ### 田辺 啓介 — 2018/02/19 TEST環境です。 受注伝票アップロードを行いましたが、「error" ["code"]=> string(6) "006007" ["message"]=> string(58) "存在しない受注一括登録パターン[28]です。」になりました。 「参考資料：受注一括登録フォーマットパターンのID」で定義されている「28」ですが、何故でしょうか？ どなたかご教授お願いします。 ### 田辺 啓介 — 2018/02/20 フォーマットidとパターンidは違う事に気づきました。 --- # 開発用メイン機能の利用について URL: https://developer.next-engine.com/questions/678/ **投稿者:** 松島　浩彦　**日時:** 2018/02/06 **カテゴリ:** 開発環境・SDKについて お世話になっております。 本番用のアプリの運用開始に伴い、開発用アプリと開発用メイン機能が画面から消えてしまっているようなのですが、 本番に移行した後は開発用環境はもう利用できないのでしょうか？ --- ## 回答 (2件) ### hamee_sys — 2018/02/06 本番用のアプリの運用開始しても、開発用アプリと開発用メイン機能が消えることはありません。 プラットフォーム画面の 設定＞メイン機能 「ご利用メイン機能（テスト環境）」の「利用ユーザー設定」の「利用許可」をご確認ください。 許可しないになっていたら、そのメイン機能に紐づくアプリも非表示になります。 ### 松島　浩彦（質問者） — 2018/02/06 ご指示の方法で解決いたしました。ありがとうございました。 --- # 受注伝票検索APIについて URL: https://developer.next-engine.com/questions/679/ **投稿者:** 松島　浩彦　**日時:** 2018/02/06 **カテゴリ:** ネクストエンジンAPIについて お世話になります。サポートに問い合わせたところ、こちらで問い合わせてくださいとのことでしたので質問させていただきます。 受注伝票検索API（エンドポイント：/api_v1_receiveorder_base/search）につきまして、次の点をご教授願えませんでしょうか？ ①「受注確認内容ID（receive_order_confirm_ids）」とは、「確認チェック区分（receive_order_confirm_check_id）」が「1:確認必要」だった際に設定されるものという理解で合っていますでしょうか？ ②以下の各区分の具体的な区分値とその意味を事前に知りたいのですが、御社サイトのどこを参照すればわかりますでしょうか？ (a) 「受注確認内容ID（receive_order_confirm_ids）」 (b) 「受注キャンセル区分（receive_order_cancel_type_id）」 (c) 「受注状態区分（receive_order_order_status_id）」 (d) 「発送方法区分（receive_order_delivery_id）」 (e) 「入金状況区分（receive_order_deposit_type_id）」 --- ## 回答 (4件) ### hamee_sys — 2018/02/07 >①「受注確認内容ID（receive_order_confirm_ids）」とは、「確認チェック区分（receive_order_confirm_check_id）」が「1:確認必要」だった際に設定されるものという理解で合っていますでしょうか？ 受注確認内容IDはネクストエンジン本体の[設定]→[受注]→[受注確認内容]でチェックした条件で取り込まれた伝票に対して、設定されます。 条件に合った注確認内容IDが":"区切りで設定されます。 設定された場合、確認チェック区分が「1:確認必要」になります。その後伝票にチェックを行うと「2:確認済み」になります。 受注確認内容のについてはこちらをご覧ください [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/) >②以下の各区分の具体的な区分値とその意味を事前に知りたいのですが、御社サイトのどこを参照すればわかりますでしょうか？ >(a) 「受注確認内容ID（receive_order_confirm_ids）」 受注確認内容についてはこちらのページの確認内容一覧をご確認ください。 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/) IDと内容の一覧を確認するには受注確認内容検索(エンドポイント /api_v1_receiveorder_confirm/search) を実行してご確認ください。 [https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search](https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search) >(b) 「受注キャンセル区分（receive_order_cancel_type_id）」 ネクストエンジン本体の[設定]→[受注]→[受注確認内容]の受注キャンセルタブよりご確認ください >(c) 「受注状態区分（receive_order_order_status_id）」 以下のページのワンポイントアドバイスをご確認ください。 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/) >(d) 「発送方法区分（receive_order_delivery_id）」 ネクストエンジン本体の[設定]→[受注]→[受注確認内容]の発送方法タブよりご確認ください >(e) 「入金状況区分（receive_order_deposit_type_id）」 以下の値になります 0:未入金 1:一部入金 2:入金済み ### 松島　浩彦（質問者） — 2018/02/08 お忙しい中、詳細なご回答ありがとうございます。 >>(a) 「受注確認内容ID（receive_order_confirm_ids）」 >受注確認内容についてはこちらのページの確認内容一覧をご確認ください。 >[http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/a007/) >IDと内容の一覧を確認するには受注確認内容検索(エンドポイント /api_v1_receiveorder_confirm/search) を実行してご確認ください。 ご指示いただきましたページにはメッセージの一覧しかないと思うのですが、IDから内容を判断して後続処理を変えるというバッチ処理の実装を考えております。 メッセージの内容で識別することもできないことはないのですが、メッセージが1文字でも異なってしまうと正常に動作しなくなりますので、できましたらIDを知りたいと存じます。その際に、ご指示いただいたページの一覧表にあるすべてのメッセージの状態を意図的に作り出してIDを確認するというのは大変な作業になりますので、メッセージごとのIDをお持ちだと存じますので、それをお教えいただくことはできませんでしょうか？（上記ページに記載していただく形でもかまいません） 何卒よろしくお願いいたします。 ### hamee_sys — 2018/02/08 受注確認内容IDの値については、マニュアル等ではご用意していないのでお手数ですが、受注確認内容検索(エンドポイント /api_v1_receiveorder_confirm/search) を実行して、ご確認いただけるようお願い致します。 [https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search](https://developer.next-engine.com/api/api_v1_receiveorder_confirm/search) APIを実行するとIDとメッセージの一覧を取得する事が出来ます。 API実行例 　curl -X POST -H 'content-type: application/x-www-form-urlencoded' -d 'access_token=アクセストークン&refresh_token=リフレッシュトークン&wait_flag=1&fields=項目名' [https://api.next-engine.org/api_v1_receiveorder_confirm/search](https://api.next-engine.org/api_v1_receiveorder_confirm/search) Response 例 { "result": "success", "count": "1", "data": [ { "confirm_id": "AA", "confirm_name": "商品コードが商品マスタに存在しません。", "confirm_display_order": "1", "confirm_html": "商品コードが商品マスタに存在しない場合、確認内容に表示します。", "confirm_value": null, "confirm_valid_flag": "0", "confirm_deleted_flag": "0", "confirm_creation_date": "2007-02-28 00:00:00", "confirm_last_modified_date": "0000-00-00 00:00:00", "confirm_last_modified_null_safe_date": "0000-00-00 00:00:00", "confirm_creator_id": "9978", "confirm_creator_name": null, "confirm_last_modified_by_id": "0", "confirm_last_modified_by_null_safe_id": "0", "confirm_last_modified_by_name": "System", "confirm_last_modified_by_null_safe_name": "System" } ], "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" } ### 松島　浩彦（質問者） — 2018/02/08 了解いたしました。詳細なご説明をいただきありがとうございました。 --- # 受注伝票検索におけるダウンロード済みフラグについて URL: https://developer.next-engine.com/questions/680/ **投稿者:** 松島　浩彦　**日時:** 2018/02/07 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注伝票検索（エンドポイント：/api_v1_receiveorder_base/search）におきまして、 すでにダウンロード済みの受注とまだ一度もダウンロードしていない受注を識別したいのですが、 識別に仕様できるフィールド（ダウンロードを行うことで自動で値が変わるもの）はありますでしょうか？ --- ## 回答 (4件) ### hamee_sys — 2018/02/07 ダウンロードというのは納品書ダウンロードの事でしょうか？ 納品書がダウンロードされたかどうかであれば、納品書発行日(receive_order_statement_delivery_printing_date)で納品書をダウンロードした日を確認する事ができます。 ### 松島　浩彦（質問者） — 2018/02/07 ご回答ありがとうございます。 ダウンロードというのは、検索を行って、ある「receive_order_id」に紐付いた全データを取得する、という ことです。 データ取得する受注件数がかなり多くなることが予想されるため、すでにデータを取得済みの「receive_order_id」を除外してデータ取得を行いたいのですが、 ある「receive_order_id」について、そのデータが1度でも取得済みかどうかを判別できるフラグのようなものはありませんでしょうか？というのが、質問の意図となります。 よろしくお願いいたします。 ### hamee_sys — 2018/02/08 受注データではそのようなダウンロード済みフラグはないので、作成するアプリ側で仕組みを構築していただく事になります。 ### 松島　浩彦（質問者） — 2018/02/08 了解いたしました。ご回答ありがとうございました。 --- # 受注状態区分のステータス変更について URL: https://developer.next-engine.com/questions/681/ **投稿者:** 松島　浩彦　**日時:** 2018/02/08 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 受注状態区分（receive_order_order_status_id）のステータスにつきまして、受注伝票更新APIからも操作画面からも 変更ができないようなのですが、これはどのような時にどのようなタイミングで変わるのでしょうか？ たとえば、納品書印刷指示日（receive_order_statement_delivery_instruct_printing_date）を指定すると即時に 「20．納品書印刷待ち」に変わる、などの推測ができますが、あくまで推測にすぎませんので、ステータスが変化する 条件（法則）をお教えいただけませんでしょうか？ よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/02/09 ネクストエンジン本体で、確認処理や入金登録処理、出荷処理などを行った場合に受注状態区分が変わります。 APIでは受注伝票納品書印刷済み(エンドポイント /api_v1_receiveorder_base/receipted)、受注伝票出荷確定処理(エンドポイント /api_v1_receiveorder_base/shipped)などで受注状態区分が変わります。 なお、ネクストエンジン本体の操作についてはネクストエンジン本体のマニュアルをご覧ください。 こちらのワンポイントアドバイスに受注状態区分の説明がありますのでご参考ください。 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b003/) ### 松島　浩彦（質問者） — 2018/02/09 了解いたしました。ご回答ありがとうございました。 --- # （β版）商品管理のページ情報の取得 URL: https://developer.next-engine.com/questions/682/ **投稿者:** rish　**日時:** 2018/02/14 **カテゴリ:** ネクストエンジンAPIについて （β版）商品管理 > 商品IDで検索 > 商品詳細 > ページ情報に以下のような項目がございます。 ・ページコード（商品コードまたは代表商品コード） ・掲載商品名 ・キャッチコピー１ 　…略… これらの項目を取得するAPIは、下記で宜しいのでしょうか。 [https://developer.next-engine.com/api/api_v1_master_pagebase/count](https://developer.next-engine.com/api/api_v1_master_pagebase/count) [https://developer.next-engine.com/api/api_v1_master_pagebase/search](https://developer.next-engine.com/api/api_v1_master_pagebase/search) アプリ上ではデータが登録されているのですが、件数を取得しても0件と返ってくるため、利用しているAPIが違うのではないかと考えています。 また、違うとしたらどのAPIを利用したら宜しいのでしょうか。 Array ( [result] => success [count] => 0 [access_token] => XXX略XXXX [access_token_end_date] => 2018-02-15 20:47:38 [refresh_token] => XXX略XXXXX [refresh_token_end_date] => 2018-02-17 20:47:38 ) --- ## 回答 (2件) ### hamee_sys — 2018/02/15 （β版）商品管理のページ情報は現在APIでは取得することは出来ません。 （β版）商品管理のページ情報をAPIで取得する件については、今後の改修の参考とさせて頂ければと思います。 ### rish（質問者） — 2018/02/18 回答ありがとうございました。 --- # 商品マスタアップロードAPI（ /api_v1_master_goods/upload ）の動作について URL: https://developer.next-engine.com/questions/688/ **投稿者:** 戸田　**日時:** 2018/02/27 **カテゴリ:** ネクストエンジンAPIについて 商品マスタアップロードAPI（ /api_v1_master_goods/upload ）について [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) と [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) を参考にして開発をしております。 任意の商品の「予約フリー在庫数」を更新する目的で商品マスタアップロードAPI（ /api_v1_master_goods/upload ）に対してphpクライアントから以下のようなリクエストを行っていますが、 アップロード後に [https://ne34.next-engine.com/User_Syohin_Search](https://ne34.next-engine.com/User_Syohin_Search) から該当商品を検索すると「予約在庫数」ではなく「卸在庫数」が更新されています。 予約在庫数を更新する方法、もしくは予約フリー在庫数を更新する方法をご教示ください。 ■商品マスタアップロードAPI（ /api_v1_master_goods/upload ）の呼び出しコード（php) ` //（中略） $response = $client->apiExecute('/api_v1_master_goods/upload', array( 'data_type' => 'gz', 'data' => self::getUploadData($update_data_source), ));` //（中略） private function getUploadData($update_data_source) { $csv = ''; $csv .= '"syohin_code","yoyaku_zaiko_su"' . "\n"; foreach ($update_data_source as $syohin_code => $yoyaku_zaiko_su) { $csv .= '"'.$syohin_code.'","'.$yoyaku_zaiko_su.'"' . "\n"; } return gzencode(mb_convert_encoding($csv,"SJIS", "UTF-8"), 9); } □補足 上記コードで $response['result']='success' であることは確認できています 以上、よろしくお願いいたします --- ## 回答 (3件) ### hamee_sys — 2018/02/28 予約在庫数、予約フリー在庫数の更新する為の項目はyoyaku_zaiko_su　になります。 yoyaku_zaiko_suに設定する値は実数ではなく、加算する数または減算する数になります。 yoyaku_zaiko_suに設定した値が正の場合は加算、負の場合は減算になります。 予約フリー在庫数は　予約在庫数ー予約引当数 になります。 予約在庫数は予約引当数より少なくする事は出来ないので、予約フリー在庫数が0の状態で、yoyaku_zaiko_suに負の値を設定しても予約在庫数は変わりません。 ちなみに卸在庫数は フリー在庫数(在庫数 ー 引当数) － 卸引当用閾値になります。 zaiko_suを設定する事で 卸在庫数が変わります。 これらを踏まえて、更新されない商品の予約フリー在庫数と設定したyoyaku_zaiko_suを再度ご確認頂ければと思います。 更新するデータに問題ないようでしたら、一度更新しようとしたcsvファイルをネクストエンジン本体の商品管理の一括登録機能で更新していただき、正しく更新されるかをご確認いただけますでしょうか。 ### 戸田（質問者） — 2018/03/06 ご教示いただいた「更新しようとしたcsvファイルをネクストエンジン本体の商品管理の一括登録機能で更新」の方法で確認してみたところ 「yoyaku_zaiko_suはsyohin_kbnが10でないと更新できない」ということがわかり、アップロードするcsvを修正することで要求を達成できました。 ドキュメント（ [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) ）に上記の情報がありませんでしたので、追記していただけると幸いです。 ### hamee_sys — 2018/03/07 ご確認ありがとうございます。 マニュアル追記の件、承りました。 ご参考までに以下のマニュアルに「予約在庫の入出庫は商品区分が[予約]の場合に限り可能です。」と記載しております。 この予約を対応する値にすると10になります。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/i011/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/i011/) --- # APIで在庫連携対象にする方法 URL: https://developer.next-engine.com/questions/689/ **投稿者:** scp_dev　**日時:** 2018/02/28 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 件名について教えて下さい。 在庫変動させることなく在庫連携の対象にする方法として、サポートに問い合わせたところ メイン機能から該当アイテムの品番で検索後、「商品マスタ登録・更新」タブから データはそのままで、「商品マスタを変更」ボタンをクリックする方法を教えてもらいました。動作確認もO.K.でした。 それと同じことをネクストエンジンAPIで実現する方法を教えて下さい。 商品マスタアップロードAPI（/api_v1_master_goods/upload）で色々試しましたが実現できません。 ご回答のほどよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/03/01 APIでは直接在庫数を変更する事は可能ですが、在庫連携対象にすることはできませんのでネクストエンジン本体で設定するようにお願いします。 --- # 受注伝票配送情報出力済みを再度出力対象にできますでしょうか？ URL: https://developer.next-engine.com/questions/690/ **投稿者:** hirai.forest　**日時:** 2018/03/02 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 表題通りの質問です。 納品書印刷済みあるいは出荷確定済みとし、配送情報をダウンロードした伝票につきまして 再度、配送情報出力対象とすることはAPIによってできますでしょうか。 受注伝票配送情報出力済み API (/api_v1_receiveorder_base/labelprinted) の ラベル発行フラグ ( receive_order_label_print_flag ) 1：配送情報出力対象にする 2：配送情報出力済みにする でそれが可能かと期待しましたが、試したところそのようには動きません。 （「受注伝票[xxxxx]は配送情報出力済みです。」のエラーになります。） こちら、APIで可能でしょうか。 あるいは、やはりできないのでしょうか。 運用としましては、当初ヤマトDM便のつもりで配送情報をダウンロードしたが、 数量・重量などのために発送方法を変更したときに再度配送情報をダウンロードしたい、 というケースへのAPIによる対応がしたいと思っております。 受注伝票受注伝票更新API で可能であればそれでも大丈夫ですが、見たところ 指定出来るフィールドの一覧にはなさそうです。 もしなんらかの方法で可能であれば、ご教示をいただけましたら幸いです。 お手数をおかけいたしますが、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/03/06 APIでは配送情報出力済みなった伝票は再度出力対象にする事はできません。 メイン機能からは「出荷確定戻し」という方法で状態を戻すことにより、再度配送情報の処理前の状態に戻すことが可能です。 ※「出荷確定戻し」：50出荷確定済みの伝票を開いてメニュー＞伝票操作からできます。 ### hirai.forest（質問者） — 2018/03/07 APIではできないということで承知しました。 発送方法の変更自体は受注状態を変更せず、またAPIからの変更も可能であっただけに残念です。 ＃やりたいことは、新しい発送方法で宛名ラベルを再出力したいだけ、なんですが...。 ＃ピッキング後の発送方法の変更が1日70件ほどは発生しているため、これを全て手で作業するのはミスの元になり避けたいところではありました。 ともあれありがとうございました。 --- # ECcubeの商品情報を自動でネクストエンジンに入れる方法 URL: https://developer.next-engine.com/questions/692/ **投稿者:** Tetsuya2　**日時:** 2018/03/08 **カテゴリ:** ネクストエンジンAPIについて 現在ECcube店舗で運営をしており、多店舗化をするためネクストエンジンで一元管理を計画しています。 その際ネクストエンジンへの商品アップロード方法ですがサポートの方に下記の様に伺いました。 ■商品アップロード方法 1. ECcubeで商品登録 2. ECcubeの商品情報(csv)でDL 3. ネクストエンジンにアップロード この2.のところをボタンを押すなりして自動でアップできる方法はありますでしょうか。 --- ## 回答 (3件) ### hamee_sys — 2018/03/08 >この2.のところをボタンを押すなりして自動でアップできる方法はありますでしょうか。 ECcubeのダウンロードについてはECcube側の機能になりますので、ECcubeの機能をご確認ください 3.については、ネクストエンジンAPIを利用したアプリを作成することによりネクストエンジンにアップロードする事が可能になります。 ### Tetsuya2（質問者） — 2018/03/08 >3.については、ネクストエンジンAPI どのapiですか？ ### hamee_sys — 2018/03/08 商品マスタアップロードAPIを使用してネクストエンジンに商品のアップロードをする事ができます。 [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) --- # 大量の受注データに対して、受注伝票受注伝票更新APIを実行したいです URL: https://developer.next-engine.com/questions/694/ **投稿者:** たなたな　**日時:** 2018/03/15 **カテゴリ:** ネクストエンジンAPIについて ご担当者様 現在、大量の受注伝票データ（2000件以上）に対して、バッチ処理で受注伝票受注伝票更新APIにてデータ更新を行おうと考えております。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) その際に、2000件以上のデータに対して、連続で受注伝票受注伝票更新APIを投げることになりますが、 ネクストエンジン側で、連続したリクエストに対して、アクセス制限などは設けておりますでしょうか？ ご確認のほど、お願いします。 --- ## 回答 (3件) ### hamee_sys — 2018/03/15 連続したリクエストに対しての制限は特に設けておりませんが、以下の点にご注意ください。 ・高負荷な処理(バッチ処理、大量検索・大量更新)や、アプリ側の1連の処理を途切れさせたくない場合にはwait_flagの値を1で設定してください。 ユーザーに即時レスポンスを返すべき処理ではご利用頂かない事を強く推奨致します。 また必ずAPIが成功する事を保証するパラメータではない為、再開可能なようにアプリを設計して下さい。 wait_flagについてはこちらをご参照ください。 [https://developer.next-engine.com/search/node/wait_flag?page=11](https://developer.next-engine.com/search/node/wait_flag?page=11) ・特定企業にのみ公開アプリの場合はAPI呼び出し回数によって料金が変わるのでご注意ください。 料金についてはこちらをご参照ください。 [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) ### たなたな（質問者） — 2018/03/16 ご回答ありがとうございます。 もう一点質問なのですが、受注伝票受注伝票更新APIにて約2000件のデータを更新する場合、処理完了までどれくらいの時間が掛かりますでしょうか。 （時間帯によって処理時間に増減があるかと思いますが、大体の目安で大丈夫です） 更新カラムは以下です。 ・receive_order_purchaser_zip_code ・receive_order_purchaser_address1 ・receive_order_purchaser_address2 ・receive_order_purchaser_name ・receive_order_purchaser_kana ・receive_order_purchaser_tel ・receive_order_consignee_zip_code ・receive_order_consignee_address1 ・receive_order_consignee_address2 ・receive_order_consignee_name ・receive_order_consignee_kana ・receive_order_consignee_tel ・receive_order_worker_text 条件句（全て-eq） ・receive_order_id ・receive_order_last_modified_date ・receive_order_shipped_update_flag ### hamee_sys — 2018/03/16 処理時間についてですが、時間帯や環境、サーバーの負荷状況なので大きく変わるため、申し訳ございませんがお答えすることができません。 実際にテスト環境でご確認いただけたらと思います。 --- # 受注伝票有効化について URL: https://developer.next-engine.com/questions/695/ **投稿者:** 林 龍一　**日時:** 2018/03/15 **カテゴリ:** ネクストエンジンAPIについて 現在、MakeShopを利用しておりますが、 MakeShopの場合、新規受付に入って来た注文に対して「受注伝票有効化」を行う必要があり、 完全な自動化という形が実現出来ておりません。 そこで、「受注伝票有効化」を外部システムから行うべくAPIを探していたのですが、 それらしいものが見当たりません。 そもそも「受注伝票有効化」を行うAPIは存在しますでしょうか？ もしくは、別の方法でステータスを変更するなどで対応する事は可能でしょうか？ --- ## 回答 (3件) ### hamee_sys — 2018/03/15 受注伝票有効化はAPIではご用意しておりません。 ネクストエンジン本体からの手動での更新のみとなります。 ### 中濱正己 — 2018/09/20 標記の件、ネクストエンジンアプリであれば可能でしょうか？ それとも、一切自動化はできないということでしょうか？ 要件は、メール取り込みしたデータを自動で有効化したいということです。 ### hamee_sys — 2018/09/20 アプリ側で受注一括アップロード用のcsvデータを作成し、受注伝票アップロードAPI(/api_v1_receiveorder_base/upload)を利用する事により、新規受付より先のステータスに遷移することが可能です。 --- # PythonのSDKに関して URL: https://developer.next-engine.com/questions/696/ **投稿者:** 林 龍一　**日時:** 2018/03/15 **カテゴリ:** 開発環境・SDKについて PythonのSDKを今後開発する予定などございますでしょうか？ もしくは、公認のPython SDKなど存在しますでしょうか？ よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/03/16 公認のPython SDKはございません。 また、PythonのSDKの開発予定はございません。 --- # （β版）商品情報とページ情報を取得する方法について URL: https://developer.next-engine.com/questions/699/ **投稿者:** rish　**日時:** 2018/03/18 **カテゴリ:** その他 （β版）商品情報と（β版）ページ情報を全件取得する方法は御座いますでしょうか。 形式は、CSVファイルでも何でも結構です。 以前この場で問い合わせた際には、APIは対応していないと返答を貰っています。 --- ## 回答 (1件) ### hamee_sys — 2018/03/19 （β版）商品情報と（β版）ページ情報はAPIでは取得することはできません。 ネクストエンジン本体で取得することになります。 なお、ネクストエンジン本体についてのお問い合わせはカスタマーセンターまでお願いします。 --- # 商品マスタアップロードAPIの仕様について URL: https://developer.next-engine.com/questions/703/ **投稿者:** yoshida　**日時:** 2018/03/23 **カテゴリ:** ネクストエンジンAPIについて 商品マスタアップロード（/api_v1_master_goods/upload）の仕様について質問します。 ◆実現したいこと ・自社EC（OrangeEC（EC QUBE））→ネクストエンジンに商品情報をAPIで渡したい。 ・店舗別ページを作成するまでの手作業を無くし、APIで自動連携したい。 ◆質問内容 ・店舗別ページを作成するインプットは下記を拝見する限り、商品情報とページ情報という認識ですが、 　上記APIでこれらを連携できると考えてよろしいでしょうか？ 　[http://manual.ec-doc.net/wp-content/themes/NE-manual2/img/manual_0624.png](http://manual.ec-doc.net/wp-content/themes/NE-manual2/img/manual_0624.png) ・上記とは別に、商品情報とページ情報を連携できるAPIがあれば教えてください。 --- ## 回答 (7件) ### yoshida（質問者） — 2018/03/26 上記に加え、バリエーション情報は連携できますでしょうか？ ### hamee_sys — 2018/03/27 商品アップロードで更新できる項目は基本情報のみとなります。ページ情報は対象外になります。 更新できる項目については以下をご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) ### yoshida（質問者） — 2018/03/27 ご回答ありがとうございます。 ”基本情報”の中にバリエーションは含まれますでしょうか？ 下記を拝見し含まれないと思いましたが、念のため確認させてください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) ### hamee_sys — 2018/03/27 項目に含まれていないので、対象外となります。 ### yoshida（質問者） — 2018/03/28 了解しました。回答ありがとうございます。 ### yoshida（質問者） — 2018/06/11 商品マスタアップロードAPI（/api_v1_master_goods/upload）で、ページ情報が更新できない旨承知しました。 ちなみに、ページ情報をアップロードできるAPIは別でありますでしょうか。 ### hamee_sys — 2018/06/12 ページ情報をアップロードするAPIはございませんので、CSVファイル、もしくは手入力にて更新していただく形となります。下記URLが参考になりますのでご覧ください。 商品情報・ページ情報をCSVで一括更新する [http://manual.ec-doc.net/beta_shouhinkanri/sk020/](http://manual.ec-doc.net/beta_shouhinkanri/sk020/) 商品情報・ページ情報を手入力で一括更新する [http://manual.ec-doc.net/beta_shouhinkanri/sk019/](http://manual.ec-doc.net/beta_shouhinkanri/sk019/) --- # 売上集計データを取得するAPI機能はありますか？ URL: https://developer.next-engine.com/questions/705/ **投稿者:** aupte8　**日時:** 2018/03/24 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 あるクライアント様から apiで売り上げデータを取得してGoogleSpreadSheetに貼り付けたい というご要望をいただきました。 ですが残念ながら、 apiリファレンスをざっと拝見した範囲では、売上データを取得できるapiが見当たりません。 売上集計データを取得できるapi（もしくは代替機能）がございましたら ご教授いただければ幸いです。 以上です。 よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/03/26 売上集計データを取得できるapiは特にございません。 受注検索API、受注明細検索APIを利用してアプリ側で集計するようにしていただければと思います。 ### aupte8（質問者） — 2018/03/26 ありがとうございます！ 受注検索API　受注明細検索APIで取得して、集計する方法を採用させていただきます。 --- # APIを用いてモール別に売価を設定する方法 URL: https://developer.next-engine.com/questions/706/ **投稿者:** yoshida　**日時:** 2018/03/26 **カテゴリ:** ネクストエンジンAPIについて 商品管理を下記流れで行いたいと考えています。 「①自社EC　⇒　②ネクストエンジン　⇒　③各モール（楽天、Amazon、Yahoo!ショッピング）」 自社EC上で、楽天/Amazon/Yahoo!の販売価格（売価）をそれぞれ登録した場合、APIを使用して連携することはできますでしょうか？ 例えば下記のような対応ができればと考えています（他に実現できる方法があればそれで問題ございません）。 ・商品マスタアップロードAPI（ /api_v1_master_goods/upload）の、org1～3（項目1 ～3）を各モールの売価をセットする ・（β版）項目変換設定にて、org1～3（項目1 ～3）と各モールの売価を紐づける --- ## 回答 (2件) ### hamee_sys — 2018/03/27 商品マスタアップロードAPIで連携できる項目であれば可能です。 ネクストエンジンに更新できる項目については以下をご覧ください。 [http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/](http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/) なお、（β版）項目変換設定についてはネクストエンジン本体の機能になりますので、（β版）項目変換設定でご不明な点がありましたらマニュアルをご確認いただくか、カスタマーサポートまでお問い合わせください。 ### yoshida（質問者） — 2018/03/27 了解しました。 ありがとうございます。 --- # 区分値について URL: https://developer.next-engine.com/questions/708/ **投稿者:** 松島　浩彦　**日時:** 2018/03/27 **カテゴリ:** ネクストエンジンAPIについて サポートに問い合わせたところ、サポートではわかりかねるのでこちらで質問してくださいとのことでしたので、質問させていただきます。 受注情報を受注伝票検索APIで取得するバッチ処理を構築しているのですが、サンプルデータに正常なものしかなく、異常値として以下の項目がどのような値をとるのかがわかりません。 ・受注キャンセル区分 receive_order_cancel_type_id ・クレジット承認区分 receive_order_credit_approval_type_id ・顧客区分 receive_order_customer_type_id 受注キャンセル区分につきましては、以前に参照ページを教えていただきましたが、文章しか載っておらず、コードとの対応が分かりませんでした。いずれにつきましても、コードとその意味の対応表があればぜひいただきたく存じます。 何卒よろしくお願いいたします。 --- ## 回答 (2件) ### 八つ橋 — 2018/03/27 こんにちは　八つ橋と申します。 以前、似たような質問をして回答いただいたのでよろしければ私の方で回答します。 各区分のコードと意味はAPIで取得できるので、APIを実行して確認してみると良いと思います。 ・受注キャンセル区分 receive_order_cancel_type_id → 受注キャンセル区分情報取得API [https://developer.next-engine.com/api/api_v1_system_canceltype/info](https://developer.next-engine.com/api/api_v1_system_canceltype/info) ・クレジット承認区分 receive_order_credit_approval_type_id → クレジット承認区分情報取得API [https://developer.next-engine.com/api/api_v1_system_creditapprovaltype/info](https://developer.next-engine.com/api/api_v1_system_creditapprovaltype/info) ・顧客区分 receive_order_customer_type_id → 顧客区分情報取得API [https://developer.next-engine.com/api/api_v1_system_customertype/info](https://developer.next-engine.com/api/api_v1_system_customertype/info) 回答になっていますでしょうか？ よろしくお願いします。 ### 松島　浩彦（質問者） — 2018/03/29 ご教示ありがとうございます。お返事が遅くなり申し訳ありません。 試してみましたところ、無事、一覧を取得することができました。 ありがとうございました。 --- # 在庫のマイナスについて URL: https://developer.next-engine.com/questions/761/ **投稿者:** 秋田　訓秀　**日時:** 2018/04/06 **カテゴリ:** ネクストエンジンAPIについて いつもお世話になっております。 現在、webapi2/upd_stockでupdate_mode=aの条件で在庫数を更新しています。 その際、例えば、 ネクストエンジン側の在庫数が3の商品に対して、 upd_stockで-5のような在庫更新を送信した場合、ネクストエンジン側の在庫数は-2ではなく3のままという認識で正しいでしょうか？ また、そのような更新を送った際に、管理者Emailなどに通知を受け取るような機能はありますか？ 以上、ご確認お願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/04/06 こちらのご質問はネクストエンジンAPIの商品マスタアップロードAPIによる商品更新でのご質問になりますでしょうか？ [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) ネクストエンジン本体に設定する在庫連携用のAPIでのご質問の場合、こちらのコミュニティはアプリ開発、開発用のネクストエンジンAPIのサポートになりますので、ネクストエンジン本体の在庫連携に関するお問い合わせはサポートセンターまでお願い致します。 ### 秋田　訓秀（質問者） — 2018/04/06 かしこまりました。 サポートセンターに問い合わせたところ、こちらを案内されたのですが、 再度サポートセンターさんに問い合わせてみます。 ありがとうございました。 --- # アプリの利用状況の確認方法 URL: https://developer.next-engine.com/questions/819/ **投稿者:** JA　**日時:** 2018/04/06 **カテゴリ:** ネクストエンジンAPIについて ケチくさい話で恐縮ですが、現状では無料の範囲内であればAPIを利用したいと思っています。 [http://manual.next-e.jp/price/](http://manual.next-e.jp/price/) の料金表を確認しましたが、 取得する側（APIを叩く側）でログを取って計算する以外で、 現状（または直前まで等の）の呼び出し回数と通信データ量を取得する方法はありますか？ また、もしある場合、その取得時にも、APIの呼び出し回数が加算されますか？ --- ## 回答 (1件) ### hamee_sys — 2018/04/09 申し訳ございませんが、呼び出し回数や通信料を取得する方法はご用意しておりません。 --- # API利用方法について URL: https://developer.next-engine.com/questions/825/ **投稿者:** fracia　**日時:** 2018/04/13 **カテゴリ:** 開発環境・SDKについて SDKを使用してもaccess_token,refresh_tokenは SDKでは取得出来ないように見受けられます。 SDKにて接続を行う場合にもaccess_tokenおよびrefresh_tokenの 取得API実行が必要と認識しておりますが、 下記のURLのAPIの仕様の認識でよろしいでしょうか？ [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) またこちらのAPIについては、 NEログインuid・state取得のAPIの実行も必要となりますでしょうか？ APIリファレンスには、 「本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です」 との記載がございますが、上記の通り、SDKを利用するにもaccess_token,refresh_tokenが取得できないため、 アプリから直接HTTP(S)通信でのAPI実行以外での取得方法はございますでしょうか？ 初歩的なご質問で申し訳ございませんがご教授頂けると幸いです --- ## 回答 (2件) ### goromaru — 2018/04/13 初めまして。 私もSDKを使っているのですが、SDKは、ネクストエンジンAPIの認証処理を内包している為、新たに認証処理を開発する必要がありません。 [https://developer.next-engine.com/sdk](https://developer.next-engine.com/sdk) こちらにサンプルもあったり、詳しく書いてありますので、参考にしてみてください。 ### fracia（質問者） — 2018/04/13 頂いたサイトを確認させて頂きます お忙しい中、ご回答いただき有難うございました 不明点があれば、改めてご質問させて頂きます --- # APIでの使用不可文字列について URL: https://developer.next-engine.com/questions/826/ **投稿者:** たなたな　**日時:** 2018/04/15 **カテゴリ:** ネクストエンジンAPIについて 以下のページに、ネクストエンジンで使用不可な文字列について記載されていますが、 [http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/](http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/) これらの文字列を含めた状態で、受注伝票受注伝票更新APIを実行してみたところ、問題なく更新が行えました。 API側では使用不可文字列の制限は特に行ってないということでしょうか。 また、受注伝票受注伝票更新APIにて、使用不可（APIでエラーが返る）文字は存在しますか。 --- ## 回答 (1件) ### hamee_sys — 2018/04/17 API側でも以下のページにある使用不可な文字列のご利用については推奨しておりませんので、利用を避けるようにお願いいたします。　 　[http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/](http://manual.ec-doc.net/operation/operation-tips/other-tips/ad001/) --- # 汎用のモールから在庫連携についてお伺いします URL: https://developer.next-engine.com/questions/829/ **投稿者:** せがわ　**日時:** 2018/04/23 **カテゴリ:** その他 汎用のモールから在庫連携を行いたく 在庫連携API仕様書.pdfを拝見しましたが 「システムからサイトへ向けて、在庫数を更新するためのリクエストを送信します。」 とありますが、システムどのURLにアクセスすればよろしいでしょうか。 UpdateStock.phpのテンプレートはありますか？ よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/04/23 コメントありがとうございます。 こちら、メイン機能の質問になりますので、 お手数ですが、 サポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 ### せがわ（質問者） — 2018/04/23 了解いたしました。 サポートの方に聞いてみます。 ありがとうございます。 --- # アプリの連携に失敗しました URL: https://developer.next-engine.com/questions/833/ **投稿者:** ながお　**日時:** 2018/04/28 **カテゴリ:** ネクストエンジンAPIについて PHPSDKを使い、APIを実行しようとしたのですが、api_find.phpを実行した際に掲載のエラーが表示されました。 [https://developer.next-engine.com/questions/468](https://developer.next-engine.com/questions/468) 上記の質問を拝見して 「設定 > アプリ > 利用ユーザー設定」を設定しようと思ったのですが、「利用ユーザー設定」という項目がどこにも見当たりません。 アプリの情報 種類：メイン機能と連携するアプリ 販売形態：特定の企業に公開 アプリ名：販売分析データ取得 アプリの目的としては既にあるメイン機能からデータをAPI経由で取得したいだけです。 よろしくお願いします。 --- ## 回答 (5件) ### hamee_sys — 2018/05/01 お問い合わせありがとうございます。返答までお時間いただいてしまい、申し訳ございません。 同じ内容の質問を二度投稿されており、一つ目は公開設定、二つ目は非公開設定となっておりますが、こちらのお問い合わせは、コミュニティに公開してもよろしいでしょうか。 お問い合わせ内容につきましては、これから調査させて頂きます。 お待たせしてしまい申し訳ございませんが、よろしくお願いいたします。 ### ながお（質問者） — 2018/05/01 一つ目の質問がURLがわからなくなってしまったため再度作成してしまいました。 特に企業情報が漏れないのであれば公開しても問題ありません。 よろしくお願いします。 ### hamee_sys — 2018/05/02 ご返答ありがとうございます。 今回のお問い合わせの公開で企業情報が漏れることはないと思われますので、公開させていただければと思います。 お問い合わせ内容につきましては、下記のURLのページに記載されておりますが、利用ユーザーは管理者のみ設定可能でございます。 メイン機能（テスト環境）の利用許可がされていないユーザーは設定不可になりますので、利用許可する場合は、先にメイン機能（テスト環境）の利用を許可する必要がございます。 [http://manual.next-e.jp/screen/setting/setting_apps_companies/](http://manual.next-e.jp/screen/setting/setting_apps_companies/) また何かご不明な点がございましたらお問い合わせください。 ### ながお（質問者） — 2018/05/03 管理者というのはアプリを作り、申請した本人とは違うのでしょうか？ 私がアプリを作り、申請しております。 また私のアカウントではメイン機能（テスト環境）は利用できています。 よろしくお願いします。 ### hamee_sys — 2018/05/07 返答に時間をいただいてしまい大変申し訳ございません。 管理者は、アプリを作り申請した本人を指しているわけではなく、ネクストエンジン本体の管理者になります。 また、以前にもお伝えした通り、利用ユーザー設定は管理者のみ行うことができることに加えて、管理者は他のメンバーを管理者にすることができます。(設定→メンバー→編集) よって、管理者から管理者の権限を付与されることで、利用ユーザー設定が可能になります。 また何かご不明な点がございましたらお問い合わせください。 --- # Chrome extension の開発について URL: https://developer.next-engine.com/questions/844/ **投稿者:** k.n　**日時:** 2018/05/16 **カテゴリ:** その他 メイン機能の動作の補助のためのツールを Chrome extension 、 Firefox Addon 作成し公開したいと思っております。 利用規約を確認していますが、可とも不可とも読み取れないため、 決まっている方針があればご教示いただけると幸いです。 具体的な機能として * セットマスタの検索機能 * firefox 等で、レイアウトが崩れる部分の修正 等を考えています。 --- ## 回答 (3件) ### hamee_sys — 2018/05/18 お問い合わせありがとうございます。 大変申し訳ございませんが、仕様を確認いたしますので、少々お待ちくださいませ。 よろしくお願いいたします。 ### hamee_sys — 2018/05/21 お待たせして申し訳ございません。 Chrome extensionやFirefox Addon等を用いたアプリケーションの作成や公開等は問題ありません。 しかし、仕様変更(DOMの変更等)でのアプリケーションへの影響は責任を負いかねますのでご了承下さい。 また何かご不明点がございましたらお問い合わせください。 ### k.n（質問者） — 2018/06/01 解答ありがとうございました、FIREFOX版を公開しました。 [https://addons.mozilla.org/ja/firefox/addon/uone2x/?src=api](https://addons.mozilla.org/ja/firefox/addon/uone2x/?src=api) --- # 基幹システムとの連携における在庫の更新について URL: https://developer.next-engine.com/questions/846/ **投稿者:** 溝上　裕亮　**日時:** 2018/05/21 **カテゴリ:** ネクストエンジンAPIについて 基幹システムとの連携についてご質問です。 ネクストエンジンにて使用可能なデータ連携内容に 「在庫登録(更新)」という項目がございませんでした。 #在庫件数取得 等の検索系はございました。 ネクストエンジン上の在庫数を基幹システムを通じて更新するにはどうしたら良いか ご教授ください。 --- ## 回答 (1件) ### hamee_sys — 2018/05/24 お問い合わせありがとうございます。 お待たせしてしまい、大変申し訳ございません。 在庫更新は商品マスタアップロードAPI( [https://developer.next-engine.com/api/api_v1_master_goods/upload](https://developer.next-engine.com/api/api_v1_master_goods/upload) )にて行います。下記URLが参考になりますので、ぜひご覧ください。 [https://developer.next-engine.com/questions/501](https://developer.next-engine.com/questions/501) --- # 汎用のモールから在庫連携におけるリクエストの内容について URL: https://developer.next-engine.com/questions/852/ **投稿者:** zen　**日時:** 2018/06/07 **カテゴリ:** ネクストエンジンAPIについて 「在庫連携API仕様書.pdf」を読みましたが、質問があります。 一つの商品に対するリクエストの仕様が分かりました。 http://ストア様ドメイン名/UpdateStock.php?StoreAccount=strapya&Code=364-abc &Stock=10&ts=20120211300832&.sig=6e17b3d0a1891 同時に複数の商品の在庫を更新しなければいけない場合は、 リクエストはどうなりますか。 --- ## 回答 (1件) ### hamee_sys — 2018/06/08 こちらにつきましては、ネクストエンジン本体に関する内容になりますので、サポートセンターまでお問い合わせお願い致します。 --- # uid、state、アクセストークンの取得について URL: https://developer.next-engine.com/questions/854/ **投稿者:** jac_matsuoka　**日時:** 2018/06/11 **カテゴリ:** ネクストエンジンAPIについて FAQにはアクセストークンを取得するためにSDKなどをご利用いただき一度アクセストークンとリフレッシュトークンを取得後に、 バッチ等でアクセストークン・リフレッシュトークンを利用してくださいとありますが、 C#で使いたいのでPHP、JavaのSDKが利用できないのですが、 SDKを使用しないと初回のアクセストークン・リフレッシュトークンは取得できないのでしょうか？ --- ## 回答 (12件) ### hamee_sys — 2018/06/12 SDKを利用されなくとも、アクセストークンを取得していただくことは可能です。 下記のURLは、SDKを用いずアプリから直接HTTP(S)通信を用いて認証しAPIを使う方向けのアクセストークン取得APIについてのページです。参考にしていただければと思います。 [https://developer.next-engine.com/api/api_v1_neauth](https://developer.next-engine.com/api/api_v1_neauth) また、下記URLの認証図もアクセストークンの取得に関して参考になりますので、よろしければご覧ください。 [https://developer.next-engine.com/api/auth](https://developer.next-engine.com/api/auth) ### jac_matsuoka（質問者） — 2018/06/12 uid、stateの取得についてはやはりSDKの使用が必要ですか？ 現在uid、stateが取得方法が理解できず困っています。 ### hamee_sys — 2018/06/12 アクセストークン同様、uidとstateは共にSDKを使わなくとも取得可能でございます。 下記のURLが、SDKを利用せずに、アプリから直接HTTP(S)通信を用いて認証しAPIを使う方向けのuid・stateの取得に関するページですのでご覧ください。 [https://developer.next-engine.com/api/api_v1_sign_in](https://developer.next-engine.com/api/api_v1_sign_in) ### jac_matsuoka（質問者） — 2018/06/13 ご案内いただきましたURLは確認しています。 １．[https://base.next-engine.org/users/sign_in](https://base.next-engine.org/users/sign_in)を開き、ネクストエンジンIDとパスワードを入力してログイン ２．GETメソッドで[https://base.next-engine.org/users/sign_in/?client_id=XXXXXXXXXX&client_...](https://base.next-engine.org/users/sign_in/?client_id=XXXXXXXXXX&client_secret=WWWWWWWWW)のURLにリクエストを送信 ※client_idとclient_secretはアプリを作るにて登録したAPIタブのテスト環境設定に記載されているclient_idとclient_secretを指定しています。 　ReirectURIには「[https://localhost](https://localhost)」と設定 ２で返されるレスポンスの内容が何度やってもログイン画面のHTMLとなります。 uidとstateの正しい取得手順を教えてください。 ### hamee_sys — 2018/06/14 2でアクセスした後に表示されたログイン画面で再度ログインしていただけますでしょうか。また、ログイン後、ReirectURIへ遷移されるか、および遷移先のGetパラメータにuidとstateが返ってくるかご確認いただけますでしょうか。 ### jac_matsuoka（質問者） — 2018/06/19 一応開発環境としてはRedirectURIへのGetパラメータからuidとstateを取得できる事は確認できました。 しかし、バッチアプリケーションとして本番環境で実行する場合、バッチはRedirectURIを受ける口を持っていませんが、 どのような形で認証を行ったら良いのでしょうか？ また、本番環境のRedirectURIにはhttpsのURIのみ登録可能となっていますが、 バッチアプリケーションの場合はどのように指定したら良いでしょうか？ ### 吉川　快里 — 2019/11/29 「アクセスした後に表示されたログイン画面で再度ログイン」とありますが、GETメソッドでリクエストを送信してもログイン画面というものが表示されないのですが、 どのようにログイン画面を表示すればいいのでしょうか？ ### hamee_sys — 2018/06/20 ＞バッチアプリケーションとして本番環境で実行する場合、バッチはRedirectURIを受ける口を持っていませんが、 どのような形で認証を行ったら良いのでしょうか？ バッチでAPIを利用するには、利用されているアプリから予めアクセストークンとリフレッシュトークンを取得する必要があります。最初にWebアプリでaccess_token/refresh_tokenを取得後、DB等に保持しaccess_token/refresh_tokenを最新の状態にするような仕組みを構築することで、その後は更新された最新のaccess_token/refresh_tokenを利用することにより認証を自動化することが可能です。 APIを利用したバッチ処理について、下記のURLが非常に参考になりますのでぜひご覧ください。 [https://developer.next-engine.com/questions/551](https://developer.next-engine.com/questions/551) ＞本番環境のRedirectURIにはhttpsのURIのみ登録可能となっていますが、バッチアプリケーションの場合はどのように指定したら良いでしょうか？ バッチ処理自体はredirect_urlにアクセス必要ありませんが、最初の認証のためにuid/stateでaccess_token/refresh_tokenを取得する必要があるため、HTTPS接続できるWebサーバを用意する必要があり、そのURIを指定していただく形になります。 ### M2 — 2018/08/06 取得した「アクセストークン」と「リフレッシュトークン」の有効期限はどのくらいでしょうか？　また、切れるトリガーは有効期限以外でありますでしょうか？ 昨年から動作させて頂いたところアクセストークンは2日でリフレッシュトークンは3日にて切れているようなので、 現在は、アクセストークンが切れているときでもリフレッシュトークンが切れていないタイミングであればレスポンスに新しいアクセストークンとリフレッシュトークンが戻させるのでそれを保存し直しております。 よって今まで半年間ぐらい一度も切れていなかったのですが、8月4日13時43分にアクセストークンが切れてしまいました。（現在は再取得して復旧しました） そこで、実際のところ有効期限はどのくらいかご教授頂けますでしょうか。また、切れるトリガーが他にありますでしょうか。 ※8月4日13時43分に何かしら切れるトリガーとなった事象などございましたでしょうか。 ### hamee_sys — 2018/08/09 アクセストークンの有効期限は1日、リフレッシュトークンは3日です。
また、有効期限以外の原因によってトークンが無効になってしまうことは基本的にはございません。 >※8月4日13時43分に何かしら切れるトリガーとなった事象などございましたでしょうか。 上記の質問に関して調査をさせていただきたいのですが、それに際してトークン情報などいくつかの情報を教えていただく必要がございます。そのため、情報保護の面から非公開のスレッドでやり取りをさせていただきたいのですが、こちらのスレッドを非公開設定にすると、スレッドの作成者のみ閲覧可能となってしまい、M2様は閲覧できなくなってしまいます。お手数ですが、新しくスレッドを立ち上げるために、運営に非公開で質問をするという設定の上、再度質問を投稿していただけないでしょうか。 よろしくお願い致します。 ### 山本 正浩 — 2022/04/18 access_token と refresh_token を取得するために uid と state を取得しようとしています。 client_id と client_secret は勿論既に持っていますので、これを元に curl -k [https://base.next-engine.org/users/sign_in/?client_id=XXXXXXXXXX&client_...](https://base.next-engine.org/users/sign_in/?client_id=XXXXXXXXXX&client_secret=WWWWWWWWW) このコマンドラインに適用して実行するのですが、uid と state の応答を期待しているのにも関わらず ログイン画面用の html を取得してしまいます。 uid と state 取得を curl コマンドだけで取得するための フルコマンドラインのサンプル を教えて下さい。 ### 城所美穂 — 2023/11/17 私も同様の質問をしたいと考えておりますため、解決できていましたらご教授頂けますと幸いです。 --- # データ取得・アップロードの上限について URL: https://developer.next-engine.com/questions/857/ **投稿者:** shoshi　**日時:** 2018/06/21 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンの在庫数更新を行うにあたり、以下のAPIについて質問させてください。 ①在庫マスタ検索(/api_v1_master_stock/search) 商品コードをAPIのwhere句パラーメーターにセットして各商品の在庫数を取得したいと考えています。 この時、IN句を使用して複数商品の在庫数を一括取得したいのですが、 IN句に記述できるキーワード(商品コード)の上限数はいくつになりますでしょうか。 ②商品マスタアップロード(/api_v1_master_goods/upload) 本APIを利用して、複数商品の在庫数を一括更新したいと考えています。 パラメータのCSV部分に改行区切りで複数レコードをセットすればよい認識ですが、 このレコード数に上限はありますでしょうか。 以上、よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/06/21 ① 上限は1000個になります。下記URLに記載がありますのでご覧ください。 [https://developer.next-engine.com/api/param/operator_compare](https://developer.next-engine.com/api/param/operator_compare) ② 上限はございませんが、量が多くなる場合は、data_typeをgzにして、圧縮ファイルをアップロードしていただくことを推奨します。 ### shoshi（質問者） — 2018/06/21 承知致しました。ご回答ありがとうございます。 --- # 店舗ごとに在庫連携を行う商品の指定用APIがありますか？ URL: https://developer.next-engine.com/questions/860/ **投稿者:** cal　**日時:** 2018/06/27 **カテゴリ:** ネクストエンジンAPIについて こちらの方は中古販売なので、商品は１件しかないです。 商品マスターは頻繁に変動されています。 店舗ごとに在庫連携を行う商品指定を行うAPIがありますか？ モール商品を追加するAPIがありますか？ 教えて頂ければ幸いです。 --- ## 回答 (1件) ### hamee_sys — 2018/06/27 申し訳ございませんが、在庫連携させる商品を店舗ごとに指定するAPIはございません。 また何かありましたら、お問い合わせお願いいたします。 --- # 商品マスタが「アクセス情報[マスタ情報取得]の許可が必要です。」と表示される。 URL: https://developer.next-engine.com/questions/862/ **投稿者:** rish　**日時:** 2018/07/03 **カテゴリ:** ネクストエンジンAPIについて 開発環境で、標題の件のエラーが出ます。 ["result"]=> string(5) "error" ["code"]=> string(6) "004001" ["message"]=> string(68) "アクセス情報[マスタ情報取得]の許可が必要です。" 開発環境のクライアントIDやシークレットを利用し、マスタ情報取得のフラグも管理画面からOnしています。 Curlで接続を試みても同様でした。 他に手立てがあるでしょうか。 --- ## 回答 (2件) ### hamee_sys — 2018/07/04 記載していただいたエラーの内容を見る限り、アクセス情報の許可ができていないためかと思われます。 恐れ入りますが、再度ネクストエンジンの「アプリを作る」より、対象のアプリを選択していただき、「APIタブ」にて、マスタ情報取得の許可の設定が正しくされているかご確認いただけますでしょうか。 ### rish（質問者） — 2018/07/05 ありがとうございました。 確認する前にもう一度試したところうまくいきました。 --- # API_受注データの昇順について URL: https://developer.next-engine.com/questions/871/ **投稿者:** 野口学夫　**日時:** 2018/08/03 **カテゴリ:** ネクストエンジンAPIについて 現在、下記の方法でAPI連携の受注データをソート処理をし取得を行っていましたが、 先日確認したところソートの引数が反映されずにデータが来ておりました。 --- こちらのAPIを使用し受注データを取得しておりました。 [https://api.next-engine.org/api_v1_receiveorder_base/search](https://api.next-engine.org/api_v1_receiveorder_base/search) 引数(パラメータ)に sort=receive_order_shop_cut_form_id-asc --- API連携の受注データのソート方法に変更が入っていたりしますでしょうか。 また、他にソート方法が御座いましたら教えて頂ければ幸いです。 --- ## 回答 (3件) ### hamee_sys — 2018/08/06 受注伝票検索において、取得したデータを並び替えるパラメータは存在しません。 よって、並び替えが必要な場合は、質問者様のアプリ内でそのような機能を作成していただく形になります。 ### 野口学夫（質問者） — 2018/08/06 ご回答いただき、ありがとうございます。 現状では実現不可能な事は承知しました。 弊社都合で申し訳ないのですが、 影響範囲を試算したいと考えておりますので、以下もご質問させて頂ければ幸いです。 ・過去の仕様としては並び替えるパラメータは御座いましたでしょうか。 　また、過去に仕様として有った場合に、その機能が改修をされた日時をご教授頂ければ幸いです。 ### MSM-03C — 2019/05/14 連絡が遅くなり、申し訳ありませんでした。 現在、並び替えのパラメーターは提供しておりません。 sort機能を提供しなくなったのは2014〜2015年頃になります。 --- # 受注明細検索でのセット商品の見分け方 URL: https://developer.next-engine.com/questions/872/ **投稿者:** yuki naito　**日時:** 2018/08/08 **カテゴリ:** ネクストエンジンAPIについて 受注明細検索(/api_v1_receiveorder_row/search)で、セット商品かどうかを 見分けるには、どの項目で判断すればよろしいでしょうか。 --- ## 回答 (1件) ### hamee_sys — 2018/08/09 申し訳ございませんが、現状、APIにてセット商品かどうかを判断することはできません。 --- # 新規モール対応アプリを作成する際の注意点について URL: https://developer.next-engine.com/questions/875/ **投稿者:** cnet　**日時:** 2018/08/10 **カテゴリ:** ネクストエンジンAPIについて 新規モールの対応アプリの作成を検討しています。 モールに対し各ショップが出店しており、その出店ショップの在庫をモールに反映するためのアプリ作成を行う予定です。 APIの出力パラーメータは各出店ショップが保有しているすべてのSKU（商品コード）を参照して出力されますか？ また、こちらのアプリ作成を行うにあたり、注意点等ありましたらご教示頂けますと幸いです。 よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/08/13 記載していただいた通りでございます。 ご不明な点があった際には再度質問をしていただければと思いますので、よろしくお願い致します。 --- # 在庫APIの URL: https://developer.next-engine.com/questions/877/ **投稿者:** k.n　**日時:** 2018/08/13 **カテゴリ:** ネクストエンジンAPIについて ●エンドポイント /api_v1_master_stock/search ●質問 上記のAPIについてですが、受注による引当数の増減等によって『stock_last_modified_null_safe_date』,『stock_last_modified_date』 の値は更新されますでしょうか。 ●質問意図 一定期間中のフリー在庫が変動した商品のリストと在庫数を取得したいと考えています。 その他に良い方法があればご教示頂きたいです。 --- ## 回答 (1件) ### hamee_sys — 2018/08/13 その場合も『stock_last_modified_null_safe_date』,『stock_last_modified_date』の値は更新されます。 また、質問者様が考えている最終更新日を使うやり方が最もスムーズかと思います。 ご不明な点がございましたら再度コメントをよろしくお願い致します。 --- # 受注のキャンセルと在庫戻しおよび連携モールの再出品に関して URL: https://developer.next-engine.com/questions/878/ **投稿者:** 北島　工　**日時:** 2018/08/16 **カテゴリ:** ネクストエンジンAPIについて お世話になります。 こちらにて質問して下さいとの事ですので、下記ご教示ください。 １）受注のキャンセル後の在庫戻しに関して 　キャンセル処理自体は 　/api_v1_receiveorder_base/update 　こちらで行えそうな感じではありますが、 　現在、EC本店以外に楽天等いくつかの店舗と在庫連動を行なっております。 　商品自体が1点物のため、どこかで受注が入った場合、 　他の連携店舗は全て在庫が落ち、品切れ状態になりますが、 　受注自体がキャンセルになった場合、多店舗の在庫を戻したいのですが、 　その場合、どのような処理が必要になりますでしょうか？ 　また在庫を戻した場合、ネクストエンジンのメイン機能から手動で在庫を戻した時と同じく 　各店舗の商品が出品状態に戻りますでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2018/08/21 下記のURL内のメイン機能の説明と同じく、出荷確定処理をする前であれば、引き当てられていた商品は自動的にフリー在庫に戻り、出品されます。 [http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b017/](http://manual.ec-doc.net/operation/operation-tips/jyucyu-tips/b017/) --- # Wowmaの受注を取得すると、商品コードが正しく取得できない URL: https://developer.next-engine.com/questions/879/ **投稿者:** 秋田　訓秀　**日時:** 2018/08/20 **カテゴリ:** ネクストエンジンAPIについて ご担当者様 いつもお世話になっております。 Wowmaから取得した受注データを、 api_v1_receiveorder_row/search/ で取得しますと、 receive_order_row_goods_id が　例えば「abcdefg-BK-F」と取得されるべきところが、 「1234567890-BK-F」みたいにwowma店のロットナンバーで取得されてしまいます。 これは、こういう仕様でしたでしょうか？ 「abcdefg-BK-F」のように取得されたいのですが、 何か設定を変更すれば可能でしょうか？ 以上、ご確認お願いいたします。 ありがとうございました。 _ --- ## 回答 (1件) ### hamee_sys — 2018/08/21 メイン機能のマニュアル([http://manual.ec-doc.net/startup/dena/dd035/](http://manual.ec-doc.net/startup/dena/dd035/))にも記載がございますが、商品コード(receive_order_row_goods_id)にロットナンバーが入ってしまうのは、受注CSVファイルがアップされていないためです。 下記のURLを参考に、受注CSVファイルをアップロードしていただければ、ロットナンバーが商品コードに置き換わります。 [https://developer.next-engine.com/api/api_v1_receiveorder_base/upload](https://developer.next-engine.com/api/api_v1_receiveorder_base/upload) --- # 受注伝票明細取得について URL: https://developer.next-engine.com/questions/880/ **投稿者:** JAMSHOP WEBコンテンツ・チーム　**日時:** 2018/08/20 **カテゴリ:** ネクストエンジンAPIについて 前日と当日の受注状態が「起票済み」の受注伝票明細を取得する方法についてですが、 検索結果のフィールドに、goods_jan_code と receive_order_row_quantity を指定 検索条件に receive_order_date >= '2018-08-19' receive_order_order_status_id = 2 を指定して、 janコードに対する受注した商品数量の集計を取得しようと思いますが、 正しいでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2018/08/21 入力パラメータのフィールドに、下記のように設定していただくと、前日と当日の受注状態が「起票済」の受注明細を取得することができます。 receive_order_date >= '2018-08-19’ receive_order_order_status_id = 2 検索結果のフィールドは指定できませんので、JANコード別の受注数を取得するためには、受注明細検索にて取得したデータを合計する処理を実装していただく形となります。 --- # バッチでのAPI処理について URL: https://developer.next-engine.com/questions/881/ **投稿者:** JAMSHOP WEBコンテンツ・チーム　**日時:** 2018/08/20 **カテゴリ:** ネクストエンジンAPIについて バッチでのAPI処理について下記を参照してSDKを利用して実行してみたのですが、 「他の端末でログインしたので自動的にログアウトしました」のメッセージが表示されます。 バッチ処理用のネクストエンジンIDを用意しないといけないのでしょうか？ [https://developer.next-engine.com/faq/accesstoken](https://developer.next-engine.com/faq/accesstoken) --- ## 回答 (1件) ### hamee_sys — 2018/08/21 SDKの中で、どのようにアクセストークンとリフレッシュトークンを設定しているか、サンプルとしてコードをこちらにコメントしていただけますでしょうか。 よろしくお願い致します。 --- # 商品画像の取得について URL: https://developer.next-engine.com/questions/922/ **投稿者:** t　**日時:** 2018/08/31 **カテゴリ:** ネクストエンジンAPIについて * 前提 商品マスタに商品AとBを登録 商品Aには画像を1枚登録 (画像a) 商品Bには画像を2枚登録 (画像b、c) (登録方法は3枚とも『（β版）商品管理』からローカルの画像をアップロード) 上記の状態で、/api_v1_master_goods/searchに goods_id、goods_name、goods_1_item、goods_description_text、goods_image_url_httpsを要求したところ、 商品Aについての情報(goods_image_url_httpsは画像aについてのもの) 商品Bについての情報(goods_image_url_httpsは画像bについてのもの) 商品Bについての情報(goods_image_url_httpsは画像cについてのもの) 3件のdataが返ってきました。 dataは商品ごとにまとめられるのではなく、画像数が優先されてまとめられるのでしょうか？ --- ## 回答 (1件) ### hamee_sys — 2018/08/31 そのような仕様となっております。 --- # ゆうパック 19時〜21時の時間帯コードについて URL: https://developer.next-engine.com/questions/930/ **投稿者:** 安羅岡　陸　**日時:** 2018/09/06 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 2018/9/1よりゆうパックの配達希望時間帯に19時〜21時が新設されました。 新しい時間帯の時間帯コードについてご教示いただけないでしょうか。 以下のページはまだ更新されていないようです。 [https://manual.next-engine.net/main/orders/ord_system-renkei/11862/](https://manual.next-engine.net/main/orders/ord_system-renkei/11862/) よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/09/06 添付していただいたリンク内にコード4でご希望の時間帯指定が存在します。 また、こちら、メイン機能の質問になりますので、お手数ですがサポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 ### 安羅岡　陸（質問者） — 2018/09/07 ご回答ありがとうございます。 サポートの方に問い合わせさせていただきます。 ※サポートに問い合わせたところ、時間帯コードは57とのことでした。 --- # 商品ページ（基本）検索API URL: https://developer.next-engine.com/questions/932/ **投稿者:** scp_dev　**日時:** 2018/09/06 **カテゴリ:** ネクストエンジンAPIについて 提供されている下記APIについて質問です。このAPIを実行しても値を取得することができません。 １． [https://developer.next-engine.com/api/api_v1_master_pagebase/search](https://developer.next-engine.com/api/api_v1_master_pagebase/search) 下記APIで件数を取得しても「0」件となりますが、データの登録は０ではありません。 ２． [https://developer.next-engine.com/api/api_v1_master_pagebase/count](https://developer.next-engine.com/api/api_v1_master_pagebase/count) これらのフィールド一覧の項目を見ると（β版）ページ情報の項目と共通のものが多いです。 別の方の投稿で [https://developer.next-engine.com/questions/699](https://developer.next-engine.com/questions/699) 「（β版）商品情報と（β版）ページ情報はAPIでは取得することはできません。」と回答されております。 １．は（β版）ページ情報の取得APIなのでしょうか？ もしそうなら、「APIで取得することはできない」と回答されているのに、なぜリクエストURL一覧に掲載されているのでしょうか？ 違うのならば、１．のAPIは何を取得するものなのでしょうか？取得件数が「0」になるのはなぜでしょうか？ 取得するには、どういった情報の登録が必要になるのでしょうか？ 自社店舗サイトへ１．のフィールド項目をAPIで同期させる必要があります。 多くの質問となりましたが、各質問へのご回答よろしくお願いいたします。 --- ## 回答 (3件) ### hamee_sys — 2018/09/06 ＞１．は（β版）ページ情報の取得APIなのでしょうか？ β版ページ情報の取得APIではございません。 ＞違うのならば、１．のAPIは何を取得するものなのでしょうか？取得件数が「0」になるのはなぜでしょうか？ β版ではなく、商品ページのページ管理で登録されたデータを取得するためのAPIです。 ＞取得するには、どういった情報の登録が必要になるのでしょうか？ β版ではなく、商品ページのページ管理で登録することで取得できるようになります。 ### scp_dev（質問者） — 2018/09/07 各質問へのご回答ありがとうございました。 >β版ではなく、商品ページのページ管理で登録することで取得できるようになります。 ご回答通りに商品ページのページ管理にデータ登録後、１．のAPIで正しい結果を取得することを確認できました。 別件になりますが、（β版）ページ情報のAPIの公開のご予定はどのようになっておりますでしょうか？ ご回答いただけると幸いです。よろしくお願いいたします。 ### hamee_sys — 2018/09/13 >（β版）ページ情報のAPIの公開のご予定はどのようになっておりますでしょうか？ 誠に申し訳ございません。 今のところAPI公開予定はございません。 --- # 発送状況の確認について URL: https://developer.next-engine.com/questions/933/ **投稿者:** t　**日時:** 2018/09/06 **カテゴリ:** ネクストエンジンAPIについて ネクストエンジンAPIを用いて、特定の伝票に対する配送状況を確認する方法はございますか？ 例）出荷済み、配送中、配送完了 など --- ## 回答 (4件) ### hamee_sys — 2018/09/06 受注伝票検索にて出荷済みであることの確認はできます。配送中や配送完了といった配送状況についてはネクストエンジンでは管理しておりません。配送業者に確認する必要があります。 ### t（質問者） — 2018/09/07 ご回答ありがとうございます。 配送状況の確認ができない事について承知しました。 次いでですが、受注伝票検索APIのどのフィールドに出荷済みなどの情報が入っているのかご教示いただけますか？ ### t（質問者） — 2018/09/07 重複のため削除 ### hamee_sys — 2018/09/11 >受注伝票検索APIのどのフィールドに出荷済みなどの情報が入っているのかご教示いただけますか？ 受注状態区分(receive_order_order_status_id)で出荷済みかどうかを判定可能です。 出荷済みの値は50になります。 --- # 受注伝票検索について URL: https://developer.next-engine.com/questions/934/ **投稿者:** t　**日時:** 2018/09/07 **カテゴリ:** ネクストエンジンAPIについて 受注伝票検索APIのどのフィールドに出荷済みなどの情報が入っているのかご教示いただけますか？ --- ## 回答 (1件) ### hamee_sys — 2018/09/11 出荷済みかどうかについては、受注伝票検索APIのレスポンスの受注状態区分(receive_order_order_status_id)を参照して下さい。 { "order_status_id":"0", "order_status_name":"取込情報不足" }, { "order_status_id":"1", "order_status_name":"受注メール取込済" }, { "order_status_id":"2", "order_status_name":"起票済(CSV\/手入力)" }, { "order_status_id":"20", "order_status_name":"納品書印刷待ち" }, { "order_status_id":"30", "order_status_name":"納品書印刷中" }, { "order_status_id":"40", "order_status_name":"納品書印刷済" }, { "order_status_id":"50", "order_status_name":"出荷確定済（完了）" } --- # 受注メールのsubject指定について URL: https://developer.next-engine.com/questions/941/ **投稿者:** 塩見　**日時:** 2018/09/19 **カテゴリ:** その他 受注取り込みメールについて質問させてください。 現在「汎用」でネクストエンジンと連携を予定しているのですが 汎用の受注メールでは本文のフォーマット指定がありますがsubjectについては特に指定はないのですが ・subjectの指定は不要なのか ・subjectを指定した場合、正しく処理されるのか についてご教唆いただけますでしょうか --- ## 回答 (1件) ### hamee_sys — 2018/09/20 こちら、メイン機能の質問になりますので、お手数ですが、サポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 --- # 汎用モールでの在庫連携対象商品数について URL: https://developer.next-engine.com/questions/944/ **投稿者:** cnet　**日時:** 2018/09/20 **カテゴリ:** 開発環境・SDKについて 2点質問させて頂きます。 1．汎用モールにて在庫連携を行う際に参照する商品は、在庫連携対象商品のうち全商品が参照元となりますか？ それとも注文があった等の動きがあった商品一部が参照元となる形でしょうか？ 2．初回の在庫連携時に商品数が複数商品あった場合、どのように在庫連携されますか？ 以上よろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/09/21 こちら、メイン機能の質問になりますので、お手数ですが、サポートまでお問い合わせ頂ければと思います。 よろしくお願い致します。 --- # Shopifyアプリについて URL: https://developer.next-engine.com/questions/947/ **投稿者:** JAMSHOP WEBコンテンツ・チーム　**日時:** 2018/09/26 **カテゴリ:** その他 Shopifyアプリが出荷金額の2％費用が掛かります。 弊社で新たにShopify連携アプリを作成すればAPI費用のみで使用できるという認識で大丈夫でしょうか？ また独自に開発しない方が良い理由があれば教えていただければと思います。 ネクストエンジンサポートから詳細はこちらでお願いしますと言われましたので、 宜しくお願い致します。 --- ## 回答 (5件) ### hamee_sys — 2018/09/27 Shopify連携アプリを独自に開発することを推奨していないということはございません。 しかし、現状のネクストエンジンAPIで公開されているエンドポイントでは実装できない機能もございます。 ### JAMSHOP WEBコンテンツ・チーム（質問者） — 2018/09/27 今のshopifyアプリは主に下記機能だと思うのですが、自社で実現できない機能はどれになりますでしょうか？ ・受注取込 ・出荷確定後の連携 ・在庫連携 ### hamee_sys — 2018/10/11 回答が遅くなりまして申し訳ございません。 確認いたしますので、少々お待ちください。 ### hamee_sys — 2018/10/17 JAMSHOP WEBコンテンツ・チーム様 連絡が度々遅れてしまいましたこと、お詫び申し上げます。 上記の件ですが、アプリの内部の仕様につきましては、大変恐縮ですが、お答えいたしかねます。 現状のネクストエンジンAPIで公開されているエンドポイントでの範囲での開発をしていただけるということしか、こちらからお伝えいたしかねます。 ご理解のほど、何卒お願い申しあげます。 ### rck — 2019/06/17 . --- # SSL証明書の種類について URL: https://developer.next-engine.com/questions/961/ **投稿者:** 会田 哲也　**日時:** 2018/10/09 **カテゴリ:** その他 ・ネクストエンジンのカスタマイズアプリを外注で開発しております。 ・アプリ設置サーバーを弊社社内に設置予定です。 ・ネクストエンジン⇔弊社サーバーの通信にSSL証明書の認証が必要です。 (1)上記のような状況で 御社への通信のSSL証明書の種類について（認証方法別：DV・OV・EV） ポピュラーなものは何になりますでしょうか。 (2) ドメイン認証型（DV）で問題ございませんでしょうか。 ご多忙のところ恐れいりますが、ご回答よろしくお願いいたします。 --- ## 回答 (2件) ### hamee_sys — 2018/10/09 特に標準のものはございません。 また、ドメイン認証型で問題ございません。 ### 会田 哲也（質問者） — 2018/10/09 ご回答ありがとうございました。 大変助かりました。 --- # ネクストエンジンの通信に使うセキュリティレベルと　ファイアウォールの穴あけ URL: https://developer.next-engine.com/questions/966/ **投稿者:** 会田 哲也　**日時:** 2018/10/11 **カテゴリ:** ネクストエンジンAPIについて ・ネクストエンジン⇔楽天市場の受注取込やAPIの通信に使うセキュリティは 何を使ってますでしょうか（SSL証明書の種類） ・またカスタマイズアプリとネクストエンジンの通信をするのに ファイアウォールの穴をあけるには何で開けたらよろしいでしょうか。 --- ## 回答 (4件) ### hamee_sys — 2018/10/11 >楽天市場の受注取込やAPIの通信に使うセキュリティは何を使ってますでしょうか（SSL証明書の種類） HTTPS通信で行なっています。 >またカスタマイズアプリとネクストエンジンの通信をするのにファイアウォールの穴をあけるには何で開けたらよろしいでしょうか カスタマイズアプリからネクストエンジンAPIへの通信にはHTTPSを行なっていますので、カスタマイズアプリが配置されているサーバから以下URLへのアクセスが可能な状態で設定をお願いします。 [https://base.next-engine.org](https://base.next-engine.org) [https://api.next-engine.org](https://api.next-engine.org) また、ネクストエンジンからカスタマイズアプリへの通信は行いません。 ### 会田 哲也（質問者） — 2018/10/12 ご回答ありがとうございます。 下記4サイトとネクストエンジンのHTTPS通信の ・楽天市場 ・yahooショッピング ・アマゾン ・旧Wowma ・Wow!manager SSL証明書は下記のうちどれですか？ ドメイン認証（DV: Domain Validation）型SSLサーバ証明書 企業認証（OV: Organization Validation）型SSLサーバ証明書 EV（Extended Validation） SSL証明書 ご多忙のところ恐れいりますが、ご回答よろしくお願いいたします。 ### hamee_sys — 2018/10/12 こちらに関してはメイン機能に関する内容になりますのでサポートまでお問い合わせください。 ### 会田 哲也（質問者） — 2018/10/15 かしこまりました。 ご回答ありがとうございました。 --- # APIで連携するにあたり、最短のバッチ間隔 URL: https://developer.next-engine.com/questions/968/ **投稿者:** 溝上　裕亮　**日時:** 2018/10/15 **カテゴリ:** ネクストエンジンAPIについて APIで連携するにあたり、ネクストエンジン上で可能な最短のバッチ間隔を教えてください。 例えば1分間隔や15分間隔など。 --- ## 回答 (1件) ### hamee_sys — 2018/10/17 ご連絡ありがとうございます。 APIにてバッチ最短の間隔というものは特にございません。 ただし並列でのリクエストは推奨しておりませんので、ご留意ください。 また過度に大量のリクエストをあった場合、運営側の判断で制限をかけさせていただく場合もございますので、 恐縮ではございますが、ご理解のほどよろしくお願い申し上げます。 --- # 受注伝票アップロードAPIについて URL: https://developer.next-engine.com/questions/972/ **投稿者:** ken-mashi　**日時:** 2018/10/17 **カテゴリ:** ネクストエンジンAPIについて 受注伝票アップロードAPIを利用して開発をしているのですが、 受注伝票を取り込んだ際に、「支払方法」欄が「その他」でデータ準備しているにも関わらず、 「ポイント全額支払い」に設定されるようです。 今回、在庫引当を目的としていた為、金額を　0円　で連携している為、 “ポイント利用" とシステム判断されて変換されているということでしょうか？ ご確認頂けますと幸いです。 --- ## 回答 (1件) ### hamee_sys — 2018/10/17 ご連絡ありがとうございます。 おっしゃるとおりでございます。 金額が0円の場合、ポイント支払いが適用されてしまいます。 --- # 審査時のRedirect URIについて URL: https://developer.next-engine.com/questions/974/ **投稿者:** miyavix　**日時:** 2018/10/17 **カテゴリ:** その他 お世話になります。 サポートよりこちらで質問しろとのことですので、お問い合わせです。 現在メイン環境と社外アプリの中継を行う弊社アプリを申請中ですが、その際 接続先となるメイン環境はテスト用と本番用では切り替えを行います(別の アプリになる)。 一旦テスト用で審査が承認された本番環境設定の"Redirect URI"と、次に申請を 行う本番用での"Redirect URI"は同じ箇所を設定しても問題がないでしょうか？ ※ちなみにテスト用というのは、APIタブの「テスト環境設定」のことではなく 基本タブの「接続先メイン機能」で選択するメイン機能のことです。 --- ## 回答 (2件) ### hamee_sys — 2018/10/18 ご質問ありがとうございます。 テスト用審査と本番環境のRedirect URIは同じでも問題ありません。 ### miyavix（質問者） — 2018/10/18 ご回答ありがとうございます。 それでは同じ"Redirect URI"で申請させていただきます。 --- # 商品一括登録について URL: https://developer.next-engine.com/questions/975/ **投稿者:** アクティブサポート　**日時:** 2018/10/17 **カテゴリ:** その他 商品マスタ一括登録の画面で、ネクストエンジン上の在庫を更新するために商品マスタＣＳＶの ファイルアップロードをしています。 このとき、アップロード直後に上部に　「正常に２件登録しました。」など表示されるのですが、 ファイル内容によりメッセージが変わります。 メッセージにより、結果を自動で把握したいので、全メッセージを知りたいのですが、 どこかに書いてありますでしょうか？ 種類が多すぎるようなら、正常終了時の場合のみでもかまいません。 正常終了メッセージを確認して送信ファイルを削除したいので。 よろしくお願いします。 --- ## 回答 (3件) ### hamee_sys — 2018/10/18 お問い合わせありがとうございます。 こちらメイン機能に関する内容になりますので、サポートまでお問い合わせください。 ### アクティブサポート（質問者） — 2018/10/18 ネクストエンジンのサポートに電話で問い合わせたところ、メッセージ全パターンは開発でないと分からないので、コミュニティで聞くように言われ、ここを教えてもらいました。 ### hamee_sys — 2018/10/19 大変失礼いたしました。 以下回答となります。 メイン機能のメッセージ一覧を提出することはできません。(今後、メッセージを変更する可能性があります) --- # PHP SDK の「access_token取得APIを更新」対応 URL: https://developer.next-engine.com/questions/978/ **投稿者:** seasoft　**日時:** 2018/10/18 **カテゴリ:** ネクストエンジンAPIについて [https://developer.next-engine.com/](https://developer.next-engine.com/) にて、案内されている、下記のお知らせについて教えてください。 > お知らせ > NEログインaccess_token取得APIを更新しました。パラメータclient_id, client_secretを追加しました。 > 2018/11/1以降、client_id, client_secretは必須となります。更新以前の方法で使用されている方は、期日までにご対応をお願い致します。 > SDKをご利用の方は今回の更新に対応済みのSDK(ver1.1)を用意しておりますのでご利用ください。 【質問】 旧バージョンの SDK を利用している場合、SDK を新バージョンに入れ替えるのみで宜しいでしょうか? --- ## 回答 (1件) ### hamee_sys — 2018/10/19 お問い合わせありがとうございます。 SDKを修正されていなければ問題ございません。 --- # APIから、仕入先マスタに新しく仕入先を登録することは可能でしょうか。 URL: https://developer.next-engine.com/questions/979/ **投稿者:** 徳山　貴樹　**日時:** 2018/10/22 **カテゴリ:** ネクストエンジンAPIについて 仕入先マスタに仕入先を追加登録したいのですが、APIから可能でしょうか。 --- ## 回答 (1件) ### hamee_sys — 2018/10/22 大変申し訳ございませんが、仕入れ先登録のためのAPIはただいまご用意がございません。 何卒よろしくお願いいたします。 --- # 出荷確定処理の一括処理 URL: https://developer.next-engine.com/questions/982/ **投稿者:** 有澤和哉　**日時:** 2018/10/23 **カテゴリ:** ネクストエンジンAPIについて 伝票更新の /api_v1_receiveorder_base/updateの一括処理版 /api_v1_receiveorder_base/bulkupdateが存在するが 出荷確定処理の /api_v1_receiveorder_base/shippedの一括処理版 は存在しないのか。 存在するなら教えてください。 また、存在しない場合毎回APIを呼び出す必要があるのか。APIの回数が増えることになりAPI接続の費用が増えることになるのか。 以上のことをよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/10/24 ご投稿ありがとうございます。 api_v1_receiveorder_base/shippedですが、一括処理apiの提供はございません。１伝票ごとの処理となります。 ＞また、存在しない場合毎回APIを呼び出す必要があるのか。APIの回数が増えることになりAPI接続の費用が増えることになるのか。 はい、ご認識のとおりでございます。何卒よろしくお願い申し上げます。 --- # Java SDKのバージョンについて URL: https://developer.next-engine.com/questions/986/ **投稿者:** 権田　**日時:** 2018/10/24 **カテゴリ:** 開発環境・SDKについて 事情がありJDK1.6環境で実行したいのですが、 1.7以上のものしか提供されていません。 JDK1.6で動作するSDKをご提供いただくことは可能でしょうか？ --- ## 回答 (2件) ### hamee_sys — 2018/10/26 大変申し訳ございませんが、弊社より1.6対応のSDKを提供することはいたしかねます。別の方法といたしまして、SDKをダウンロード後に、Javaのビルドバージョンに関してbuild.gradleのCompatibility を変更しGradleでbuildすることで Java のバージョンを変更可能です。 現在の公開のバージョンは以下が設定されていますので、1.6 を使用する場合は変更して再ビルドしてください。 sourceCompatibility = 1.8 targetCompatibility = 1.8 Gradleは自身でインストールいただく必要がありますので、何卒よろしくお願いたします。 ### 権田（質問者） — 2018/10/26 ご確認ありがとうございます。 承知いたしました。 --- # 操作詳細の値を参照・取得は可能でしょうか？ URL: https://developer.next-engine.com/questions/989/ **投稿者:** システムチーム　**日時:** 2018/10/26 **カテゴリ:** ネクストエンジンAPIについて お世話になっております。 ご質問失礼いたします。 受注伝票　＞　メニュー　＞　履歴　＞　操作履歴（R） 上記より閲覧できる、操作詳細の値を元に処理を行うアプリを作成したいと思っております。 操作詳細の値を参照・取得するにはどのようにすればよろしいでしょうか？ ご教示のほどよろしくお願いいたします。 --- ## 回答 (1件) ### hamee_sys — 2018/10/29 お問い合わせありがとうございます。 操作詳細のアプリケーションは操作詳細の取得APIが存在しませんので不可となります。 --- # 同梱について URL: https://developer.next-engine.com/questions/990/ **投稿者:** NSN　**日時:** 2018/10/29 **カテゴリ:** ネクストエンジンAPIについて 同梱について質問させてください。 ネクストエンジンの店舗内で同梱した後に、店舗をまたいで同梱したいのですが、 APIから同梱することは可能でしょうか。 よろしくおねがいします。 --- ## 回答 (3件) ### hamee_sys — 2018/10/29 ご投稿ありがとうございます。 [https://manual.next-engine.net/main/orders/ord_denpyo/j-denpyo_koushin/1...](https://manual.next-engine.net/main/orders/ord_denpyo/j-denpyo_koushin/11161/) に記載がございますように、受注伝票の同梱は同店舗内のみ可能でございます。 恐れ入りますが、何卒よろしくお願いいたします。 ### NSN（質問者） — 2018/10/30 同梱は同店舗内のみについて、承知しました。 同店舗内であればAPIから同梱できるものと考えてよろしいでしょうか。 その場合、方法をご教示いただけますと幸いです。 よろしくおねがいします。 ### hamee_sys — 2018/11/01 左様でございます。 その場合、受注伝票更新API( [https://developer.next-engine.com/api/api_v1_receiveorder_base/update](https://developer.next-engine.com/api/api_v1_receiveorder_base/update) ) また受注伝票一括更新API( [https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate](https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate) ) をご利用いただき、片方の伝票をキャンセルした上で、もう片方の伝票にその項目を追加していたただく形で同梱処理が可能でございます。 --- # 在庫数の更新について URL: https://developer.next-engine.com/questions/996/ **投稿者:** jac_matsuoka　**日時:** 2018/11/02 **カテゴリ:** ネクストエンジンAPIについて APIにて商品の在庫数を更新する時に、受注伝票で既に引き当てされている商品があった場合、 在庫数を0に更新したらどうなりますでしょうか？ ・在庫数がマイナスになりますか？ ・更新処理が失敗しますか？ --- ## 回答 (1件) ### hamee_sys — 2018/11/05 お問い合わせありがとうございます。 更新処理エラーや、在庫マイナスになることはなく、在庫が0になります。