Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.


The Amazon API supports sorting, ordering, and searching operations.


Note: Always use uppercase for the query parameters.


In your API request, you can append sort=[field name], where field name is a valid parameter returned in the JSON response of your GET request (defined currently as sortable). On sort request based on a field name non sortable - response will be returned in the default order.


By default, the API response is ascending. To control the response order, append order=[order type] (ASC or DESC) when the sort field is specified in the API request.


In your API request, append q=[search string] to get a response that only includes objects in which the search string is included in at least one of the fields returned in the JSON response.

Search structure enables using AND/OR operators functionality in your queries.

The following example is equivalent to the query search for (((name1 || name2) || (id1 || id2)) && (accountId3)).{"1":{"NAME":["account_one", "account_two"],"ID":["1151","1234"]},"2":{"ACCOUNTID":[5155]}}

Each entity has a specific list of fields that are searchable in API requests. For more information, see the related resource article.


Note: API search will return a 9199 error in the following scenarios:

  1. from is not passed

  2. from is negative

  3. from equals or is bigger than 10,000

  4. max is not passed

  5. max is negative

  6. max equals or is bigger than 500

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request