Connect eBay Marketplace with third party systems using eBay APIs

June 27, 2014
Team InSync

eBay Marketplace as we know is the most popular eCommerce Platform, millions of Sellers/Merchants using eBay to sell their products and the biggest advantage they get is the huge number of buyer presence in eBay. In any conventional eCommerce site, to earn this number of buyers you need many years. Also now-a-days the most popular concept of eCommerce is multi-channel, and eBay is an important channel to include.

It is also true that merchants use different systems to monitor their business and to sell their products, for example an eCommerce Website for Online Sales, POS System at the Physical Store, ERP for Back Office Operations, eBay & Amazon for Marketplace Sales, etc. and all these can be used by a single organization which might be not so big in size. So often there are requirements to get the Customer and Order information from eBay for quick Back Office Order Processing, push live inventory updates from Physical Store POS to eBay for regular stock updates and might be more and to achieve this you need to connect eBay with third party systems, like with eCommerce, ERP & POS. This this article we have described how you can connect eBay with third party systems using eBay APIs.

eBay APIs:

EBay Traders API has been investigated for this blog.

The API supports SOAP protocol or general xml formatted requests. The documentation here focuses mainly on the SOAP requests.

SOAP Calls:

Authentication Related calls:

Call Name: GetSessionID
Brief description: This call is used to retrieve a SessionID, which is a unique identifier that is used for authentication during the token-creation process.
Url Parameters: appid,version, callname, siteid
SOAP Header Parameters: RequesterCredentials(AppId ,DevId ,AuthCert)
SOAP Body Parameters: Version, RuName
References:

http: //developer.ebay.com /Devzone/XML/docs/Reference /eBay/ GetSessionID.html

Call Name: FetchToken
Brief description: The call can be used to get a token only after the specified user has given consent for the token to be generated. Consent is given through the eBay sign-in page. After token retrieval, the token can be used to authenticate other calls made on behalf of the associated user.
Url Parameters: appid,version, callname, siteid
SOAP Header Parameters: RequesterCredentials(AppId ,DevId ,AuthCert)
SOAP Body Parameters: SessionID, Version
References: http: //developer.ebay.com /Devzone/XML/docs/Reference /ebay/ FetchToken.html

Data Integration related calls:

Call Name: AddFixedPriceItem
Brief description: This call is used to define and list a new fixed-price item. This call returns the item ID for the new listing, and an estimation of the fees the seller will incur for posting the listing.
Url Parameters: version, callname, siteid
SOAP Header Parameters: RequesterCredentials (eBayAuthToken)
SOAP Body Parameters: Item (type refernences here )
References: http: //developer.ebay.com /Devzone/XML/docs/Reference /ebay/ AddFixedPriceItem.html
Call Name: ReviseFixedPriceItem
Brief description: This call is used to change the properties of a currently active fixed-price listing.
Url Parameters: version, callname, siteid
SOAP Header Parameters: RequesterCredentials (eBayAuthToken)
SOAP Body Parameters: Item (type refernences here )
References: http: //developer.ebay.com /Devzone/XML/docs /Reference /ebay/ ReviseFixedPriceItem.html

Call Name: GetOrders
Brief description: This call is used to retrieve all orders in which the authenticated caller is either the buyer or seller.
Url Parameters: appid,version, callname, siteid
SOAP Header Parameters: RequesterCredentials (eBayAuthToken)
SOAP Body Parameters: CreateTimeFrom, CreateTimeTo
References: http: //developer.ebay.com /Devzone/XML/docs/ Reference /ebay/ GetOrders.html

Call Name: CompleteSale
Brief description: This call is used to do various tasks after the creation of a single line item or multiple line item order. This call can be used to update shipment related informations of an order in EBay.
Url Parameters: version, callname, siteid
SOAP Header Parameters: RequesterCredentials (eBayAuthToken)
SOAP Body Parameters: OrderID, OrderLineItemID(multiple), TransactionID,
Shipment(Notes, ShippedTime, ShipmentTrackingDetails (ShipmentTrackingNumber, ShippingCarrierUsed)
References: http: //developer.ebay.com /Devzone/XML/docs/ Reference/ebay/ CompleteSale.html

Xml calls:

Call Name: UploadSiteHostedPictures
Brief description: This call is used to upload item images to EBay. The image data is sent as a mime attachment with this request.
SOAP Header Parameters: X-EBAY-API-COMPATIBILITY-LEVEL, X-EBAY-API-SITEID, X-EBAY-API-CALL-NAME
SOAP Body Parameters: RequesterCredentials (eBayAuthToken), Version
References: http: //developer.ebay.com /Devzone/XML/docs/ Reference/eBay/ GetSessionID.html