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

Opt-out of Program

POST /program/opt_out

Use this call to opt-out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the Get Opted-in Seller Programs call.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/sell/account/v1/program/opt_out

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

See Getting Access Tokens for more information.



Payload model

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

{ /* Program */
"programType": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
programType string Required 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.

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
204 Success
400 Bad Request
404 Not Found
500 Internal Server Error

Payload model

This call has no response payload.



Error Codes

Code Domain Category Nature Meaning
20401 API_ACCOUNT REQUEST ERROR Missing field {fieldName}. {additionalInfo}
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: Opt-out of a seller program

Description

This request withdraws the seller from an eBay seller program in which they are enrolled.

Input

Supply the program that you want to opt-out of using the programType field.

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

POST https://api.sandbox.ebay.com/sell/account/v1/program/opt_out

{
  "programType":"SELLING_POLICY_MANAGEMENT"
}

Output

This call does not return a response payload.

JSON format.
If successful, this call returns an HTTP status code of "200 OK" and an empty response body.



Change History

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