account APIv1.4.0

getOptedInPrograms

GET
/program/get_opted_in_programs
This method gets a list of the seller programs that the seller has opted-in to.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/program/get_opted_in_programs

URI parameters

HTTP request headers

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

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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
programsarray of ProgramA list of seller programs.

Occurrence: Conditional

programs.programTypeProgramTypeEnumA seller program in to which a seller can opt-in.

Occurrence: Required

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.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
20404API_ACCOUNTREQUEST{fieldName} not found.
20500API_ACCOUNTAPPLICATIONSystem error.
20501API_ACCOUNTAPPLICATIONService unavailable. Please try again in next 24 hours.

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: Get opted-in programs.

Sellers can opt-in to the seller programs offered by eBay. This call returns the programs in which the seller is participating.

Input

This call does not use a request payload.
GET
https://api.sandbox.ebay.com/sell/account/v1/program/get_opted_in_programs

Output

A successful call returns an HTTP status of "200 OK" and a payload that contains a current list of the seller programs in which the seller is participating.