Thanks to five_notch_trading_post for getting me on the path, took a lot of time but I can now click a button and I get a fully populated c# object mirroring every property of the eBay order. Reading everything that has accumulated over the years saw me downloading both the eBay SDK, several versions of it infact along with the https://github.com/eBay/ebay-oauth-csharp-client libraries which didn't provide me with anything beneficial as there's no documentation and unless you have the fundamental steps right; nothing will work anyway. Because I only needed the simplest of outcomes (order details) once I had the basics of oauth and REST functions, there was no need for the extensive benefits of ebay-oauth-csharp-client which I am sure the author put a lot of energy into. So apart from Json libraries (Newtonsoft.Json.13.0.2\lib\net45\Newtonsoft.Json.dll) via NuGet, and a fair amount of brain massaging, everything required was already baked into my Visual Studio 2019 installation....
using System;
using System.Text;
using System.Windows.Forms;
using System.Net;
using Newtonsoft.Json.Linq;
using System.Web;
using System.Text.RegularExpressions;
using System.Diagnostics;
using System.Threading;
using System.IO;
using System.Collections.Generic;
The cornerstone for me was understanding the Authorization code grant flow, needed to access any scopes outside of the public information you can get without logging into your account. The operational flow to achieve this is within my c# application:
- Obtain an Authorisation Code - in theory this should only be required every 547 days
- Use this Code and the Scopes you need to mint a User Token and a Refresh Token
- Use User Token programatically to retrieve what you need, it lasts 2 hours
- Error Trap within this to detect the error 1001 ("Invalid access token")...
// After 7200 seconds (2 hours)
// "errors" : [ {
// "errorId" : 1001,
// "domain" : "OAuth",
// "category" : "REQUEST",
// "message" : "Invalid access token",
// "longMessage" : "Invalid access token. Check the value of the Authorization HTTP request header."
//} ]
- Exit function, use my Refresh Token to mint a new User Token, and run the function again.
The top of my testing code holds the only variables used throughout my app...
/// <summary>
/// Holds last used, resave if renewed (lasts 2 hours)
/// </summary>
private string _oauthUserToken = "";
/// <summary>
/// Holds last used, resave if renewed (lasts 547.5 days)
/// </summary>
private string _oauthRefreshToken = "";
/// <summary>
/// Result of Login Process
/// </summary>
//private string _authorizationCode <- only called for within one function so kept within it;
string appId; // (Client ID)
//string devId was not called for at-all;
string certId; // (Client Secret)
string ruName; // (eBay Redirect URL name) e.g. Cottontech_Pty_-Xxxxxxxx-Xxxxxx-abcdeabcde
string scope = "https://api.ebay.com/oauth/api_scope " +
"https://api.ebay.com/oauth/api_scope/sell.inventory " +
"https://api.ebay.com/oauth/api_scope/sell.marketing " +
"https://api.ebay.com/oauth/api_scope/sell.account " +
"https://api.ebay.com/oauth/api_scope/sell.fulfillment";
The two eBay pages I visited most were:
1. you follow a consent request https://developer.ebay.com/api-docs/static/oauth-consent-request.html
2. with an authorization code grant request https://developer.ebay.com/api-docs/static/oauth-auth-code-grant-request.html
3. And refresh the User Token when needed: https://developer.ebay.com/api-docs/static/oauth-auth-code-grant-request.html
I hope this helps any others get a few steps into their own projects a little faster that I did. Happy to help further if some external resourcing is needed for your project.
Finally, here's the contents of my OrderDetails class, this is what is extracted from the requried endpoint:
string apiEndpoint = "https://api.ebay.com/sell/fulfillment/v1/order/" + orderNumber;
OrderDetails.cs
using System;
using System.Collections.Generic;
namespace eBaySMD
{
public class OrderDetails
{
public string orderId { get; set; }
public string legacyOrderId { get; set; }
public DateTime creationDate { get; set; }
public DateTime lastModifiedDate { get; set; }
public string orderFulfillmentStatus { get; set; }
public string orderPaymentStatus { get; set; }
public string sellerId { get; set; }
public Buyer buyer { get; set; }
public PricingSummary pricingSummary { get; set; }
public CancelStatus cancelStatus { get; set; }
public PaymentSummary paymentSummary { get; set; }
public List<FulfillmentStartInstruction> fulfillmentStartInstructions { get; set; }
public List<string> fulfillmentHrefs { get; set; }
public List<LineItem> lineItems { get; set; }
public string salesRecordReference { get; set; }
public TotalFeeBasisAmount totalFeeBasisAmount { get; set; }
public TotalMarketplaceFee totalMarketplaceFee { get; set; }
}
public class Amount
{
public string value { get; set; }
public string currency { get; set; }
}
public class Buyer
{
public string username { get; set; }
public TaxAddress taxAddress { get; set; }
}
public class CancelStatus
{
public string cancelState { get; set; }
public List<object> cancelRequests { get; set; }
}
public class ContactAddress
{
public string addressLine1 { get; set; }
public string addressLine2 { get; set; }
public string city { get; set; }
public string stateOrProvince { get; set; }
public string postalCode { get; set; }
public string countryCode { get; set; }
}
public class DeliveryCost
{
public string value { get; set; }
public string currency { get; set; }
public ShippingCost shippingCost { get; set; }
}
public class FulfillmentStartInstruction
{
public string fulfillmentInstructionsType { get; set; }
public DateTime minEstimatedDeliveryDate { get; set; }
public DateTime maxEstimatedDeliveryDate { get; set; }
public bool ebaySupportedFulfillment { get; set; }
public ShippingStep shippingStep { get; set; }
}
public class ItemLocation
{
public string location { get; set; }
public string countryCode { get; set; }
public string postalCode { get; set; }
}
public class LineItem
{
public string lineItemId { get; set; }
public string legacyItemId { get; set; }
public string title { get; set; }
public LineItemCost lineItemCost { get; set; }
public int quantity { get; set; }
public string soldFormat { get; set; }
public string listingMarketplaceId { get; set; }
public string purchaseMarketplaceId { get; set; }
public string lineItemFulfillmentStatus { get; set; }
public Total total { get; set; }
public DeliveryCost deliveryCost { get; set; }
public List<object> appliedPromotions { get; set; }
public List<object> taxes { get; set; }
//public Properties properties { get; set; }
public LineItemFulfillmentInstructions lineItemFulfillmentInstructions { get; set; }
public ItemLocation itemLocation { get; set; }
}
public class LineItemCost
{
public string value { get; set; }
public string currency { get; set; }
}
public class LineItemFulfillmentInstructions
{
public DateTime minEstimatedDeliveryDate { get; set; }
public DateTime maxEstimatedDeliveryDate { get; set; }
public DateTime shipByDate { get; set; }
public bool guaranteedDelivery { get; set; }
}
public class Payment
{
public string paymentMethod { get; set; }
public string paymentReferenceId { get; set; }
public DateTime paymentDate { get; set; }
public Amount amount { get; set; }
public string paymentStatus { get; set; }
}
public class PaymentSummary
{
public TotalDueSeller totalDueSeller { get; set; }
public List<object> refunds { get; set; }
public List<Payment> payments { get; set; }
}
public class PriceSubtotal
{
public string value { get; set; }
public string currency { get; set; }
}
public class PricingSummary
{
public PriceSubtotal priceSubtotal { get; set; }
public DeliveryCost deliveryCost { get; set; }
public Total total { get; set; }
}
public class PrimaryPhone
{
public string phoneNumber { get; set; }
}
public class ShippingCost
{
public string value { get; set; }
public string currency { get; set; }
}
public class ShippingStep
{
public ShipTo shipTo { get; set; }
public string shippingCarrierCode { get; set; }
public string shippingServiceCode { get; set; }
}
public class ShipTo
{
public string fullName { get; set; }
public ContactAddress contactAddress { get; set; }
public PrimaryPhone primaryPhone { get; set; }
public string email { get; set; }
}
public class TaxAddress
{
public string stateOrProvince { get; set; }
public string postalCode { get; set; }
public string countryCode { get; set; }
}
public class Total
{
public string value { get; set; }
public string currency { get; set; }
}
public class TotalDueSeller
{
public string value { get; set; }
public string currency { get; set; }
}
public class TotalFeeBasisAmount
{
public string value { get; set; }
public string currency { get; set; }
}
public class TotalMarketplaceFee
{
public string value { get; set; }
public string currency { get; set; }
}
}
Thanks,
Stewart Wood - Cottontech
