account APIv1.4.0

getPrivileges

GET
/privilege/
This method retrieves the seller's current set of privileges. The call returns 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

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 scope from the following list:

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
sellerRegistrationCompletedbooleanIf set to true, the seller's registration is completed.

Occurrence: Conditional

sellingLimitSellingLimitComplex type defining the selling limits for the associated seller account.

Occurrence: Conditional

sellingLimit.amountAmountThe maximum merchandise amount (value and quantity) that a seller can list per calendar month.

Occurrence: Conditional

sellingLimit.amount.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Conditional

sellingLimit.amount.valuestringThe value of the monetary amount in the specified currency.

Occurrence: Conditional

sellingLimit.quantityintegerThe maximum quantity of items that can be listed by the seller per calendar month. Note that for a listing with variations, all of the items listed in the variation count as individual items.

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.

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.
GET
https://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.