# 拠点在庫マスタ — ネクストエンジン 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_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/) を参照してください。

## 関連リンク

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

---

# 拠点在庫マスタ件数取得
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/) を参照してください。

## 関連リンク

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

## 関連リンク

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