CMS365.EbaySharp 6.4.0

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
        • Create a new listing
      • Inventory item
        • Get inventory items
        • Get inventory item
        • Create or replace inventory item
        • Delete inventory item
      • Inventory location
        • Get inventory locations
        • Get inventory location
        • Create inventory location
        • Delete inventory location
      • Offer
        • Get offers
        • Get offer
        • Create offer
        • Update offer
        • Publish offer
        • Withdraw offer
        • Delete offer
    • Fulfillment
      • Order
        • Shipping fulfillment
          • Get shipping fulfillments
          • Get shipping fulfillment
          • Create shipping fulfillment
        • Get orders by order numbers
        • Get orders by filter
    • Metadata
      • Marketplace
        • Get return policies
  • Commerce
    • Taxonomy
      • Category Tree
        • Get default category tree Id
        • Get category suggestions
        • Get category tree
  • Developer
    • Analytics
      • Rate Limit
        • Get rate limits

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> GetRefreshToken()
{
    string secureURL="replace with the URL of the thank you page";
    EbaySharp.Controllers.IdentityController identityController = new EbaySharp.Controllers.IdentityController();
    string refreshToken = await IdentityController.GetRefreshToken(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);

Provide scope separated by a space, for example https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly 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

You can find more detail here 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.BulkMigrate(bulkMigrateListingRequest);

Create a new listing

If you want to create a new listing, you will need to perform following 3 steps.

MarketplaceEnum? marketplaceId = MarketplaceEnum.EBAY_AU (for example)
CurrencyCodeEnum? CurrencyCodeId = CurrencyCodeEnum.AUD (for example)


1 - Create a new inventory item

EbaySharp.Entities.Sell.Inventory.InventoryItem.InventoryItem inventoryItem = new EbaySharp.Entities.Sell.Inventory.InventoryItem.InventoryItem()
{
    Condition = ConditionEnum.NEW,
    Availability = new Availability() { ShipToLocationAvailability = new ShipToLocationAvailability() { Quantity = 3, AllocationByFormat = new AllocationByFormat() { FixedPrice = 3 } } },
    Product = new EbaySharp.Entities.Sell.Inventory.InventoryItem.Product()
    {
        Title = YOUR PRODCT TITLE,
        Aspects = DICTIONARY OF ASPECTS IN Dictionary<string, string[]> FORMAT,
        Brand = PRODUCT BRAND,
        MPN = SKU/MPN,
        ImageUrls = ARRAY OF IMAGE URLS
    },
    Locale = LOCALE OF YOUR STORE
};
CreatedOrReplacedInventoryItem createdOrReplacedInventoryItem = await ebayController.CreateOrReplaceInventoryItem(UNIQUE SKU OF THE PRODUCT, inventoryItem);

2 - Create a new offer

OfferCreated offerCreated = await ebayController.CreateOffer(new Offer()
{
    SKU = UNIQUE SKU OF THE PRODUC,
    MarketplaceId = marketplaceId,
    Format = FormatTypeEnum.FIXED_PRICE,
    PricingSummary = new PricingSummary() { Price = new EbaySharp.Entities.Common.Amount() { Currency = CurrencyCodeId, Value = Math.Round(YOUR SELLING PRICE, 2).ToString() } },
    MerchantLocationKey = MerchantLocationKey,
    CategoryId = CATEGORY ID,
    ListingPolicies = new ListingPolicies()
    {
        FulfillmentPolicyId = fulfillmentPolicyId, // YOU WILL NEED TO FIND THE ID OF YOUR POLICY ID
        PaymentPolicyId = paymentPolicyId, // YOU WILL NEED TO FIND THE ID OF YOUR POLICY ID
        ReturnPolicyId = returnPolicyId // YOU WILL NEED TO FIND THE ID OF YOUR POLICY ID
    },
    ListingDescription = LONG DESCRIPTION OF THE PRODUCT,
    AvailableQuantity = quantity // FOR EXAMPLE 2
}, locale);

3 - Publish offer

OfferPublished offerPublished = await ebayController.PublishOffer(offerCreated.OfferId, LOCALE OF YOUR STORE);

Inventory Item

Get inventory items

You can find more detail here

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

Get inventory item

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
InventoryItem inventoryItem = await ebayController.GetInventoryItem(SKU);

Create or replace inventory item

You can find more detail here

Dictionary<string, string[]> aspects = new Dictionary<string, string[]>
{
    { "Brand", new[] { "GoPro" } },
    { "Type", new[] { "Helmet/Action" } }
};

CreatedOrReplacedInventoryItem createdOrReplacedInventoryItem = await ebayController.CreateOrReplaceInventoryItem("test-sku-api", new InventoryItem()
{
    Availability = new Availability() { ShipToLocationAvailability = new ShipToLocationAvailability() { Quantity = 3 } },
    Condition = ConditionEnum.NEW,
    Product = new Product()
    {
        Title = "Creating from REST API, please don't buy",
        Description = "I am created by the REST API",
        Aspects = aspects,
        Brand = "GoPro",
        MPN = "CHDHX-401",
        ImageUrls = new[] { "https://i.ebayimg.com/images/g/OKsAAOSwr2VlsUPx/s-l1600.jpg", "https://i.ebayimg.com/images/g/a9AAAOSw2IVlsUPz/s-l1600.jpg" }
    },
    //Find locale information here https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl
    Locale = "en-AU"
});

Delete inventory item

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
await ebayController.DeleteInventoryItem(SKU);

Inventory Location

Get inventory locations

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
InventoryLocations inventoryLocations = await ebayController.GetInventoryLocations(limit, offset);

Get inventory location

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
InventoryLocation inventoryLocation = await ebayController.GetInventoryLocation(merchantLocationKey);

Create inventory location

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
await ebayController.CreateInventoryLocation(new InventoryLocation()
{
    MerchantLocationKey = merchantLocationKey,
    LocationTypes = new List<StoreTypeEnum>() { StoreTypeEnum.WAREHOUSE },
    MerchantLocationStatus = StatusEnum.ENABLED,
    Location = new Location()
    {
        Address = new Address()
        {
            PostalCode = "3698",
            Country = CountryCodeEnum.AU
        }
    }
});

Delete inventory location

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
await ebayController.DeleteInventoryLocation(merchantLocationKey);

Offer

Get offers

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
OffersList offersList = await ebayController.GetOffers(SKU);

Get offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Offer offer = await ebayController.GetOffer(offerId);

Create offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Offer offer = new Offer()
{
    SKU = SKU,
    MarketplaceId = MarketplaceEnum.EBAY_AU,
    Format = FormatTypeEnum.FIXED_PRICE,
    PricingSummary = new PricingSummary()
    {
        Price = new Amount()
        {
            Currency = "AUD",
            Value = "75"
        }
    },
    MerchantLocationKey = inventoryLocation.MerchantLocationKey,
    CategoryId = "162480",
    ListingPolicies = new ListingPolicies()
    {
        FulfillmentPolicyId = "ReplaceYourFulfillmentPolicyId",
        PaymentPolicyId = "ReplaceYourPaymentPolicyId",
        ReturnPolicyId = "ReplaceYourReturnPolicyId"
    }
};
OfferCreated offerCreated = await ebayController.CreateOffer(offer, "en-AU");

Update offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Offer offer = await ebayController.GetOffer(offerId);
offer.PricingSummary.Price.Value = "100";
OfferUpdated offerUpdated = await ebayController.UpdateOffer(offerId, offer, "en-AU");

Publish offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
OfferPublished offerPublished = await ebayController.PublishOffer(offerId, "en-AU");

Withdraw offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
OfferWithdrawn offerWithdrawn = await ebayController.WithdrawOffer(offerId);

Delete offer

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
await ebayController.DeleteOffer(offerId);

Fulfillment

You can find more detail here

Order

Shipping Fulfillment

Get shipping Fulfillments

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Fulfillments fulfillments = await ebayController.GetShippingFulfillments("Order Number");

Get shipping Fulfillment

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Fulfillment fulfillment = await ebayController.GetShippingFulfillment("Order Number", "Fulfillment Id");

Create shipping Fulfillment

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
List<EbaySharp.Entities.Sell.Fulfillment.Order.Order> allOrders = new List<EbaySharp.Entities.Sell.Fulfillment.Order.Order>();
int totalCount = 0;
do
{
    var eBayOrders = await ebayController.GetOrders("orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}", 50, totalCount);
    totalCount = eBayOrders.Total;
    allOrders.AddRange(eBayOrders.OrderList);
} while (allOrders.Count < totalCount);
EbaySharp.Entities.Sell.Fulfillment.Order.Order order = allOrders.Where(x => x.OrderId == orderTracking.OrderNumber).FirstOrDefault();

//Execute the following block in a loop If you have multiple tracking numbers.
await ebayController.CreateShippingFulfillment("Order Number", new EbaySharp.Entities.Sell.Fulfillment.Order.ShippingFulfillment.Fulfillment()
{
    LineItems = order.LineItems.Select(x => new EbaySharp.Entities.Sell.Fulfillment.Order.ShippingFulfillment.LineItem()
    {
        LineItemId = x.LineItemId,
        Quantity = x.Quantity
    }).ToList(),
    TrackingNumber = "Tracking Number",
    ShippingCarrierCode = "Courier Name",
    ShippedDate = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.0Z")
});

Get orders by order numbers

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
Orders orders = await ebayController.GetOrders(new string[] { "ORDERNUMBER", "ORDERNUMBER" });

Get orders by filter

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
string dateRange = $"{(DateTime.UtcNow.AddDays(-10).ToString("yyyy-MM-ddThh:mm:00.0Z"))}..{(DateTime.UtcNow.ToString("yyyy-MM-ddThh:mm:00.0Z"))}";
Orders orders = await ebayController.GetOrders($"creationdate:[{dateRange}]",50);
or
orders = await ebayController.GetOrders($"lastmodifieddate:[{dateRange}]");
or
orders = await ebayController.GetOrders("orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}");

Metadata

You can see a list of Metadata methods here

Marketplace

Get return policies

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

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
ReturnPoliciesList returnPoliciesList = await ebayController.GetReturnPolicies("EBAY_US");

Commerce

Taxonomy

You can see a list of Taxonomy methods here

Category Tree

Get default category tree Id

You can find more detail here You need to pass MarketplaceId, please visit here for supported market places.

CategoryTreeId categoryTreeId = await ebayController.GetDefaultCategoryTreeId("EBAY_US");

Get category suggestions

You can find more detail here You need to pass a Category Tree Id and the product title you are searching categories for.

CategorySuggestionsList categorySuggestionsList = await ebayController.GetCategorySuggestions(15, "I am a table, look for me");

Get category tree

You can find more detail here You need to pass a Category Tree ID.

CategoryTree categoryTree = await ebayController.GetCategoryTree(15);

Developer

Analytics

You can see a list of Analytics methods here

Rate Limits

Get rate limits

You can find more detail here

EbaySharp.Controllers.EbayController ebayController = new EbaySharp.Controllers.EbayController(clientCredentials.AccessToken);
RateLimits rateLimits = await ebayController.GetRateLimits();