GET/advertising_eligibility
This method allows developers to check the seller eligibility status for eBay advertising programs.
Input
Resource URI
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 |
|---|---|---|
| program_types | string | A comma-separated list of eBay advertising programs. Tip: See the AdvertisingProgramEnum type for possible values. If no programs are specified, the results will be returned for all programs. Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. Note: This value is case-sensitive. Occurrence: Required |
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.account
https://api.ebay.com/oauth/api_scope/sell.account.readonly
eBayUser
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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| advertisingEligibility | array of SellerEligibilityResponse | An array of response fields that define the seller eligibility for eBay adverstising programs. Occurrence: Always |
| advertisingEligibility.programType | AdvertisingProgramEnum | The eBay advertising program for which a seller may be eligible. Occurrence: Always |
| advertisingEligibility.reason | SellerIneligibleReasonEnum | The reason why a seller is ineligible for the specified eBay advertising program. Occurrence: Conditional |
| advertisingEligibility.status | SellerEligibilityEnum | The seller elibibilty status for the specified eBay advertising program. Occurrence: Always |
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 |
| 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_ACCOUNT | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 35002 | API_ACCOUNT | APPLICATION | Internal error. Please wait a few minutes and try the call again. |
| 50114 | API_ACCOUNT | REQUEST | The HTTP request header 'X-EBAY-C-MARKETPLACE-ID' is required. |
| 50116 | API_ACCOUNT | REQUEST | Invalid program_type(s) {programTypes}. |
| 50117 | API_ACCOUNT | REQUEST | Invalid marketplaceId in HTTP request header 'X-EBAY-C-MARKETPLACE-ID' {marketplaceId}. |
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: Check Seller Eligibility Status
This example retrieves seller eligibility details for program types within the specified eBay marketplace.
Input
The input for this sample is the eBay marketplace ID, which is passed in using the X-EBAY-C-MARKETPLACE-ID HTTP header. This call does not use a request payload.
GEThttps://api.ebay.com/sell/account/v1/advertising_eligibility
Output
If the call is successful, the seller eligibility details for the program types available in the specified marketplace are returned.