商品参照API

指定された商品の商品情報を返します。

変更履歴

2024年10月30日

LINEギフトに関連する記載を変更しました。
「LINEギフト」→「LINE」

2024年03月14日

レスポンスフィールドに下記項目を追加しました。

  • /ResultSet/Result/EcoSettingId(環境ラベル / エコキーワード)
  • /ResultSet/Result/EcoSettingEvidenceUrl(環境ラベル / エコキーワードのエビデンスURL)

2023年12月08日

レスポンスフィールドに下記項目を追加しました。

  • /ResultSet/Result/PointImmediate(獲得ポイント今すぐ利用フラグ)

2023年09月14日

以下レスポンスフィールドに属性情報を追記しました。

  • /ResultSet/Result/Video(商品動画ファイル名)

2023年08月02日

レスポンスフィールドに下記項目を追加しました。

  • /ResultSet/Result/Video(商品動画ファイル名)

2023年06月01日

レスポンスフィールドに下記項目を追加しました。

  • /ResultSet/Result/SubscriptionPointCode(定期購入:定期購入ポイント倍率)

2023年04月20日

下記レスポンスフィールドの「説明」を修正しました。
・/ResultSet/Result/YShoppingDisplayFlag(Yahoo! ショッピング検索フラグ)
・/ResultSet/Result/SupplierType(販売ルート)

2023年04月06日

レスポンスフィールドに下記項目を追加しました。
・/ResultSet/Result/LinegiftCooporationFlag(LINEギフト出品設定)
・/ResultSet/Result/LinegiftItemCommission(LINEギフト手数料)
・/ResultSet/Result/LinegiftItemImageUrl(LINEギフト用商品画像)
・/ResultSet/Result/LinegiftItemShortname(LINEギフト用商品名)
・/ResultSet/Result/LinegiftItemCaption(LINEギフト用商品説明)

サンプルコード(PHP版)をご用意しています。こちらのページをご確認ください。

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getItem
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getItem

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

Web APIの使い方#GETとは」をご参照ください。

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
item_code
(必須)
string 参照する商品コードを指定します。
expand_spec
※この項目は2015年10月1日から指定可能です。
integer
(デフォルト:0)
0:spec_value_idを単数返し、spec[1-10]のレスポンスの形式。
1:spec_value_idを復数返し。
パラメータを付与しない場合は0をつけた際と同じレスポンスとする。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getItem?seller_id=teststore&item_code=item1

サンプルリクエスト

GET /ShoppingWebService/V1/getItem?seller_id=teststore&item_code=item1 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。
属性名 説明
totalResultsReturned マッチしたクエリー数
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/ItemCode 商品コード
/ResultSet/Result/PathList 紐づいているストアカテゴリパスのリストです。
/ResultSet/Result/PathList/Path ストアカテゴリのパス(カテゴリ名のコロン区切り)(CDATA)
次の属性を持ちます
属性名 説明
origFlag パスが実体かリンクかを示す
  • 0 : リンク
  • 1 : 実体
