CMS365.EbaySharp 1.0.7

EbaySharp: A .NET wrapper library for eBay REST API.

EbaySharp is a .NET library that enables you to authenticate and make REST API calls to eBay. It's used for creating listings and managing orders using C# and .NET

Installation

EbaySharp is available on NuGet. Use the package manager console in Visual Studio to install it:

Install-Package CMS365.EbaySharp

API support

EbaySharp currently supports the following Ebay REST APIs:

• Access and Security
  • Getting a user access token
• Using the EbaySharp
  • Using the EbaySharp
  • Sell
    • Inventory
      • Listing
        • Bulk migrate listings
        • Get inventory items
        • Get inventory item
    • Metadata
      • Marketplace
        • Get return policies
  • Commerce
    • Taxonomy
      • Category Tree
        • Get default category tree id
        • Get category suggestions
        • Get category tree

Access and Security

Create an account here https://developer.ebay.com/my/keys and generate keys for production.

For example:

Navigate to user tokens https://developer.ebay.com/my/auth/?env=production&index=0 and select following options.

From the same page, generate the ebay redirect URL (called RU)

Copy the URL of the field "Your branded eBay Production Sign In (OAuth)" and open in a new browser in private mode and also save a copy of the URL for future use. Log in with your store user id and password and you will be redirected to the following page

Copy the URL of the thank you page and assign it to a variable called "secureURL" and execute the following function.

public async Task<string> GetRefreshTokenAsync()
{
    string secureURL="replace with the URL of the thank you page";
    EbaySharp.Controllers.IdentityController identityController = new EbaySharp.Controllers.IdentityController();
    string refreshToken = await identityController.GetRefreshTokenAsync(ReplaceYourClientID, ReplaceYourClientSecret, 
        , secureURL, Replace with RU);
}

This method returns a refresh token which is valid for 18 months. You will need to re run this function after 18 months when refresh token has expired. We will use the refresh token and generate an access token.

IdentityController identityController=new IdentityController();
var clientCredentials = await identityController.GetClientCredentials(ReplaceYourClientID, ReplaceYourClientSecret, ReplaceWithRefreshToken , ReplaceWithScopes);

This method now gives you ClientCredentialsResponse object which contains an access token.

Using the EbaySharp

Initialize the instance with the access token.

EbayController ebayController = new EbayController(clientCredentials.AccessToken);

Sell

Inventory

You can see a list of Inventory methods here

Listing

Bulk migrate listings

If you have already created your listing using old API (for example .NET C# SDK), you will need to migrate all listing to new REST API. You can find more detail here

BulkMigrateListingRequest bulkMigrateListingRequest = new BulkMigrateListingRequest()
{
    Requests = new BulkMigrateListingRequestItem[]
    {
        new BulkMigrateListingRequestItem(){ListingID = "21432432432" },
        new BulkMigrateListingRequestItem(){ListingID = "78658678678" }
    }
});
EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
BulkMigrateListingResponse bulkMigrateListingResponse = await ebayController.BulkMigrateAsync(bulkMigrateListingRequest);

Get inventory items

You can get list of existing items, you need to pass limit (default is 25 and max is 200) and offset (default for first page is 0). You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
InventoryItemsResponse bulkMigrateListingResponse = await ebayController.GetInventoryItems(limit, offset);

Get inventory item

You can get an item based on a sKU You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
InventoryItemResponse inventoryItemResponse = await ebayController.GetInventoryItem(SKU);

Metadata

You can see a list of Metadata methods here

Marketplace

Get return policies

ReturnPoliciesResponse returnPoliciesResponse = await ebayController.GetReturnPoliciesAsync("EBAY_US");

You need to pass MarketplaceID, please visit here for supported market places.

Commerce

Taxonomy

You can see a list of Taxonomy methods here

Category Tree

Get default category tree id

CategoryTreeIDResponse categoryTreeIDResponse = await ebayController.GetDefaultCategoryTreeIDAsync("EBAY_US");

You need to pass MarketplaceID, please visit here for supported market places.

Get category suggestions

CategorySuggestionsResponse categorySuggestionsResponse = await ebayController.GetCategorySuggestionsAsync(15, "I am a table, look for me");

You need to pass a Category Tree ID and the product title you are searching categories for.

Get category tree

CategoryTreeResponse categorySuggestionsResponse = await ebayController.GetCategoryTreeAsync(15);

You need to pass a Category Tree ID.