# 受注確認内容 — ネクストエンジン API

> 受注確認内容 カテゴリの API endpoint (3 件) を集約したファイル。
> インデックス: https://developer.next-engine.com/llms.txt | 全文: https://developer.next-engine.com/llms-full.txt

---

# 受注確認内容件数取得
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/) を参照してください。

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_confirm_count/`](/openapi/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/) を参照してください。

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_confirm_search/`](/openapi/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を実行して下さい。 | 確認内容を再検索して最新の日時を取得してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_confirm_update/`](/openapi/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`