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

## 関連リンク

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

## 関連リンク

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

## 関連リンク

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