Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchListings

Returns a list of product listings based on search criteria and filters. You can search by keyword, filter by category, pricing model, fulfillment type, and other attributes, and sort results by relevance or customer rating.

Request Syntax


POST /2026-02-05/searchListings HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "filterType": "string",
         "filterValues": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "searchText": "string",
   "sortBy": "string",
   "sortOrder": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

Type: Array of SearchFilter objects

Array Members: Minimum number of 1 item. Maximum number of 30 items.

Required: No

maxResults

The maximum number of results that are returned per call. You can use nextToken to get more results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=]+

Required: No

searchText

The search query text to find relevant listings.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*[^ ]*.*

Required: No

sortBy

The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.

Type: String

Valid Values: RELEVANCE | AVERAGE_CUSTOMER_RATING

Required: No

sortOrder

The sort direction. Valid values are DESCENDING and ASCENDING.

Type: String

Valid Values: DESCENDING | ASCENDING

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "listingSummaries": [ 
      { 
         "associatedEntities": [ 
            { 
               "product": { 
                  "manufacturer": { 
                     "displayName": "string",
                     "sellerProfileId": "string"
                  },
                  "productId": "string",
                  "productName": "string"
               }
            }
         ],
         "badges": [ 
            { 
               "badgeType": "string",
               "displayName": "string"
            }
         ],
         "catalog": "string",
         "categories": [ 
            { 
               "categoryId": "string",
               "displayName": "string"
            }
         ],
         "fulfillmentOptionSummaries": [ 
            { 
               "displayName": "string",
               "fulfillmentOptionType": "string"
            }
         ],
         "listingId": "string",
         "listingName": "string",
         "logoThumbnailUrl": "string",
         "pricingModels": [ 
            { 
               "displayName": "string",
               "pricingModelType": "string"
            }
         ],
         "pricingUnits": [ 
            { 
               "displayName": "string",
               "pricingUnitType": "string"
            }
         ],
         "publisher": { 
            "displayName": "string",
            "sellerProfileId": "string"
         },
         "reviewSummary": { 
            "reviewSourceSummaries": [ 
               { 
                  "averageRating": "string",
                  "sourceId": "string",
                  "sourceName": "string",
                  "sourceUrl": "string",
                  "totalReviews": number
               }
            ]
         },
         "shortDescription": "string"
      }
   ],
   "nextToken": "string",
   "totalResults": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

listingSummaries

The listing summaries matching the search criteria. Each summary includes the listing name, description, badges, categories, pricing models, reviews, and associated products.

Type: Array of ListingSummary objects

totalResults

The total number of listings matching the search criteria.

Type: Long

Valid Range: Minimum value of 0.

nextToken

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=]+

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

reason: The reason that the input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400