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

GET /privilege

Use this call to retrieve 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

See also Samples.

Resource URI (production)

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

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
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.

{ /* SellingPrivileges */
"sellerRegistrationCompleted": boolean,
"sellingLimit":
    { /* SellingLimit */
    "amount":
        { /* Amount */
        "currency": string,
        "value": string
        },
    "quantity": integer
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
sellerRegistrationCompleted boolean Conditionally If this value is set to true, it indicates the seller's registration is completed.
sellingLimit SellingLimit Conditionally Complex type defining the selling limits for the associated seller account.
sellingLimit.amount Amount Conditionally The maximum merchandise amount (value and quantity) that a seller can list per calendar day.
sellingLimit.amount.currency string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
sellingLimit.amount.value string Conditionally The value of the amount in the specified currency.
sellingLimit.quantity integer Conditionally The maximum quantity of items that can be listed by the seller per calendar day. Note that for a listing with variations, all of the items listed in the variation count as individual items.



Error Codes

Code Domain Category Nature Meaning
20500 API_ACCOUNT APPLICATION ERROR System error.



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

This call retrieves the account privileges for the seller.

Description

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.

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

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.

JSON format.
{
  "sellingLimit": {
    "amount": {
      "value": "100.0",
      "currency": "USD"
    },
    "quantity": 10
  },
  "sellerRegistrationCompleted": true
}



Change History

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