商品検索API

指定した商品情報の取得を行います。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

ご注意事項

商品検索APIは、呼び出し回数に制限がございます(1秒間に1回) 。
そのため、他のAPIと同様、ECサイトやアプリでの画面表示の用途にはご利用いただけません。
コマースクリエイターの利用/未利用による出力項目の変更はありません。
ただし、コマースクリエイターのみコマースクリエイター切替済のみの項目については、「空文字」で出力されます（何も出力されされません）。

基本仕様

1リクエスト最大50〜250件の商品情報が取得できます（件数はパラメータ指定。指定しない場合は、50件）。
商品情報については、以下のタブで設定された情報を取得できます。
ECサイト画面への表示を設定する項目については出力しません。（以下一部を例示します。）
- 販売期間や予約販売期間の「表示する」のチェック
- 送料設定の「商品別パターンを表示する」
- ApplePayボタンの「表示する」
- 入荷お知らせメール申込の「表示する」
商品タグは出力しません。

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2024.06.05	レスポンス	以下を追加（1）productList　＞　weight（梱包重量）（2）productList　＞　variation ＞　variationList　＞ weight（梱包重量（バリエーション毎））（3）productList　＞　packingGroupName（同梱可能グループ）	配送・送料（upgrade版）の新機能提供のため	（1）参照（2）参照（3）参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

https://{APIドメイン}/admin-api/v1/products

HTTPメソッド

GET

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ

なし

パラメータ

key	項目名	内容
productNo	商品番号	カンマ区切りで複数指定可能
mainGroupUrl	商品メイングループURLコード	カンマ区切りで複数指定可能
janCode	JANコード	カンマ区切りで複数指定可能指定したJANコードが含まれる商品情報を検索
types	設定種類	option：項目選択肢設定 variation：バリエーション設定 optionPrice：オプション価格設定 subscription：定期設定 preorder：予約設定 image：画像設定 comment：コメント設定 ※カンマ区切りで複数指定可能
createDateStart	商品登録日時(start)	「yyyy-mm-ddThh:mm:ss」形式
createDateEnd	商品登録日時(end)	「yyyy-mm-ddThh:mm:ss」形式
count	取得件数	指定なしの場合、50商品を取得可能50〜250の間で指定可能

レスポンス

一部項目は、配送・送料（upgrade版）ご利用状況、アップグレード準備状況により出力が異なります。
以下をご参照ください。

「内容」列にて （★）付の項目は、「配送・送料機能（upgrade版）」用の登録項目ではありません（従来版項目です）。
upgrade版ご利用にかかわらず、登録がある場合は出力されます。ない場合は「空文字」もしくは「false」が出力されます。
「内容」列にて （★V2）付の項目は、「配送・送料機能（upgrade版）」用の項目です。
upgrade版ご利用にかかわらず、登録がある場合は出力されます。ない場合は「空文字」もしくは「false」が出力されます。

※2024.01.24以降futureshop新規発行店舗様は、すでに「配送・送料機能（upgrade版）」をご利用ですので、（★V2）のみの出力となります。

key					項目名	必須	型	byte	内容
nextUrl					ネクストURL		String	-	指定件数を超過する結果の場合、次のデータ取得のURLを返却（※）
taxConfig					消費税設定	○	-	-	設定＞店舗共通＞消費税設定の設定を出力
	enabled				加算設定	○	Boolean	-	true：加算する false：加算しない
	standardTaxRate				標準税率	○	String	2
	reducedTaxRate				軽減税率	○	String	2
	roundingType				端数計算区分	○	String	13	ROUND_DOWN：切り捨て ROUND_HALF_UP：四捨五入 ROUND_UP：切り上げ
