### Request Example for Tax Category Info Source: https://developer.next-engine.com/api/api_v1_system_tax/info This example shows how to construct a request to the API to get tax category information. Ensure you replace 'xxxxxxxxxxxxxx' with your actual access and refresh tokens. ```bash 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_tax/info" ``` -------------------------------- ### Get Payment Methods Source: https://developer.next-engine.com/api/api_v1_system_paymentmethod/info This example demonstrates how to retrieve a list of all payment methods using a POST request. ```APIDOC ## POST /api_v1_system_paymentmethod/info ### Description Retrieves a list of all available payment methods. ### Method POST ### Endpoint https://api.next-engine.org/api_v1_system_paymentmethod/info ### Parameters #### Query Parameters - **access_token** (string) - Required - Your API access token. - **refresh_token** (string) - Required - Your API refresh token. - **wait_flag** (integer) - Optional - If set to 1, the request will wait until the process is complete. ### Request Example ```curl 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" ``` ### Response #### Success Response (200) - **result** (string) - Indicates the success or failure of the request. - **count** (string) - The total number of payment methods returned. - **data** (array) - An array of payment method objects. - **payment_method_id** (string) - The unique identifier for the payment method. - **payment_method_name** (string) - The name of the payment method. - **access_token** (string) - The updated access token. - **access_token_end_date** (string) - The expiration date of the access token. - **refresh_token** (string) - The updated refresh token. - **refresh_token_end_date** (string) - The expiration date of the refresh token. #### Response Example ```json { "result":"success", "count":"47", "data":[ { "payment_method_id":"0", "payment_method_name":"クレジットカード" }, { "payment_method_id":"1", "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" } ``` ``` -------------------------------- ### Response Example Source: https://developer.next-engine.com/api/api_v1_master_shop/mailaddress This is an example of a successful response from the API. It includes the result, the shop ID, the receive order mail address, and updated access and refresh tokens with their expiration dates. ```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" } ``` -------------------------------- ### Search Goods Request Example Source: https://developer.next-engine.com/api/api_v1_master_goods/search This example demonstrates how to make a POST request to search for goods. It includes parameters for authentication, fields to retrieve, filtering by goods ID, and pagination. ```curl 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 ``` -------------------------------- ### Example Multilingual Language File (ja/page.yml) Source: https://developer.next-engine.com/tutorial/sample-fuelphp/controller-base This is an example of a language file (`page.yml` for Japanese) demonstrating how to structure key-value pairs for different page elements. You can define your own key naming conventions for project-specific needs. ```yaml error: title: '内部エラーが発生しました' suggestion: 'お手数ですが、サポートにお問い合わせ下さい' support_page: 'お問い合わせ | ネクストエンジン' maintenance: title: 'メイン機能、ネクストエンジンがメンテナンス中です' suggestion: 'お手数ですが、しばらく時間をおいてからアクセスして下さい' congestion: title: 'システムが混み合っています' suggestion: 'お手数ですが、しばらく時間をおいてからアクセスして下さい' ``` -------------------------------- ### Shop Creation XML Sample Source: https://developer.next-engine.com/api/api_v1_master_shop/create This is a sample XML structure for creating a new shop. Ensure all required fields are populated. ```xml 1 楽天店 raku スマホグッズ 1 1 1 login_id password 13 ``` -------------------------------- ### Request Example for Important Check Division Info Source: https://developer.next-engine.com/api/api_v1_system_importantcheck/info This example shows how to construct a GET request to the API endpoint for retrieving important check division information. Ensure you replace 'xxxxxxxxxxxxxx' with your actual access and refresh tokens. ```bash 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ https://api.next-engine.org/api_v1_system_importantcheck/info ``` -------------------------------- ### Search System Queues (POST Request) Source: https://developer.next-engine.com/api/api_v1_system_que/search Use this example to perform a POST request to search system queues. Ensure you replace 'xxxxxxxxx' with your actual access and refresh tokens. The 'fields' parameter specifies which queue attributes to retrieve. Offset and limit control pagination. ```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 ``` -------------------------------- ### Get Set Stock Master Count Response Example Source: https://developer.next-engine.com/api/api_v1_master_setstock/count This is an example of a successful JSON response from the count endpoint. It includes the result status, the total count of matching records, and updated authentication tokens with their expiry dates. ```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" } ``` -------------------------------- ### Get Set Stock Master Count Request Example Source: https://developer.next-engine.com/api/api_v1_master_setstock/count This example demonstrates how to make a POST request to the count endpoint using curl. Ensure you replace 'xxx' with your actual access and refresh tokens. The `wait_flag` parameter can be used to control behavior under high load. ```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 ``` -------------------------------- ### Warehouse Master Search Request Example Source: https://developer.next-engine.com/api/api_v1_warehouse_base/search This example demonstrates how to make a POST request to search for warehouse masters. It includes parameters for authentication, filtering by warehouse ID, selecting specific fields, and pagination. ```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 ``` -------------------------------- ### Search Orders using Java SDK Source: https://developer.next-engine.com/search/node//api_v1_receiveorder_base/search%20type%3Aforum?page=2 Example of how to use the Java SDK to search for orders via the API. Ensure the SDK is properly initialized before making calls. ```java HashMap result = client.apiExecute(" /api_v1_receiveorder_base/search ", api_params); ``` -------------------------------- ### Get Inventory Master Count Response Source: https://developer.next-engine.com/api/api_v1_master_keepstock/count This is an example of a successful JSON response from the API, indicating the result and the total count of matching inventory master records. ```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" } ``` -------------------------------- ### API Call for Payout Info with wait_flag=1 Source: https://developer.next-engine.com/search/node/wait_flag?page=12 This example demonstrates an API call to get system payout information. The 'wait_flag=1' parameter is used, likely for a synchronous operation. ```bash curl -X POST -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&**wait_flag** =1' \ https://api.next-engine.org/api_v1_system_payout/info ``` -------------------------------- ### sample_api_v1_master_shop_create Source: https://developer.next-engine.com/search/node/wait_flag?page=14 Creates new shop master data. Includes parameters for data and testing, with 'wait_flag' availability. ```APIDOC ## POST api_v1_master_shop/create ### Description Creates new shop master data. Supports `wait_flag`, `test_flag`, and `data` parameters. ### Method POST ### Endpoint /api_v1_master_shop/create ### Parameters #### Request Body - **access_token** (string) - Required - Access token for authentication. - **refresh_token** (string) - Required - Refresh token for authentication. - **wait_flag** (integer) - Optional - Flag to indicate waiting status. - **test_flag** (integer) - Optional - Flag to indicate a test creation. - **data** (string) - Required - The data payload for the new shop. ``` -------------------------------- ### API v1 Master Shop Create with Wait Flag Source: https://developer.next-engine.com/search/node/wait_flag?page=14 Example of calling the api_v1_master_shop/create endpoint. Includes wait_flag, test_flag, and data. ```bash curl -X POST -d 'access_token=xxx&refresh_token=xxx&wait_flag =1&test_flag=1&data=xxx' ... ``` -------------------------------- ### API Call for Confirm Check Info with wait_flag=1 Source: https://developer.next-engine.com/search/node/wait_flag?page=12 This example demonstrates an API call to get system confirm check information. The 'wait_flag=1' parameter is used, likely for a synchronous operation. ```bash curl -X POST -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&**wait_flag** =1' \ https://api.next-engine.org/api_v1_system_confirmcheck/info ``` -------------------------------- ### sample_api_v1_system_tax_info Source: https://developer.next-engine.com/search/node/wait_flag?page=11 Retrieves information about system taxes, accepting a 'wait_flag' parameter. ```APIDOC ## sample_api_v1_system_tax_info ### Description Retrieves information about system taxes. This endpoint accepts a `wait_flag` parameter. ### Method POST (inferred from -d) ### Endpoint "https://api.next-engine.org/api_v1_system_tax/info" ### Parameters #### Query Parameters - **wait_flag** (integer) - Optional - A flag to indicate waiting status. #### Request Body - **access_token** (string) - Required - Access token for authentication. - **refresh_token** (string) - Required - Refresh token for authentication. ``` -------------------------------- ### Acquire Access Token using UID and State Source: https://developer.next-engine.com/comment/80 After obtaining the uid and state, use the access_token acquisition API to get the access token. Refer to the API usage guide for details. ```java access_token取得APIでアクセストークンを取得します。 ``` -------------------------------- ### sample_api_v1_system_itemname_info Source: https://developer.next-engine.com/search/node/wait_flag?page=11 Retrieves information about system item names, accepting a 'wait_flag' parameter. ```APIDOC ## sample_api_v1_system_itemname_info ### Description Retrieves information about system item names. This endpoint accepts a `wait_flag` parameter. ### Method POST (inferred from -d) ### Endpoint "https://api.next-engine.org/api_v1_system_itemname/info" ### Parameters #### Query Parameters - **wait_flag** (integer) - Optional - A flag to indicate waiting status. #### Request Body - **access_token** (string) - Required - Access token for authentication. - **refresh_token** (string) - Required - Refresh token for authentication. ``` -------------------------------- ### Get Customer Type Info Response Source: https://developer.next-engine.com/api/api_v1_system_customertype/info This is an example of a successful JSON response when retrieving customer type information. It includes the result status, count of records, and the data array containing customer type details. ```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" } ``` -------------------------------- ### Get Division Stock Master Count with wait_flag Source: https://developer.next-engine.com/search/node/wait_flag This example retrieves the count of division stock master data. It utilizes 'wait_flag' set to 1 and includes options for access token, refresh token, and a 'keep_stock_name-like' filter. ```bash no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag =1 -F keep_stock_name-like=test ``` -------------------------------- ### sample_api_v1_system_merchandise_info Source: https://developer.next-engine.com/search/node/wait_flag?page=11 Retrieves information about system merchandise, accepting a 'wait_flag' parameter. ```APIDOC ## sample_api_v1_system_merchandise_info ### Description Retrieves information about system merchandise. This endpoint accepts a `wait_flag` parameter. ### Method POST (inferred from -d) ### Endpoint "https://api.next-engine.org/api_v1_system_merchandise/info" ### Parameters #### Query Parameters - **wait_flag** (integer) - Optional - A flag to indicate waiting status. #### Request Body - **access_token** (string) - Required - Access token for authentication. - **refresh_token** (string) - Required - Refresh token for authentication. ``` -------------------------------- ### Get Product Tag Count with wait_flag Source: https://developer.next-engine.com/search/node/wait_flag This example shows how to retrieve the count of product tags. It includes the 'wait_flag' parameter set to 1, indicating a specific processing mode. Ensure to check the output parameters for success. ```bash -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag =1&goods_tag_deleted_flag-eq=0' ```