Skip to main content

GET/privilege

This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimt (the amount and quantity they can sell on a given day).

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/privilege

URI parameters

This method has no URI parameters.

HTTP request headers

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

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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.

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/fieldTypeDescription
sellerRegistrationCompletedboolean

If this field is returned as true, the seller's registration is completed. If this field is returned as false, the registration process is not complete.

Occurrence: Always

sellingLimitSellingLimit

This container lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold and total sales amount.

Occurrence: Conditional

sellingLimit.amountAmount

This container shows the monthly cap for total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total sales amount.

Occurrence: Conditional

sellingLimit.amount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

sellingLimit.amount.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

sellingLimit.quantityinteger

This field shows the monthly cap for total quantity sold allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold.

Occurrence: Conditional

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
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
20500API_ACCOUNTAPPLICATIONSystem error.

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: Get Account Privileges

This call returns the privileges for a seller. The privileges returned include the seller's sellingLimit, their quantity limit, and the status of their seller registration in sellerRegistrationCompleted.

Input

This call does not use a request payload.

GEThttps://api.sandbox.ebay.com/sell/account/v1/privilege

Output

A successful call returns an HTTP status of "200 OK" and a payload that contains the values of all the seller's privileges.