productList					商品リスト	○	Array	-	商品ごとに配列出力。最大100件
	id				商品ID	○	Number	18
	type				商品種類	○	String	24	REGULAR：通常 SUBSCRIPTION_ONLY：定期 REGULAR_AND_SUBSCRIPTION：通常・定期 HANPUKAI：頒布会
	catchphrase				キャッチコピー	○	String	200
	visible				公開フラグ	○	Boolean	-	true：公開 false：非公開
	otherServicesEnabled				他社サービス公開設定	○	Boolean	-	true：公開 false：非公開
	name				商品名	○	String	300
	productNo				商品番号	○	String	32
	janCode				JANコード	○	String	30
	url				商品URLコード	○	String	32
	uri				商品URI	○	Text	-	コマースクリエイター利用中（有効化済み含）の場合は、商品URIを出力コマースクリエイター未利用の場合は、空文字
	groupUrl				メイングループURLコード	○	String	32
	groupName				メイングループ名	○	String	80
	subGroupList				サブグループリスト	○	Array	-
		subGroupUrl			サブグループURLコード		String	32
		subGroupName			サブグループ名	○	String	80
	bundleName				バンドル名	○	String	300
	taxIncluded				消費税設定	○	Boolean	-	true：消費税込 false：消費税別
	unitPrice				販売価格	○	String	9
	memberPriceEnabled				会員価格設定	○	Boolean	-	true：会員特別価格設定商品とする false：会員特別価格設定商品としない
	memberPrice				会員価格	○	String	9
	memberStagePriceList				会員ステージ価格リスト	○	Array	-
		stageName			会員ステージ名		String	60
		price			会員ステージ価格		String	9
	regularPrice				通常価格(定価)	○	String	9	オープン価格を表示するために「通常価格(定価)」に「open」と入力している場合は、"open"の文字列が出力されます。
	taxRateCode				消費税区分	○	String	8	STANDARD：標準税率 REDUCED：軽減税率
	inventoryEnabled				在庫管理設定	○	Boolean	-	true：在庫管理する false：在庫管理しない
	inventoryCount				在庫数(非SKU)	○	Number	9
	priority				優先度	○	String	9
	weight				梱包重量	○	String	6
	membersOnlyProduct				会員アクセス制限設定	○	Boolean	-	true：会員のみアクセス可能 false：全てのユーザーがアクセス可能
	salesPeriodFrom				販売期間(開始)	○	String	16	「yyyy-mm-ddThh:mm」形式
	salesPeriodTo				販売期間(終了)	○	String	16	「yyyy-mm-ddThh:mm」形式
	postagePolicy				送料設定区分	○	String	8	REGULAR：通常送料 INCLUDED：送料込み PRIVATE：個別送料
	postagePatternName				通常送料設定	○	String	80
	individualPostage				商品個別送料	○	String	9
	coolDeliveryEnabled				クール便指定	○	Boolean	-	true：クール便指定あり false：クール便指定なし ------------------------------------------------------ （★：配送・送料（upgrade版）関連項目）
	mailBinEnabled				メール便指定	○	Boolean	-	true：メール便指定あり false：メール便指定なし ------------------------------------------------------ （★：配送・送料（upgrade版）関連項目）
	mailBinPackingLimit				メール便同梱数	○	String	4	（★：配送・送料（upgrade版）関連項目）
	leadTime				商品リードタイム	○	String	2	商品登録＞商品リードタイムでの設定を出力 ------------------------------------------------------ （★V2：配送・送料（upgrade版）関連項目）
	roomTemperatureProductByChilledDeliveryEnabled				常温商品をクール便（冷蔵）で配送可フラグ	○	Boolean	-	true：配送可能 false：配送不可 ------------------------------------------------------ （★V2：配送・送料（upgrade版）関連項目）
	deliveryType				配送種別区分	○	String	25	ROOM_TEMPERATURE_DELIVERY：常温便 CHILLED_DELIVERY：クール便(冷蔵) FROZEN_DELIVERY：クール便(冷凍) SUMMER_CHILLED_DELIVERY：夏季クール便(冷蔵) MAIL：メール便 ------------------------------------------------------ （★V2：配送・送料（upgrade版）関連項目）
	mailBinProductByRoomTemperatureDeliveryEnabled				メール便を宅配便で配送可フラグ	○	Boolean	-	true：配送可能 false：配送不可 ------------------------------------------------------ （★V2：配送・送料（upgrade版）関連項目）
	mailBinPackingNumber				メール便同梱数	○	String	4	（★V2：配送・送料（upgrade版）関連項目）
	packingGroupName				同梱可能グループ	○	String	510	（★V2：配送・送料（upgrade版）関連項目）
	onlyOnePurchaseAllowed				サンプル商品設定	○	Boolean	-	true：1度のみ購入可能 false：購入制限無し
	noPackingTogether				サンプル商品購入設定	○	Boolean	-	true：購入制限無し false：他商品と同時に購入させない（1度のみ購入可能が有効な場合のみ）
	maxPurchaseQuantity				購入個数制限	○	String	9
	pointRateCode				ポイント付与率設定	○	String	10	COMMON：設定＞ポイント基本設定-基本付与率設定／【CC未利用・移行中】運用＞ポイント基本設定-基本付与率設定で設定された付与率を利用する INDIVIDUAL：個別送料
	individualPointRate				個別ポイント付与率	○	String	4	整数2桁、小数点以下1桁
	recommendProductConfig				おすすめ商品設定	○	String	10	COMMON：設定＞カート＞購入画面設定-おすすめ商品設定／【CC未利用・移行中】構築＞ページ設定＞購入画面設定-おすすめ商品設定で設定された商品を表示する INDIVIDUAL：設定した固有のおすすめ商品を表示する（最大20個）
	recommendProductList				おすすめ商品リスト	○	Array	-
		productNo			おすすめ商品No		String	32
	title				商品名(連携用)	○	String	300
	description				商品説明(連携用)	○	Text	-
	freeItem				任意項目(連携用)	○	Text	-
	dateLastUpdated				更新日時	○	String	19	「yyyy-mm-ddThh:mm:ss」形式
	dateCreated				登録日時	○	String	19	「yyyy-mm-ddThh:mm:ss」形式
	option				項目選択肢設定		-	-	types：optionを指定した場合に出力されます。データが存在しない場合、空出力となります。
		optionList			項目選択肢リスト		Array	-
			no		項目選択肢No		String	9
			name		項目選択肢名		String	100
			type		表示タイプ		String	13	RADIO：ラジオボタン SELECT：セレクトボックス TEXT_NORMAL：テキスト(通常) TEXT_REQUIRED：テキスト(必須)
			displayEnabled		表示設定		Boolean	-
			choiceList		項目選択肢リスト		Array	-
				choices	項目選択肢		String	100
	variation				バリエーション設定		-	-	types：variationを指定した場合に出力されます。データが存在しない場合、空出力となります。
		horizontalName			項目名（横軸）		String	100
		verticalName			項目名（縦軸）		String	100
		variationList			バリエーションリスト		Array	-
			skuNo		SKU番号		String	232	商品番号+枝番(横軸)+枝番(縦軸)
			horizontalNo		枝番（横軸）		String	100	バリエーション商品の場合に項目出力
			verticalNo		枝番（縦軸）		String	100	バリエーション商品の場合に項目出力
			janCode		JANコード		String	30
			count		在庫数		Number	9
			price		バリエーション価格		String	9	※管理画面で入力した値をそのまま出力（税込・税抜にかかわらず）
			representativeVariation		代表バリエーションフラグ		Boolean	-	true：代表バリエーション false：非代表バリエーション
			leadTime		商品リードタイム		String	2	商品バリエーション詳細設定＞商品リードタイムでの設定を出力 ------------------------------------------------------ （★V2：配送・送料（upgrade版）関連項目）
			weight		梱包重量		String	6	商品バリエーション詳細設定＞梱包重量での設定を出力
	optionPrice				オプション価格設定		-	-	types：optionPriceを指定した場合に出力されます。またデータが存在しない場合、空出力となります。
		optionPriceList			オプション価格リスト		Array	-
			no		項目No		String	2
			displayEnabled		表示設定		Boolean	-	true：表示する false：表示しない
			name		項目名		String	100
			order		表示順		String	2
			type		表示タイプ		String	13	RADIO：ラジオボタン SELECT：セレクトボックス TEXT_NORMAL：テキスト(通常) TEXT_REQUIRED：テキスト(必須)
			taxRateCode		税率設定		String	8	STANDARD：標準税率 REDUCED：軽減税率
			description		説明文		Text	-	全角500文字以内
			choiceList		選択肢リスト		Array	-
				no	オプション価格項目No		String	9
				code	選択肢コード		String	50
				value	選択肢		String	100
				price	価格		String	9
				order	表示順		String	2
	subscription				定期設定		-	-	types：subscriptionを指定した場合に出力されます。定期オプションをご契約していない場合、もしくは、予約利用設定がtrueの場合、空出力となります。
		cycleName			サイクル名		String	120
		initialPeriodPrice			定期・頒布会販売価格(初回)		String	9
		regularPeriodPrice			定期・頒布会販売価格(通常回)		String	9
		finalPeriodPrice			定期・頒布会販売価格(最終回)		String	9
		stockCount			定期・頒布会在庫数		String	9
		hanpukaiProduct1			01回目お届け商品		String	100
		hanpukaiProduct2			02回目お届け商品		String	100
		hanpukaiProduct3			03回目お届け商品		String	100
		hanpukaiProduct4			04回目お届け商品		String	100
		hanpukaiProduct5			05回目お届け商品		String	100
		hanpukaiProduct6			06回目お届け商品		String	100
		hanpukaiProduct7			07回目お届け商品		String	100
		hanpukaiProduct8			08回目お届け商品		String	100
		hanpukaiProduct9			09回目お届け商品		String	100
		hanpukaiProduct10			10回目お届け商品		String	100
		hanpukaiProduct11			11回目お届け商品		String	100
		hanpukaiProduct12			12回目お届け商品		String	100
	preorder				予約設定		-	-	types：preorderを指定した場合に出力されます。定期・頒布会商品の場合、空出力となります。
		preorderEnabled			予約利用設定		Boolean	-	true：予約を受け付ける false：予約を受け付けない
		preorderPeriodFrom			予約受付期間(開始)		String	16	「yyyy-mm-ddThh:mm」形式
		preorderPeriodTo			予約受付期間(終了)		String	16	「yyyy-mm-ddThh:mm」形式
		preorderOnlyEnabled			予約商品設定		Boolean	-	true：予約受付期間が終了しても、通常商品として販売しない false：予約受付期間が終了すると通常商品として販売する
		preorderPrice			予約販売価格		String	9
		preorderEarnPointsRate			ポイント付与率		String	4	整数2桁、小数点以下1桁
		preorderUnitPriceEnabled			予約販売価格設定		Boolean	-	true：予約販売価格・バリエーション予約販売価格で販売する false: 販売価格・バリエーション販売価格で販売する
		preorderList			予約商品リスト		Array	-	バリエーション商品の場合は、枝番が表示され、在庫数もバリエーション毎となります。バリエーション商品でない場合は、枝番は空文字で出力され、在庫数も単一の予約商品の在庫数となります。
			skuNo		SKU番号		String	232	商品番号+枝番(横軸)+枝番(縦軸) ※バリエーション商品でない場合は「商品番号」のみ出力。 productList＞productNoと同じ。
			horizontalNo		枝番(横軸)		String	100	バリエーション商品の場合に項目出力
			verticalNo		枝番(縦軸)		String	100	バリエーション商品の場合に項目出力
			janCode		JANコード		String	30	※バリエーション商品でない場合はproductList＞janCodeと同じ。
			count		予約在庫数		Number	9
			price		バリエーション予約価格		String	9	※管理画面で入力した値をそのまま出力（税込・税抜にかかわらず）
			representativeVariation		代表バリエーションフラグ		Boolean	-	true：代表バリエーション false：非代表バリエーション
	image				画像設定		-	-	types：imageを指定した場合に出力されます。データが存在しない場合、空出力となります。
		axisCode			バリエーション画像設定区分		String	10	NO_SETTING：設定無し VERTICAL：縦軸 HORIZONTAL：横軸
		imageList			画像リスト		Array	-
			no		画像No		String	2
			thumbnailEnabled		商品サムネイル設定		Boolean	-	true：「商品サムネイル画像に指定する」が選択されている画像 false：「商品サムネイル画像に指定する」が選択されていない画像 ------------------------------------------------------ ※画像が登録されていない場合、項目の取得が行えません.。［商品サムネイル設定］画像なし商品のサンプルレスポンスをご覧ください。
			order		表示順		String	2
			variationAdminNo		バリエーション枝番号		String	100
			originalImagePath		画像パス(オリジナル)		Text	-
			xxlImagePath		画像パス(XXL)		Text	-
			xlImagePath		画像パス(XL)		Text	-
			lImagePath		画像パス(L)		Text	-
			mImagePath		画像パス(M)		Text	-
			sImagePath		画像パス(S)		Text	-
			xsImagePath		画像パス(XS)		Text	-
	comment				コメント設定		-	-	types：commentを指定した場合に出力されます。
		singleWordDescription			商品一言説明		Text	-
		fullDescription			商品説明（大）		Text	-
		shortDescription			商品説明（小）		Text	-
		comment1			独自コメント（1）		Text	-
		comment2			独自コメント（2）		Text	-
		comment3			独自コメント（3）		Text	-
		comment4			独自コメント（4）		Text	-
		comment5			独自コメント（5）		Text	-
		comment6			独自コメント（6）		Text	-
		comment7			独自コメント（7）		Text	-
		comment8			独自コメント（8）		Text	-
		comment9			独自コメント（9）		Text	-
		comment10			独自コメント（10）		Text	-
		comment11			独自コメント（11）		Text	-
		comment12			独自コメント（12）		Text	-
		comment13			独自コメント（13）		Text	-
		comment14			独自コメント（14）		Text	-
		comment15			独自コメント（15）		Text	-
		comment16			独自コメント（16）		Text	-
		comment17			独自コメント（17）		Text	-
		comment18			独自コメント（18）		Text	-
		comment19			独自コメント（19）		Text	-
		comment20			独自コメント（20）		Text	-

