SellerListingSearch Operation

Description

The SellerListingSearch operation allows you to search for zShops and marketplace listings.

Note:

SellerListingSearch cannot return listings for featured merchants' items. Only merchants with New, Used, Refurbished, and Collectible offerings are returned. To find items belonging to a specific featured merchant, use the ItemSearch operation, passing the merchant's ID in the MerchantId parameter.

The SellerListingSearch operation in the FR, CA, and JP locales use a different set of operation parameters, which is described below.

Availability

SellerListingSearch is available in all locales.

Sample Request | Parameters

Sample Request

Using SellerListingSearch (REST)

This example demonstrates how SellerListingSearch can be used to search for marketplace items by keyword and have the results sorted by price.

http://webservices.amazon.com/onca/xml?Service=AWSECommerceService&SubscriptionId=[Your
Subscription ID
Here]&Operation=SellerListingSearch&SearchIndex=Marketplace&Keywords=[A
Keywords
String]&Sort=+price&OfferStatus=Open
[ back to top ]

Request Parameters

Request parameters specify the terms of your request and control the output data that is returned to you.

You must include the required parameters in every request.

SellerListingSearch accepts the optional parameters that are common to all operations:

The following parameters are specific to the SellerListingSearch operation:

Parameter Description Required? Value
Operation

The operation.

 Always Required SellerListingSearch
SearchIndex

Use the SearchIndex parameter to specify the type of seller listings you would like to find, zShops listings or marketplace listings. This parameter only applies to the US, UK, and DE locales.

Required, except in the JP locale.

Valid Values:

  • ZShops

  • Marketplace

Keywords

Use the Keywords parameter to refine your seller listing search. You may not use the Keywords parameter and the Title parameter in the same request. The Keywords parameter accepts a string containing one or more words. The Keywords parameter allows SellerListingSearch to search inside listing titles and descriptions for matches. This parameter only applies to the US, UK, and DE locales.

 

Valid Value:

  • A Keywords String
Title

Use the Title parameter to refine your seller listing search to listings containing matching title words. You may not use the Title parameter and the Keywords parameter in the same request. The Title parameter accepts a string containing one or more title words.

 

Valid Value:

  • A Title words string
ShipOption

Use the ShipOption parameter to filter your search results based on whether the seller listings matching your search request can be shipped to or from the value in the Country parameter. If the ShipOption parameter is specified, the Country parameter also must be specified. This parameter only applies to the US, UK, and DE locales.

 

Valid Values:

  • ShipTo

  • ShipFrom

Country

Use the Country parameter in conjunction with the ShipOption parameter to specify the country to associate with the selected shipping option (ShipTo or ShipFrom). Valid country codes can be found on the zShops country codes page. This parameter only applies to the US, UK, and DE locales.

Required with ShipOption Parameter

Valid Value:

  • A zShops Country Code
BrowseNode

Use the BrowseNode parameter to filter your seller listing search results by how they have been classified in the browse taxonomy. The value must match a zShops or marketplace browse node. This parameter only applies to the US, UK, and DE locales.

 

Valid Value:

  • A Browse Node ID
PostalCode

Use the PostalCode parameter to filter your seller listing search results by a specific postal code. This parameter only applies to the US, UK, and DE locales.

 

Valid Value:

  • A Postal Code
Sort

Use the Sort parameter to specify how your seller listing search results will be ordered. The -bfp (featured listings - default), applies only to the US, UK, and DE locales.

 

Default Value:

  • -bfp

Valid Values:

  • -bfp

  • -startdate

  • +startdate

  • +price

  • -price

ListingPage

This parameter specifies which page of listings to return with the request, where a page is up to 10 search results at a time. Specifying 1 returns the first page (items 1 through 10), specifying 2 returns the second page (items 11 through 20), etc. The maximum ListingPage number that can be specified is 500. If you do not include ListingPage in your request, all of the listings are returned if there are less than 10, the first 10 are returned if there are more than 10.

Always Optional

Default Value:

  • 1

Valid Values:

  • Integers 1 to 500
OfferStatus

Use the OfferStatus parameter to filter your seller listing search results by whether the offer status is closed (sold or unpurchasable) or open (purchasable). This parameter only applies to the US, UK, and DE locales.

 

Default Value:

  • Open

Valid Values:

  • Open

  • Closed

SellerId

Use the SellerId parameter to filter the seller listing search results by a zShops or marketplace seller ID. When SellerId is the only specified parameter (other than Operation and SearchIndex, which are required), the SellerListingSearch operation returns all of the specified seller's listings.

Optional for US, UK, and DE. Required for JP, FR, and CA.

Valid Value:

  • A Seller ID
ResponseGroup

Controls the data returned by the operation. Use this parameter to specify which response group(s), or group(s) of data elements, you would like Amazon E-Commerce Service (ECS) to return to you.

You can specify as many response groups as you wish using a comma-separated list (REST) or multiple elements (SOAP).

 Always Optional

Default Values

Valid Values
[ back to top ]