This doc page has moved! You should be automatically redirected to the resources page for the eBay Account API. If you are not redirected automatically, follow this link to the Account API.

eBay Account APIVersion 1.2.0

Get Opted-in Programs

GET /program/get_opted_in_programs

Use this call to get a list of the seller programs that the seller has opted-in to.

Input

See also Samples.

Resource URI (production)

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

This call has no path or query parameters.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

This request requires a user access token with the following scope:

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

https://api.ebay.com/oauth/api_scope/sell.account.readonly

See Getting Access Tokens for more information.



Payload model

This call has no request payload.


Output

See also Samples.

HTTP status codes

This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

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

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

{ /* Programs */
"programs": [
    { /* Program */
    "programType": string
    }
    /* More Program nodes here */
  ]
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
programs array of Program Conditionally A list of seller programs.
programs.programType string Conditionally Program type.

Applicable values are from ProgramTypeEnum:

OUT_OF_STOCK_CONTROL
The Out of Stock Control program that sellers can participate in by opting-in to the program.
SELLING_POLICY_MANAGEMENT
The selling policy management program that sellers can participate in by opting-in to the program. Sellers must opt-in to this program if they want eBay to associste the business policies they create with the items they list.

Code so that your app gracefully handles any future changes to this list.



Error Codes

Code Domain Category Nature Meaning
20404 API_ACCOUNT REQUEST ERROR {fieldName} not found.
20500 API_ACCOUNT APPLICATION ERROR System error.
20501 API_ACCOUNT APPLICATION ERROR Service unavailable. Please try again in next 24 hours.



Samples

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Get opted-in programs.

Retrieves the eBay seller programs to which the seller has enrolled.

Description

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.

URL format. See also the non-wrapped version of this URL.

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.

JSON format.
{
  "programs": [
    {
      "programType": "OUT_OF_STOCK_CONTROL"
    },
    {
      "programType": "SELLING_POLICY_MANAGEMENT"
    }
  ]
}



Change History

Change Date Description
1.0.0
2016-10-19
  • Call (added): New call.