商品に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/product/{id}
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/product
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|
| 1 | tenant | ○ | string | - | 会社ID |
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|
| 1 | products.product.product_category | | 所属カテゴリ | string | 所属カテゴリマスタの選択肢名
マスタ選択肢の取得方法 |
| 2 | products.product.product_name | | 商品名 | string | |
| 3 | products.product.product_name_designation | | 商品名(呼称) | string | |
| 4 | products.product.unit_price | | 単価 | number | |
| 5 | products.product.product_picture | | 商品画像 | object | |
| - fileid | | ファイルID | string | 事前にcmsにアップロードしたfileIdを指定 |
| 6 | products.product.is_available | | 使用可否 | boolean | true もしくは false |
| 7 | products.product.memo | | メモ | string | |
| 8 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
{
"products.product.product_category": "全商品",
"products.product.product_name": "Cloudサービス",
"products.product.product_name_designation": "年間契約",
"products.product.unit_price": 2500000.0,
"products.product.product_picture": {
"fileid": "962e935f1b3c4b9b90b5defce5147ef7"
},
"products.product.is_available": true,
"products.product.memo": "メモ"
}
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/product/{id}
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|
| 1 | products.product.product_category | | 所属カテゴリ | string | 所属カテゴリマスタの選択肢名
マスタ選択肢の取得方法 |
| 2 | products.product.product_name | | 商品名 | string | |
| 3 | products.product.product_name_designation | | 商品名(呼称) | string | |
| 4 | products.product.unit_price | | 単価 | number | |
| 5 | products.product.product_picture | | 商品画像 | object | |
| - fileid | | ファイルID | string | 事前にcmsにアップロードしたfileIdを指定 |
| 6 | products.product.is_available | | 使用可否 | boolean | true もしくは false |
| 7 | products.product.memo | | メモ | string | |
| 8 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
{
"products.product.product_category": "全商品",
"products.product.product_name": "Cloudサービス",
"products.product.product_name_designation": "年間契約",
"products.product.unit_price": 3000000.0,
"products.product.product_picture": {
"fileid": "962e935f1b3c4b9b90b5defce5147ef7"
},
"products.product.is_available": true,
"products.product.memo": "メモ"
}
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/product/{id}
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|
| 1 | products.product.id | 商品ID | number | |
| 2 | products.product.product_category | 所属カテゴリ | string | カテゴリマスタの値 |
| 3 | products.product.product_name | 商品名 | string | |
| 4 | products.product.product_name_designation | 商品名(呼称) | string | |
| 5 | products.product.unit_price | 単価 | number | |
| 6 | products.product.product_picture | 商品画像 | object | |
| - fileid | ファイルID | string | 取得したfileIdを使って、cmsからファイルをダウンロード可能 |
| - filename | ファイル名 | string | |
| 7 | products.product.is_available | 使用可否 | boolean | true もしくは false |
| 8 | products.product.memo | メモ | string | |
| 9 | system_reg_date | 登録日 | string | "yyyy/MM/dd HH:mm"形式 ※取得のみ |
| 10 | system_reg_user | 登録ユーザー | number | 登録者ユーザーID ※取得のみ |
| 11 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ |
| 12 | system_upd_date | 更新日 | string | "yyyy/MM/dd HH:mm"形式 ※取得のみ |
| 13 | system_upd_user | 最終更新ユーザー | number | 最終更新者ユーザーID ※取得のみ |
| 14 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID ※取得のみ |
| 15 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
{
"products.product.id": 123,
"products.product.product_category": "全商品",
"products.product.product_name": "Cloudサービス",
"products.product.product_name_designation": "年間契約",
"products.product.unit_price": 3000000.0,
"products.product.product_picture": {
"fileid": "962e935f1b3c4b9b90b5defce5147ef7",
"filename": "商品画像.png"
},
"products.product.is_available": true,
"products.product.memo": "メモ",
"system_reg_date": "2025/01/01 00:00",
"system_reg_user": 123,
"system_reg_employee": 456,
"system_upd_date": "2025/01/02 00:00",
"system_upd_user": 123,
"system_upd_employee": 456
}