nextUrlに関する補足

「/v1/products」の後に次のデータを取得するためのパラメータが付与されたURLが返却されます。
URLに替えて、nextUrlをGETしていただければ、次の100件のデータを取得できます。

［商品サムネイル設定］画像なし商品のサンプルレスポンス

【画像登録をした事がない商品の場合】

"image": {},

【画像登録後に削除した商品の場合】

"image": {
    "axisCode": "NO_SETTING",　⇒[バリエーション画像設定](/operate/goods/GoodsEntry/GoodsImageEdit/#displaySettings)の設定に従って[出力](#axisCode)
    "imageList": []
},

エラーレスポンス

エラー発生時に以下のレスポンスが返却されます。

key		項目名	必須	型	byte	内容
stauts		ステータス	○	String	-
errors		エラーリスト	○	Array	-
	code	コード	○	String	-
	path	パス	○	String	-	エラーが発生したパラメータ名が出力されます
	message	メッセージ	○	String	-

エラーコード

コード	メッセージ	説明
TooMany	productNoの指定は100件までです	商品番号の指定が100件を超過した場合に返却されます。
TooLong	productNoは60文字以内で指定してください	1商品の商品番号が60文字を超過した場合に返却されます。
TooMany	mainGroupUrlの指定は100件までです	商品メイングループURLコードの指定が100件を超過した場合に返却されます。
TooLong	mainGroupUrlは32文字以内で指定してください	1商品の商品メイングループURLコードが32文字を超過した場合に返却されます。
TooLong	janCodeは30文字以内で指定してください	1商品のJANコードが30byteを超過した場合に返却されます。
TooMany	janCodeの指定は100件までです	JANコードの指定が100件を超過した場合に返却されます。
InvalidValue	typesの指定が不正です	商品設定種類ではない指定が行われた場合に返却されます。
InvalidDateFormat	createDateStartの日付フォーマットを正しく指定してください createDateEndの日付フォーマットを正しく指定してください	「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。
InvalidDateRange	createDateStartはcreateDateEndより前の日時を指定してください	商品登録日時の開始日時が終了日時よりも未来日付の場合に返却されます。
InvalidValue	countの指定が不正です	取得件数の指定が50〜250ではない場合、返却されます。

サンプル

{
    "status": "failed",
    "errors": [
        {
            "code": "InvalidValue",
            "path": "types",
            "message": "typesの指定が不正です"
        }
    ]
}