ListLookup

[重要] 重要

利用率低下により、このオペレーションおよび関連レスポンスグループは2010年07月25日をもってサポート終了となっておりますので、ご利用にならないようご注意ください。

説明

ListLookup オペレーションは、デフォルトではリクエストで指定したリストに関する要約情報を返します。要約情報の内容は次のとおりです。

  • リストの作成日

  • リストの作成者の名前

1ページあたり最大10件の要約情報を返します。

リストは、リストタイプとリストIDで指定します。リストIDは、ListSearch を使用して検索できます。

1回のリクエストで複数のリストを検索することはできません。ただし、バッチリクエストを作成して複数のリストを同時に検索することはできます。

利用可能なサイト

全ての国のサイト

リクエストパラメータ

名前説明必須
Condition

商品のコンディションを指定します。Condition が "All" に設定されている場合、Condition の有効な値に対して個々のレスポンスセットが返されます。Condition のデフォルト値は、All ではなく New です。レスポンスに商品が何も返されない場合は、値を "All" に設定してみてください。

タイプ: 文字列

デフォルト: New

有効な値: All | Collectible | Refurbished | Used

いいえ
IsOmitPurchasedItems

ListLookup リクエストで IsOmitPurchasedItems=1 と設定すると、ほしい物リストにある購入済みの商品は返されません。未購入であるか、購入数がまだ十分でない商品だけが返されます。

タイプ: ブール値

デフォルト値: なし

有効な値: True | False

いいえ
ListId

リストを一意に識別する番号。

タイプ: 文字列

デフォルト: なし

有効な値: 正の整数

はい
ListType

リストの種類。

タイプ: 文字列

デフォルト値: なし

有効な値: WeddingRegistry | Listmania lists | WishList | Baby Registry詳細については、サポートされるリストタイプ をご参照ください。

はい
MerchantId

商品を出品しているマーチャントを指定します。MerchantIdは Amazon がマーチャントに割り当てた半角英数字の ID です。出品者 ID ではなく必ずマーチャント ID を使用してください。出品者 ID はサポートされていません。

タイプ: 文字列

デフォルト: Amazon

有効な値: MerchantId--マーチャントのID

All-- Amazon.co.jp とほかの全てのマーチャント

Featured-- "Add to Cart (ショッピングカートに入れる)" をクリックしたときに表示されるマーチャント(USサイトのみ)

いいえ
ProductGroup

商品のカテゴリ (例: "Book"、"DVD") 。ProductGroup を指定するときは必ず URL エンコードを行ってください。例えば、"Lawn & Patio" の場合は "Lawn%20%26%20Patio" とします。

タイプ: 文字列

デフォルト値: なし

有効な値: サーチインデックス。サーチインデックスの一覧については、国ごとに使用可能なサーチインデックス をご参照ください。

いいえ
ProductPage

リストの特定のページを取得します。各ページには10個のリストが表示されます。

タイプ: 文字列

デフォルト値: なし

有効な値: 1~30までの整数

いいえ
Sort

レスポンス内のリストの商品を並べ替える方法。ほしい物リストでのみ使用してください。

タイプ: 文字列

デフォルト値: なし

有効な値: DateAdded--商品がリストに追加された日付をもとに並べ替えます。

LastUpdated--リストの商品が最後に更新された日付をもとに並べ替えます。リストの商品を更新すると、優先順位、商品に関するコメント、希望する商品の数量などが変更されます。

Price--安い順に並べ替えます。

Priority--カスタマーは、ほしい物リストに追加する各商品に優先順位の値を割り当てることができます。値には、最高、高、中 (デフォルト) 、低、最低を指定できます。Sort=Priority を ListLookup リクエストに指定すると、商品は優先順位の高い順に並べ替えられます。

いいえ
ResponseGroup

返される値の種類を指定します。1つのリクエストに複数のレスポンスグループをカンマで区切って指定できます。

タイプ: 文字列

デフォルト: Request

ListInfo

有効な値: Accessories | BrowseNodes | EditorialReview | Images | ItemAttributes | ItemIds | Large | ListFull | ListItems | ListmaniaLists | Medium | Offers | OfferSummary | Reviews | SalesRank | Similarities | Small | Subjects | Tracks | VariationMinimum | Variations | VariationSummary |

いいえ
IsIncludeUniversal

Universal Wish List (何でもほしい物リスト) の商品を含めるかどうかを指定します (USのみ)。

タイプ: ブール値

デフォルト値: なし

有効な値: True | False

いいえ

ListLookup には、全てのオペレーションで使用できるパラメータを指定できます。詳細については、共通のリクエストパラメータをご参照ください。

レスポンス

名前説明
CustomerName リストを作成したカスタマーの名前。
DateCreated リストの作成日。年-月-日の形式で表示します。
ListName カスタマーにより設定されたリストの名前。
ListType リストの種類。Product Advertising API では、リストの種類は以下のいずれかになります: WishList, WeddingRegistry, Listmania.
PriorityPriority--カスタマーは、ほしい物リストに追加する各商品に優先順位の値を割り当てることができます。値には、最高、高、中 (デフォルト) 、低、最低を指定できます。ListLookupレスポンスで、これらの値は <priority> タグで返されます。
TotalItems リスト上にある商品の合計数。
TotalPages 商品の総ページ数。各ページに最大で10個の商品が表示されます。

これらのタグの親要素に関する詳細については、レスポンスグループの該当するレスポンスグループをご参照ください。

ListLookup を使用し、ListId 99999999999999 で識別されるほしい物リストに関する要約情報を返します。

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS アクセスキー ID]&
Operation=ListLookup&
ListType=WishList&
ListId=99999999999999

このリクエストに対するレスポンスをレスポンス例に示します。

出品情報とともにリスト内の商品も返すには、Large レスポンスグループを使用します。

リストの商品を価格で並べ替えて返すには、Sortパラメータを使用します。

レスポンス例

次に示すのは、上の例の最初のリクエストで返されるレスポンスの一部です。

<ListItem>
  <ListItemId>IOWNUUPH86VRC</ListItemId>
  <DateAdded>2002-01-27</DateAdded>
  <QuantityDesired>1</QuantityDesired>
  <QuantityReceived>0</QuantityReceived>
  <Item>
    <ASIN>1890966533</ASIN>
    <ItemAttributes>
      <Title>Safety Incentives: The Pros and Cons of Award and Recognition Programs (Osha Compliance)</Title>
    </ItemAttributes>
  </Item>
</ListItem>
<ListItem>
  <ListItemId>I1JY2MH4BGECYR</ListItemId>
  <DateAdded>2002-01-27</DateAdded>
  <QuantityDesired>1</QuantityDesired>
  <QuantityReceived>0</QuantityReceived>
  <Item>
    <ASIN>0963229613</ASIN>
    <ItemAttributes>
      <Title>Confined Space Program: A Complete Compliance Program (Osha Compliance)
      </Title>
    </ItemAttributes>
  </Item>
</ListItem>

このレスポンスでは、ほしい物リストの2つの商品を示しています。

関連オペレーション