suggestItems | eBay Marketing API

GET/ad_campaign/{campaign_id}/suggest_items

Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns.

Input

Resource URI

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/suggest_items?

category_ids=string&

limit=string&

offset=string&

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
category_ids	string	Specifies the category ID that is used to limit the results. This refers to an exact leaf category (the lowest level in that category and has no children). This field can have one category ID, or a comma-separated list of IDs. To return all category IDs, set to `null`. Maximum: 10 Occurrence: Optional
limit	string	Specifies the maximum number of campaigns to return on a page in the paginated response. If no value is specified, the default value is used. Default: 10 Minimum: 1 Maximum: 1000 Occurrence: Optional
offset	string	Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of `0` and a limit of `10`, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is `10` and limit is `20`, the first page of the response contains items 11-30 from the complete result set. Default: 0 Occurrence: Optional
campaign_id	string	A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method. Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* TargetedAdsPagedCollection<TargetingItems> */

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"suggestedItems" : [

{ /* TargetingItems */

"bases" : [

{ /* ItemBasis */

"estimatedValue" : "integer",

"metric" : "TargetingMetricsEnum : [SEARCH_IMPRESSIONS]"

}

"listingId" : "string"

}

"total" : "integer"

}

Response fields

Output container/field	Type	Description
href	string	The URI of the current page of results from the result set. Occurrence: Conditional
limit	integer	The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter. Occurrence: Conditional
next	string	The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set. Occurrence: Conditional
offset	integer	The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Default: 0 Note: The items in a paginated result set use a zero-based list, where the first item in the list has an offset of `0`. Occurrence: Conditional
prev	string	The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Occurrence: Conditional
suggestedItems	array of TargetingItems	A list of suggested items in the paginated collection. Occurrence: Conditional
suggestedItems.bases	array of ItemBasis	The metrics and additional information for the items. Occurrence: Conditional
suggestedItems.bases.estimatedValue	integer	The estimated value of the search impressions for items based on the provided dimensions. Duration: 17 days Total slots: 200 Channel: Dweb, Mweb, Native Occurrence: Required
suggestedItems.bases.metric	TargetingMetricsEnum	The basis of the statistics. Occurrence: Required
suggestedItems.listingId	string	The listing ID of the targeted item. Occurrence: Required
total	integer	The total number of items retrieved in the result set. Note: If no items are found, this field is returned with a value of `0`. Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	Success
400	Bad Request
404	Not Found
409	Business error
500	Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
35001	API_MARKETING	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35008	API_MARKETING	REQUEST	The category Id {categoryId} is not valid.
35029	API_MARKETING	REQUEST	The 'limit' has to be greater than zero and less than {maxLimitValue}.
35030	API_MARKETING	REQUEST	The 'offset' cannot be less than zero.
35041	API_MARKETING	REQUEST	The 'marketplaceId' is required.
35045	API_MARKETING	REQUEST	No campaign found for campaign id {campaign_id}.
35051	API_MARKETING	BUSINESS	'marketplaceId' {marketplaceId} is not supported. Promoted Listings is supported only on these marketplaces: {supportedMarketplaces}.
35090	API_MARKETING	REQUEST	Category ID limit exceeded. You can pass up to a maximum of {maxCategoryLimit} category IDs per request.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retreive Listing Suggestions

This example retrieves ideas for listings, which can be targeted for Promoted Listings campaigns.

Input

The input for this sample is the campaign_id of the ad campaign for which suggestions shall be retrieved, as well as the category_ids, offset, and limit query parameters.

GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/suggest_items?category_ids=2********6,2********7&offset=10&limit=10

Output

If the call is successful, listing suggestions for the specified campaign and categories are returned.