Home
POST/program/opt_out
This method opts the seller 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 getOptedInPrograms call.
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
This method has no URI parameters.
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.
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
See OAuth access tokens for more information.
Input container/field | Type | Description |
---|---|---|
programType | ProgramTypeEnum | A seller program in to which a seller can opt-in. Occurrence: Required |
This call has no response headers.
This call has no payload.
This call has no field definitions.
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 | Conflict |
500 | Internal Server Error |
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
20401 | API_ACCOUNT | REQUEST | Missing field {fieldName}. {additionalInfo} |
20500 | API_ACCOUNT | APPLICATION | System error. |
20501 | API_ACCOUNT | APPLICATION | Service unavailable. Please try again in next 24 hours. |
25804 | API_ACCOUNT | REQUEST | {fieldName} already exists |
This call has no warnings.
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.
This request withdraws the seller from an eBay seller program in which they are enrolled.
Supply the program that you want to opt-out of using the programType field.
POSThttps://api.sandbox.ebay.com/sell/account/v1/program/opt_out
A successful call returns the HTTP status code 200 OK. This method has no response payload.