# Scope list
# OAuth2 and eBay
All RESTful eBay calls require that you use OAuth2, which gives very specific permissions (called scopes) to each API call. To make a RESTful call eBay needs to know who you are, which means you've joined the developer program and have been approved. You are then given the minimum set of scopes necessary for your business. So a seller tool gets a different set of scopes from a buyer tool.
Here's a brief explanation of the process along with explanations of some OAuth scope terminology.
# Client ID, aka App ID
eBay assigns you a Client ID, also known as an App ID. That's a publicly visible string identifying your app.
# Your app is considered the Client
In OAuth2 terminology, the client isn't the end user. It's your app.
# Client secret, aka Cert ID
eBay also assigns you a Client secret, also known as a Cert ID. The client secret is private to you and must be treated as sensitive data.
# Permissions are represented by authorization codes, access tokens, and refresh tokens
Each RESTful API call requires a unique string with a limited lifespan. Depending on the call it can be one of the following.
# Authorization code
The Authorization code code,
a temporary string returned when you build a POST request to the
endpoint https://api.ebay.com/identity/v1/oauth2/token for production, or
https://api.sandbox.ebay.com/identity/v1/oauth2/token for the Sandbox. You
pass it query parameters grant_type=client_credentials and an API scope, say,
the basic https://api.ebay.com/oauth/api_scope which every registered eBay developer
can use.
You pass with it headers generated from with your client ID, your client secret, and an optional but recommended random value to check against the returned value to make sure the authorization code wasn't intercepted.
#
# Authorization code grant types
# api_scope
View public data from eBay
Endpoint
https://api.ebay.com/oauth/api_scope
# buy.guest.order
Purchase eBay items anywhere without signing in to eBay
Endpoint
https://api.ebay.com/oauth/api_scope/buy.guest.order
# buy.item.feed
View curated feeds of eBay items
Endpoint
https://api.ebay.com/oauth/api_scope/buy.item.feed
# buy.marketing
Retrieve eBay product and listing data for use in marketing merchandise to buyers
Endpoint
https://api.ebay.com/oauth/api_scope/buy.marketing
# buy.marketplace.insights
View historical sales data to help buyers make informed purchasing decisions
Endpoint
https://api.ebay.com/oauth/api_scope/buy.marketplace.insights
# buy.offer.auction
View and manage bidding activities for auctions
# Used by
Endpoint
https://api.ebay.com/oauth/api_scope/buy.offer.auction
# buy.order.readonly
View your order details
Endpoint
https://api.ebay.com/oauth/api_scope/buy.order.readonly
# buy.product.feed
View curated feeds of products from the eBay catalog
Endpoint
https://api.ebay.com/oauth/api_scope/buy.product.feed
# buy.proxy.guest.order
Purchase eBay items anywhere, using an external vault for PCI compliance
Endpoint
https://api.ebay.com/oauth/api_scope/buy.proxy.guest.order
# buy.shopping.cart
View and manage your shopping cart for eBay items
Endpoint
https://api.ebay.com/oauth/api_scope/buy.shopping.cart
# commerce.catalog.readonly
Search and view eBay product catalog information
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
# commerce.identity.email.readonly`
View a user's personal email information from their eBay member account.
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly
View a user's basic information, such as username or business account details, from their eBay member account
# commerce.identity.phone.readonly
View a user's personal telephone information from their eBay member account
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly
# commerce.identity.address.readonly
View a user's address information from their eBay member account
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly
# commerce.identity.name.readonly
View a user's first and last name from their eBay member account
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly
# commerce.identity.readonly
View a user's basic information, such as username or business account details, from their eBay member account
Endpoint
https://api.ebay.com/oauth/api_scope/commerce.identity.readonly
# sell.account
View and manage your account settings
Endpoint
https://api.ebay.com/oauth/api_scope/sell.account
# sell.account.readonly
View your account settings
Endpoint
https://api.ebay.com/oauth/api_scope/sell.account.readonly
# sell.analytics.readonly
View your selling analytics data, such as performance reports
Endpoint
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
# sell.finances
View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application"
Endpoint
https://api.ebay.com/oauth/api_scope/sell.finances
# sell.fulfillment
View and manage your order fulfillments
Endpoint
https://api.ebay.com/oauth/api_scope/sell.fulfillment
# sell.fulfillment.readonly
View your order fulfillments
Endpoint
https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
# sell.inventory
View and manage your inventory and offers
Endpoint
https://api.ebay.com/oauth/api_scope/sell.inventory
# sell.inventory.readonly
View your inventory and offers
Endpoint
https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
# sell.item_draft
View and manage your item drafts
Endpont
https://api.ebay.com/oauth/api_scope/sell.item_draft
# sell.marketing
View and manage your eBay marketing activities, such as ad campaigns and listing promotions
Endpoint
https://api.ebay.com/oauth/api_scope/sell.marketing
# sell.marketing.readonly
View your eBay marketing activities, such as ad campaigns and listing promotions
Endpoint
https://api.ebay.com/oauth/api_scope/sell.marketing.readonly
# sell.marketplace.insights.readonly
View product selling data to help you make pricing and stocking decisions
Endpoint
https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly
# Client Credential Grant Types
# api_scope
View public data from eBay
Endpoint
https://api.ebay.com/oauth/api_scope
# api_scope/buy.guest.order
Purchase eBay items anywhere without signing in to eBay
Endpoint
https://api.ebay.com/oauth/api_scope/buy.guest.order
# buy.item.feed
View curated feeds of eBay items
Endpoint
https://api.ebay.com/oauth/api_scope/buy.item.feed
# buy.marketing
Retrieve eBay product and listing data for use in marketing merchandise to buyers
Endpoint
https://api.ebay.com/oauth/api_scope/buy.marketing
# buy.product.feed
View curated feeds of products from the eBay catalog
Endpont
https://api.ebay.com/oauth/api_scope/buy.product.feed
# buy.marketplace.insights
View historical sales data to help buyers make informed purchasing decisions
Endpoint
https://api.ebay.com/oauth/api_scope/buy.marketplace.insights
# buy.proxy.guest.order
Purchase eBay items anywhere, using an external vault for PCI compliance
Endpoint
https://api.ebay.com/oauth/api_scope/buy.proxy.guest.order