/ResultSet/Result/Name 商品名(CDATA)
/ResultSet/Result/ProductCategory プロダクトカテゴリID
/ResultSet/Result/OriginalPrice メーカー希望小売価格
/ResultSet/Result/OriginalPriceEvidence ※この項目は2016年6月1日以降追加されます
エビデンスURL
/ResultSet/Result/Price 通常販売価格
/ResultSet/Result/SalePrice 特価
/ResultSet/Result/MemberPrice 会員向け価格
/ResultSet/Result/Quantity 在庫
/ResultSet/Result/Headline キャッチコピー(CDATA)
/ResultSet/Result/Caption 商品説明(CDATA)
/ResultSet/Result/Abstract ひと言コメント(CDATA)
/ResultSet/Result/Explanation 商品情報(CDATA)
/ResultSet/Result/Additional1 フリースペース1(CDATA)
/ResultSet/Result/Additional2 フリースペース2(CDATA)
/ResultSet/Result/Additional3 フリースペース3(CDATA)
/ResultSet/Result/SpAdditional スマートフォン用フリースペース(CDATA)
/ResultSet/Result/RelevantLinks おすすめ商品情報
/ResultSet/Result/RelevantLinks/ItemCode おすすめ商品の商品コード(最大20個)
/ResultSet/Result/CartRelatedItems カート内関連商品情報
/ResultSet/Result/CartRelatedItems/ItemCode カート内関連商品コード(最大3個)
/ResultSet/Result/ShipWeight 重量
/ResultSet/Result/Taxable 課税対象
1 : 課税
0 : 非課税
/ResultSet/Result/TaxrateType 軽減税率コード
0.1 : 通常税率(10%)
0.08:軽減税率(8%)
/ResultSet/Result/ReleaseDate 発売日(YYYY-MM-DD)
/ResultSet/Result/PointCode ポイント倍率コード
/ResultSet/Result/MetaKey META keywords(CDATA)
/ResultSet/Result/MetaDesc META description(CDATA)
/ResultSet/Result/HiddenPage 隠しページ情報
/ResultSet/Result/HiddenPage/HiddenFlag 隠しページフラグ
0 : 通常
1 : 隠しページ
/ResultSet/Result/HiddenPage/Id 隠しページ用ID
/ResultSet/Result/HiddenPage/Password 隠しページ用パスワード
/ResultSet/Result/Display ページ公開
1 : 公開
0 : 非公開
/ResultSet/Result/TemplateId デザインテンプレートID
/ResultSet/Result/TemplateName デザインテンプレート名
/ResultSet/Result/SalePeriodStart 販売開始日時(RFC3339)
/ResultSet/Result/SalePeriodEnd 販売終了日時(RFC3339)
/ResultSet/Result/SaleLimit 購入数制限
/ResultSet/Result/SpCode 販促コード
/ResultSet/Result/BrandCode ブランドコード
/ResultSet/Result/YahooProductCode Y!ショッピング製品コード廃止のため削除
Yahoo!ショッピング製品コード
/ResultSet/Result/ProductCode 製品コード
/ResultSet/Result/Jan JANコード
/ResultSet/Result/Delivery 送料無料設定
0 : なし
1 : 送料無料
2 : 送料込み(※送料込みは送料無料として扱うことになったため、2を指定した場合1として保存されます)
3 : 条件付送料無料
/ResultSet/Result/Image 商品プレビュー画像(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage1 商品詳細プレビュー画像1(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage2 商品詳細プレビュー画像2(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage3 商品詳細プレビュー画像3(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage4 商品詳細プレビュー画像4(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage5 商品詳細プレビュー画像5(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage6 商品詳細プレビュー画像6(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage7 商品詳細プレビュー画像7(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage8 商品詳細プレビュー画像8(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage9 商品詳細プレビュー画像9(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage10 商品詳細プレビュー画像10(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage11 商品詳細プレビュー画像11(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage12 商品詳細プレビュー画像12(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage13 商品詳細プレビュー画像13(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage14 商品詳細プレビュー画像14(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage15 商品詳細プレビュー画像15(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage16 商品詳細プレビュー画像16(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage17 商品詳細プレビュー画像17(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage18 商品詳細プレビュー画像18(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage19 商品詳細プレビュー画像19(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImage20 商品詳細プレビュー画像20(bサイズ)のURL
※2022年5月以降、商品画像・商品詳細画像のURLは不可となります。追加画像をご利用ください。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/AstkCode 現在は使用されておりません。
きょうつく/あすつくコード
0 : 非対応
1 : あすつく
2 : きょうつく
/ResultSet/Result/Condition 商品の状態
0 : 新品
1 : 中古
/ResultSet/Result/Spec1 スペック1
(2015年10月1日以降はexpand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec1/SpecId スペックID
/ResultSet/Result/Spec1/SpecName スペックの表示名
/ResultSet/Result/Spec1/SpecValue スペック値ID
/ResultSet/Result/Spec1/SpecValueName スペック値の表示名
/ResultSet/Result/Spec2 スペック2
(2015年10月1日以降はexpand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec2/SpecId スペックID
/ResultSet/Result/Spec2/SpecName スペックの表示名
/ResultSet/Result/Spec2/SpecValue スペック値ID
/ResultSet/Result/Spec2/SpecValueName スペック値の表示名
/ResultSet/Result/Spec3 スペック3
(2015年10月1日以降はexpand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec3/SpecId スペックID
/ResultSet/Result/Spec3/SpecName スペックの表示名
/ResultSet/Result/Spec3/SpecValue スペック値
/ResultSet/Result/Spec3/SpecValueName スペック値の表示名
/ResultSet/Result/Spec4 スペック4
(2015年10月1日以降はexpand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec4/SpecId スペックID
/ResultSet/Result/Spec4/SpecName スペックの表示名
/ResultSet/Result/Spec4/SpecValue スペック値
/ResultSet/Result/Spec4/SpecValueName スペック値の表示名
/ResultSet/Result/Spec5 スペック5
(2015年10月1日以降はexpand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec5/SpecId スペックID
/ResultSet/Result/Spec5/SpecName スペックの表示名
/ResultSet/Result/Spec5/SpecValue スペック値
/ResultSet/Result/Spec5/SpecValueName スペック値の表示名
/ResultSet/Result/Spec6 この項目は2015年10月1日以降追加されます
スペック6
(expand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec6/SpecId スペックID
/ResultSet/Result/Spec6/SpecName スペックの表示名
/ResultSet/Result/Spec6/SpecValue スペック値
/ResultSet/Result/Spec6/SpecValueName スペック値の表示名
/ResultSet/Result/Spec7 この項目は2015年10月1日以降追加されます
スペック7
(expand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec7/SpecId スペックID
/ResultSet/Result/Spec7/SpecName スペックの表示名
/ResultSet/Result/Spec7/SpecValue スペック値
/ResultSet/Result/Spec7/SpecValueName スペック値の表示名
/ResultSet/Result/Spec8 この項目は2015年10月1日以降追加されます
スペック8
(expand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec8/SpecId スペックID
/ResultSet/Result/Spec8/SpecName スペックの表示名
/ResultSet/Result/Spec8/SpecValue スペック値
/ResultSet/Result/Spec8/SpecValueName スペック値の表示名
/ResultSet/Result/Spec9 この項目は2015年10月1日以降追加されます
スペック9
(expand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec9/SpecId スペックID
/ResultSet/Result/Spec9/SpecName スペックの表示名
/ResultSet/Result/Spec9/SpecValue スペック値
/ResultSet/Result/Spec9/SpecValueName スペック値の表示名
/ResultSet/Result/Spec10 この項目は2015年10月1日以降追加されます
スペック10
(expand_spec=0 を指定またはexpand_specの指定をしなかった場合のみこの項目があります。)
/ResultSet/Result/Spec10/SpecId スペックID
/ResultSet/Result/Spec10/SpecName スペックの表示名
/ResultSet/Result/Spec10/SpecValue スペック値
/ResultSet/Result/Spec10/SpecValueName スペック値の表示名
/ResultSet/Result/Spec この項目は2015年10月1日以降追加されます
スペック(expand_spec=1 のリクエストが指定されている時のみ項目があります。)
/ResultSet/Result/Spec/SpecId スペックID
/ResultSet/Result/Spec/SpecName スペックの表示名
/ResultSet/Result/Spec/SpecValue スペック値情報(1スペックに対して最大100個)
/ResultSet/Result/Spec/SpecValue/Value@id スペック値
/ResultSet/Result/Spec/SpecValue/Value@name スペック値の表示名
/ResultSet/Result/Options/ オプション情報(1つも設定が無ければ項目自体無し)
/ResultSet/Result/Options/Option オプション(インスクリプションと合わせて最大20個)
/ResultSet/Result/Options/Option@type オプションタイプ
1:通常オプション(在庫設定あり)
2:通常オプション(在庫設定なし)
/ResultSet/Result/Options/Option@length オプション名の文字数制限
/ResultSet/Result/Options/Option@name オプション名
/ResultSet/Result/Options/Option@specId オプションのスペックID
/ResultSet/Result/Options/Option/Value オプション値情報(1オプションに対して最大100個)
/ResultSet/Result/Options/Option/Value@specValue オプション値のスペック値
/ResultSet/Result/Options/Option/Value@name オプション値
/ResultSet/Result/Inscriptions インスクリプション情報(1つも設定が無ければ項目自体無し)
/ResultSet/Result/Inscriptions/Inscription インスクリプション(オプションと合わせて最大20個)
/ResultSet/Result/Inscriptions/Inscription/Name インスクリプション名
/ResultSet/Result/Inscriptions/Inscription/Length インスクリプションの文字数制限
/ResultSet/Result/SubCodes 個別商品コード情報(1つも設定が無ければ項目自体無し)
/ResultSet/Result/SubCodes/SubCode 個別商品コード情報(最大100個)
次の属性を持ちます
属性名 説明
code 個別商品コード
quantity 在庫数
stockClose 在庫クローズフラグ
/ResultSet/Result/SubCodes/SubCode/LeadTimeInStock 個別商品の在庫あり時の発送日情報管理番号
/ResultSet/Result/SubCodes/SubCode/LeadTimeOutStock 個別商品の在庫切れ時の発送日情報管理番号
/ResultSet/Result/SubCodes/SubCode/Option オプション情報
次の属性を持ちます
属性名 説明
name オプション名
value オプション値
/ResultSet/Result/ShowStock 在庫表示設定(商品個別設定)
1 : 在庫数表示
2 : 在庫有無表示
/ResultSet/Result/UpdateTime 更新日時(RFC3339)
/ResultSet/Result/EditingFlag 編集フラグ
1 : 編集されてからフロント反映されていない状態
0 : 反映済み
/ResultSet/Result/LeadTimeInStoc 在庫あり時の発送日情報管理番号
/ResultSet/Result/LeadTimeOutStock 在庫切れ時の発送日情報管理番号
/ResultSet/Result/KeepStock 注文者からのキャンセル時、在庫を元に戻す設定
0:キャンセル時在庫を元にさない
1:キャンセル時在庫を元に戻す(初期値)
/ResultSet/Result/StockClose 在庫クローズフラグ
0:通常状態
1:在庫クローズ状態
サブコードが存在する場合:空
/ResultSet/Result/SubCodeImage 個別商品コード画像
/ResultSet/Result/SupplierType ※元PayPayモール専用項目
販売ルート
1:選択なし
2:正規販売・輸入代理店品
3:並行輸入品、他
現在こちらの項目は利用されておりません。
2023年12月頃こちらの項目非表示を予定してます。
/ResultSet/Result/YShoppingDisplayFlag ※元PayPayモール専用項目
Yahoo! ショッピング検索に表示
1:公開
0:非公開
非表示にしたい場合は「公開」を設定の上、「ページ公開」を「非表示」に設定お願いします。
2023年12月頃こちらの項目非表示を予定してます。項目非表示後、設定変更できなくなります。
/ResultSet/Result/IsDrug 第1類医薬品
通常商品:0
第1類医薬品:1
/ResultSet/Result/PostageSet 商品に紐づく配送グループ管理番号
/ResultSet/Result/PickAndDeliveryCode ※ヤマトピック&デリバリー専用項目
バーコード情報
/ResultSet/Result/PickAndDeliveryTransportRuleType ※ヤマトピック&デリバリー専用項目
荷扱い情報
0:なし
1:ナマモノ
2:ワレモノ
3:精密機械
4:下積厳禁
5:天地無用
/ResultSet/Result/SubCodes/SubCode/PickAndDeliveryCode ※ヤマトピック&デリバリー専用項目
バーコード情報
/ResultSet/Result/YamatoFfFlag ※ヤマトフルフィルメント専用項目
ヤマトフルフィル連携
0:対象外
1:対象
/ResultSet/Result/SubCodes/SubCode/YamatoFfFlag ※ヤマトフルフィルメント専用項目
ヤマトフルフィル連携
0:対象外
1:対象
/ResultSet/Result/ReservePrices 価格予約グループ
※価格予約設定がない場合でも下位階層含めフィールドは出力する。
/ResultSet/Result/ReservePrices/ReservePrice 価格予約情報
/ResultSet/Result/ReservePrices/ReservePrice/ReservePrice 自動切替設定:通常販売価格
/ResultSet/Result/ReservePrices/ReservePrice/ReserveSalePrice 自動切替設定:セール価格
/ResultSet/Result/ReservePrices/ReservePrice/ReserveMemberPrice 自動切替設定:Y!プレミアム会員価格
/ResultSet/Result/ReservePrices/ReservePrice/ReserveSellingPeriodStart 自動切替設定:切替期間(開始日)(RFC3339)
/ResultSet/Result/ReservePrices/ReservePrice/ReserveSellingPeriodEnd 自動切替設定:切替期間(終了日)(RFC3339)
/ResultSet/Result/SubscriptionType 定期購入:定期購入設定
0:設定なし(デフォルト)
1:通常購入/定期購入
2:定期購入のみ
/ResultSet/Result/SubscriptionPrice 定期購入:定期購入価格
/ResultSet/Result/SubscriptionGroupIndex 定期購入:定期購入グループ管理番号
/ResultSet/Result/SubscriptionRecommendedCycle 定期購入:おすすめサイクル
下記を:(コロン)区切り設定
  • 指定方法
    • 設定なし:0
    • 日数から選択:1
    • 月数から選択:2
  • 日数または月数
/ResultSet/Result/SubscriptionPointCode 定期購入:定期購入ポイント倍率
/ResultSet/Result/LinegiftCooporationFlag LINE出品設定
0: 出品しない
1: 出品する
/ResultSet/Result/LinegiftItemCommission LINE手数料
/ResultSet/Result/LinegiftItemImageUrl LINE用商品画像
/ResultSet/Result/LinegiftItemShortname LINE用商品名
/ResultSet/Result/LinegiftItemCaption LINE用商品説明(CDATA)
/ResultSet/Result/Video ※商品紹介動画対象の出店者様限定
商品動画ファイル名
次の属性を持ちます
属性名 説明
exist 動画の存在有無
  • 0 : 動画ファイルが存在しない
  • 1 : 動画ファイルが存在する
/ResultSet/Result/PointImmediate 獲得ポイント今すぐ利用フラグ
1 : 対象
0 : 対象外
/ResultSet/Result/EcoSettingId 環境ラベル / エコキーワード
/ResultSet/Result/EcoSettingEvidenceUrl 環境ラベル / エコキーワードのエビデンスURL

サンプルレスポンス

<!-- •サンプルレスポンス、スペック値の単数返しレスポンス (expand_spec=0またはexpand_specを指定しなかった時)-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsReturned="1">
<Result>
    <ItemCode>939124-001</ItemCode>
    <PathList>
        <Path origFlag="1"><![CDATA[生活家電・調理家電・美容家電:生活家電:テレビ・AV機器]]></Path>
        <Path origFlag="0"><![CDATA[生活家電・調理家電・美容家電:生活家電]]></Path>
    </PathList>
    <Name><![CDATA[防水CD/DVDプレーヤー/mini labo/ベルメゾンネット]]></Name>
    <ProductCategory>646</ProductCategory>
    <OriginalPrice>30000</OriginalPrice>
    <Price>29800</Price>
    <SalePrice>20000</SalePrice>
    <Quantity>1</Quantity>
    <Headline><![CDATA[テレビも音楽も映画もOKな夢のバス空間]]></Headline>
    <Caption><![CDATA[<table border="0" cellpadding="5" cellspacing="0"><tr><td style="font-size:13px; line-height:180%"><img src="http://lib2.shopping.srv.yimg.jp/lib/teststore/abstract-ya30.gif" width="30" height="15" style="position:relative; top:2px"><a href="http://www.teststore.jp/ep/srvlt/EPFB00/EPFB0007/dProdStockShow?BELN_SHOP_KBN=100&KAT_BTGO=939124_280_2013_A&SC_TSG_KBN=1"target="_blank">在庫、価格をチェックする</a></td></tr></table>]]></Caption>
    <Abstract><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Abstract>
    <Explanation><![CDATA[バスルームで使える防水仕様で、CDやDVDはもちろんワンセグの視聴も可能。SDカードで写真も再生できる充実機能を搭載。

●幅約20、奥行約5、高さ約17cm(取っ手含まず)]]></Explanation>
    <Additional1><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional1>
    <Additional2><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional2>
    <Additional3><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional3>
    <RelevantLinks>
        <ItemCode>639124-001</ItemCode>
        <ItemCode>639124-002</ItemCode>
    </RelevantLinks>
    <CartRelatedItems>
        <ItemCode>339124-001</ItemCode>
        <ItemCode>339124-002</ItemCode>
    </CartRelatedItems>
    <ShipWeight>29800</ShipWeight>
    <Taxable>1</Taxable>
    <ReleaseDate>2013-12-20</ReleaseDate>
    <PointCode>A15</PointCode>
    <MetaKey><![CDATA[レディースファッション]]></MetaKey>
    <MetaDesc><![CDATA[ダブルガーゼのリバーシブルワンピース]]></MetaDesc>
    <Display>1</Display>
    <SalePeriodStart>2013-06-25T10:00:00+09:00</SalePeriodStart>
    <SalePeriodEnd>2013-07-25T21:00:00+09:00</SalePeriodEnd>
    <SaleLimit>99</SaleLimit>
    <SpCode>1000000072</SpCode>
    <BrandCode>174</BrandCode>
    <YahooProductCode>6b145aa75963b565965c30d73a37fd61</YahooProductCode>
    <ProductCode>04-7281</ProductCode>
    <Jan>4971275472815</Jan>
    <Delivery>1</Delivery>
    <Image>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001</Image>
    <LibImage1>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_1</LibImage1>
    <LibImage2>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_2</LibImage2>
    <LibImage3>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_3</LibImage3>
    <LibImage4>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_4</LibImage4>
    <LibImage5>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_5</LibImage5>
    <LibImage6>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_6</LibImage6>
    <LibImage7>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_7</LibImage7>
    <LibImage8>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_8</LibImage8>
    <LibImage9>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_9</LibImage9>
    <LibImage10>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_10</LibImage10>
    <LibImage11>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_11</LibImage11>
    <LibImage12>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_12</LibImage12>
    <LibImage13>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_13</LibImage13>
    <LibImage14>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_14</LibImage14>
    <LibImage15>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_15</LibImage15>
    <LibImage16>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_16</LibImage16>
    <LibImage17>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_17</LibImage17>
    <LibImage18>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_18</LibImage18>
    <LibImage19>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_19</LibImage19>
    <LibImage20>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001_20</LibImage20>
    <Condition>0</Condition>
    <Spec1>
        <SpecId>379</SpecId>
        <SpecName>おもちゃ対象年齢</SpecName>
      <SpecValue>2039</SpecValue>
        <SpecValueName>3才から</SpecValueName>
    </Spec1>
    <Spec2>
        <SpecId>159</SpecId>
        <SpecName>HDD容量</SpecName>
        <SpecValue>200.00</SpecValue>
        <SpecValueName>200.00</SpecValueName>
    </Spec2>
    <Spec3>
        <SpecId>175</SpecId>
        <SpecName>色</SpecName>
        <SpecValue>1009</SpecValue>
        <SpecValueName>ブラック</SpecValueName>
    </Spec3>
    <Spec4>
        <SpecId>299</SpecId>
        <SpecName>モニターサイズ</SpecName>
        <SpecValue>6.10</SpecValue>
        <SpecValueName>6.10</SpecValueName>
    </Spec4>
    <Spec5/>
    <Options>
        <Option type="1" name="色" specId="175">
            <Value specValue="">選択してください></Value>
            <Value specValue="1014">アイボリー></Value>
            <Value specValue="747">グリーン></Value>
            <Value specValue="1012">サーモンピンク></Value>
        </Option>
        <Option type="1" name="幅×丈(cm)" specId="">
            <Value specValue="">約100×110</Value>
        </Option>
        <Option type="2" name="サイズ" specId="">
            <Value specValue="">M</Value>
        </Option>
    </Options>
    <Inscriptions>
        <Inscription>
            <Name>名前</Name>
            <Length>50</Length>
        </Inscription>
        <Inscription>
            <Name>電話番号</Name>
            <Length>40</Length>
        </Inscription>
    </Inscriptions>
    <SubCodes>
        <SubCode code="17655404" quantity="1">
            <Option name="色" value="アイボリー"/>
            <Option name="幅×丈(cm)" value="約100×110"/>
        </SubCode>
        <SubCode code="17655404" quantity="2">
            <Option name="色" value="グリーン"/>
            <Option name="幅×丈(cm)" value="約100×110"/>
        </SubCode>
    </SubCodes>
    <ShowStock>1</ShowStock>
    <UpdateTime>2012-07-24T18:45:57+09:00</UpdateTime>
    <EditingFlag>1</EditingFlag>
    <EcoSettingId>1</EcoSettingId>
    <EcoSettingEvidenceUrl>https://www.XXXXXX.com/XXXXXX/XXXXXX.html</EcoSettingEvidenceUrl>
</Result>
</ResultSet>


<!-- •サンプルレスポンス、スペック値の復数対応レスポンス (expand_spec=1を指定した時)-->


<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsReturned="1">
<Result>
    <ItemCode>939124-001</ItemCode>
    <PathList>
        <Path origFlag="1"><![CDATA[生活家電・調理家電・美容家電:生活家電:テレビ・AV機器]]></Path>
        <Path origFlag="0"><![CDATA[生活家電・調理家電・美容家電:生活家電]]></Path>
    </PathList>
    <Name><![CDATA[防水CD/DVDプレーヤー/mini labo/ベルメゾンネット]]></Name>
    <ProductCategory>646</ProductCategory>
    <OriginalPrice>30000</OriginalPrice>
    <Price>29800</Price>
    <SalePrice>20000</SalePrice>
    <Quantity>1</Quantity>
    <Headline><![CDATA[テレビも音楽も映画もOKな夢のバス空間]]></Headline>
    <Caption><![CDATA[<table border="0" cellpadding="5" cellspacing="0"><tr><td style="font-size:13px; line-height:180%"><img src="http://lib2.shopping.srv.yimg.jp/lib/teststore/abstract-ya30.gif" width="30" height="15" style="position:relative; top:2px"><a href="http://www.teststore.jp/ep/srvlt/EPFB00/EPFB0007/dProdStockShow?BELN_SHOP_KBN=100&KAT_BTGO=939124_280_2013_A&SC_TSG_KBN=1"target="_blank">在庫、価格をチェックする</a></td></tr></table>]]></Caption>
    <Abstract><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Abstract>
    <Explanation><![CDATA[バスルームで使える防水仕様で、CDやDVDはもちろんワンセグの視聴も可能。SDカードで写真も再生できる充実機能を搭載。

●幅約20、奥行約5、高さ約17cm(取っ手含まず)]]></Explanation>
    <Additional1><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional1>
    <Additional2><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional2>
    <Additional3><![CDATA[<span style="font-size:1.2em; color:#690; font-weight:bold;">テレビも音楽も映画もOKな夢のバス空間</span>]]></Additional3>
    <RelevantLinks>
        <ItemCode>639124-001</ItemCode>
        <ItemCode>639124-002</ItemCode>
    </RelevantLinks>
    <CartRelatedItems>
        <ItemCode>339124-001</ItemCode>
        <ItemCode>339124-002</ItemCode>
    </CartRelatedItems>
    <ShipWeight>29800</ShipWeight>
    <Taxable>1</Taxable>
    <ReleaseDate>2013-12-20</ReleaseDate>
    <TemporaryPointTerm>14</TemporaryPointTerm>
    <PointCode>A15</PointCode>
    <MetaKey><![CDATA[レディースファッション]]></MetaKey>
    <MetaDesc><![CDATA[ダブルガーゼのリバーシブルワンピース]]></MetaDesc>
    <Display>1</Display>
    <TemplateId>IT01</TemplateId>
    <TemplateName>テンプレート1</TemplateName>
    <SalePeriodStart>2013-06-25T10:00:00+09:00</SalePeriodStart>
    <SalePeriodEnd>2013-07-25T21:00:00+09:00</SalePeriodEnd>
    <SaleLimit>99</SaleLimit>
    <SpCode>1000000072</SpCode>
    <BrandCode>174</BrandCode>
    <YahooProductCode>6b145aa75963b565965c30d73a37fd61</YahooProductCode>
    <ProductCode>04-7281</ProductCode>
    <Jan>4971275472815</Jan>
    <Delivery>1</Delivery>
    <Image>http://preview.image.shopping.yahoo.co.jp/YRT/i/b/teststore_939124-001</Image>
    <Image>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_i_20210705100000</Image>
    <LibImage1>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_1_d_20210705100000</LibImage1>
    <LibImage2>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_2_d_20210705100000</LibImage2>
    <LibImage3>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_3_d_20210705100000</LibImage3>
    <LibImage4>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_4_d_20210705100000</LibImage4>
    <LibImage5>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_5_d_20210705100000</LibImage5>
    <LibImage6>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_6_d_20210705100000</LibImage6>
    <LibImage7>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_7_d_20210705100000</LibImage7>
    <LibImage8>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_8_d_20210705100000</LibImage8>
    <LibImage9>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_9_d_20210705100000</LibImage9>
    <LibImage10>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_10_d_20210705100000</LibImage10>
    <LibImage11>https://shopping.c.yimg.jp/lib/teststore/detail11.jpg</LibImage11>
    <LibImage12>https://shopping.c.yimg.jp/lib/teststore/detail12.jpg</LibImage12> 
    <LibImage13>https://shopping.c.yimg.jp/lib/teststore/detail13.jpg</LibImage13>
    <LibImage14>https://shopping.c.yimg.jp/lib/teststore/detail41.jpg</LibImage14>
    <LibImage15>https://shopping.c.yimg.jp/lib/teststore/detail15.jpg</LibImage15>
    <LibImage16>https://shopping.c.yimg.jp/lib/teststore/detail16.jpg</LibImage16>
    <LibImage17>https://shopping.c.yimg.jp/lib/teststore/detail17.jpg</LibImage17>
    <LibImage18>https://shopping.c.yimg.jp/lib/teststore/detail18.jpg</LibImage18>
    <LibImage19>https://shopping.c.yimg.jp/lib/teststore/detail19.jpg</LibImage19>
    <LibImage20>https://shopping.c.yimg.jp/lib/teststore/detail20.jpg</LibImage20>
    <Condition>0</Condition>
    <Spec>
        <SpecId>379</SpecId>
        <SpecName>おもちゃ対象年齢</SpecName>
        <SpecValue>
            <Value id="2039" name="3才から"/>
        </SpecValue>
    </Spec>
    <Spec>
        <SpecId>159</SpecId>
        <SpecName>HDD容量</SpecName>
        <SpecValue>
            <Value id="200.00" name=""/>
        </SpecValue>
    <Spec>
    </Spec>
        <SpecId>175</SpecId>
        <SpecName>色</SpecName>
        <SpecValue>
            <Value id="1009" name="ブラック"/>
        </SpecValue>
    </Spec>
    <Spec>
        <SpecId>299</SpecId>
        <SpecName>モニターサイズ</SpecName>
        <SpecValue>
            <Value id="6.10 name=""/>
        </SpecValue>
    </Spec>
    <Options>
        <Option type="1" length="0" name="色" specId="175">
            <Value specValue="" name="選択してください"/>
            <Value specValue="1014" name="アイボリー"/>
            <Value specValue="747" name="グリーン"/>
            <Value specValue="1012" name="サーモンピンク"/>
        </Option>
        <Option type="1" length="0" name="幅×丈(cm)" specId="">
            <Value specValue="" name="約100×110"/>
        </Option>
        <Option type="2" length="0" name="サイズ" specId="">
            <Value specValue="" name="M"/>
        </Option>
    </Options>
    <Inscriptions>
        <Inscription>
            <Name>名前</Name>
            <Length>50</Length>
        </Inscription>
        <Inscription>
            <Name>電話番号</Name>
            <Length>40</Length>
        </Inscription>
    </Inscriptions>
    <SubCodes>
        <SubCode code="17655404" quantity="1">
            <Option name="色" value="アイボリー"/>
            <Option name="幅×丈(cm)" value="約100×110"/>
        </SubCode>
        <SubCode code="17655404" quantity="2">
            <Option name="色" value="グリーン"/>
            <Option name="幅×丈(cm)" value="約100×110"/>
        </SubCode>
    </SubCodes>
    <ShowStock>1</ShowStock>
    <UpdateTime>2012-07-24T18:45:57+09:00</UpdateTime>
    <EditingFlag>1</EditingFlag>
    <EcoSettingId></EcoSettingId>
    <EcoSettingEvidenceUrl></EcoSettingEvidenceUrl>
</Result>
</ResultSet>

「バリエーション画像」関連のレスポンス

//バリエーション画像が存在する場合
<SubCodes>
    <SubCode code="sc-sws-vrtest0001" quantity="" stockClose="0">
    <Option name="A" value="AA"/>
    <Option name="B" value="BA"/>
    <SubCodeImage value="rav-keiswada_mdg-150513_9" image_type="item" main_flag="0" exist_flag="1"/>
    <LeadTimeInStock/>
    <LeadTimeOutStock/>
</SubCode>

//バリエーション画像が存在しない場合
<SubCode code="sc-sws-vrtest0008" quantity="300" stockClose="0">
    <Option name="A" value="AC"/>
    <Option name="B" value="BB"/>
    <SubCodeImage value="" image_type="" main_flag="" exist_flag=""/>
    <LeadTimeInStock/>
    <LeadTimeOutStock/>
</SubCode>

2021年8月以降のレスポンス(サンプル)※画像関連部分のみ抜粋

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsReturned="1">
<Result>
   :
   
   ※リリース前にアップロードされた画像については、今までの画像URLパスで返却されます。
   
    <Image>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_i_20210705100000</Image>
    <LibImage1>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_1_d_20210705100000</LibImage1>
    <LibImage2>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_2_d_20210705100000</LibImage2>
    <LibImage3>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_3_d_20210705100000</LibImage3>
    <LibImage4>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_4_d_20210705100000</LibImage4>
    <LibImage5>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_5_d_20210705100000</LibImage5>
    <LibImage6>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_6_d_20210705100000</LibImage6>
    <LibImage7>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_7_d_20210705100000</LibImage7>
    <LibImage8>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_8_d_20210705100000</LibImage8>
    <LibImage9>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_9_d_20210705100000</LibImage9>
    <LibImage10>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001_10_d_20210705100000</LibImage10>
    <LibImage11>https://shopping.c.yimg.jp/lib/teststore/detail11.jpg</LibImage11>
    <LibImage12>https://shopping.c.yimg.jp/lib/teststore/detail12.jpg</LibImage12> 
    <LibImage13>https://shopping.c.yimg.jp/lib/teststore/detail13.jpg</LibImage13>
    <LibImage14>https://shopping.c.yimg.jp/lib/teststore/detail41.jpg</LibImage14>
    <LibImage15>https://shopping.c.yimg.jp/lib/teststore/detail15.jpg</LibImage15>
    <LibImage16>https://shopping.c.yimg.jp/lib/teststore/detail16.jpg</LibImage16>
    <LibImage17>https://shopping.c.yimg.jp/lib/teststore/detail17.jpg</LibImage17>
    <LibImage18>https://shopping.c.yimg.jp/lib/teststore/detail18.jpg</LibImage18>
    <LibImage19>https://shopping.c.yimg.jp/lib/teststore/detail19.jpg</LibImage19>
    <LibImage20>https://shopping.c.yimg.jp/lib/teststore/detail20.jpg</LibImage20>
   :
</Result>
</ResultSet>

//追加画像が紐づいてる場合
    <Image>https://item-shopping.c.yimg.jp/i/b/teststore_939124-001</Image>
    <LibImage1>https://shopping.c.yimg.jp/lib/teststore/test.png</LibImage1>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

商品系API、および商品参照APIで固有に返すエラーコードは以下をご覧ください。

商品系API共通エラーコード

コード HTTPステータスコード 説明
ed-00000 404 ページが見つかりません。
ed-00001 500 システムエラーが発生しました。
ed-00002 503 サーバがメンテナンス中です。
ed-00003 400 ストアアカウントが指定されていません。
ed-00004 400 ストアアカウントが存在しません。
ed-00005 400 ストアアカウントの指定が不正です。

エラーコード

コード HTTPステータスコード 説明
it-05001 400 item_codeが指定されていません。
it-05002 400 指定された商品コードは存在しません。
it-05004 400 expand_specは0か1を入力してください。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)

利用約款

このAPIに関する利用約款はこちら

アプリケーションの管理

目次

利用のルール

開発のヒント