Sample code for 30+ languages & platforms
AutoIt Requires Chilkat v11.0.0+

eBay -- Download Data using FileTransferService

See more eBay Examples

Demonstrates how to download a data file using the eBay File Transfer API.

Chilkat AutoIt Downloads

AutoIt
Local $bSuccess = False

;  This example assumes the Chilkat API to have been previously unlocked.
;  See Global Unlock Sample for sample code.

;  Use a previously obtained access token.  The token should look something like this:
;  "AgAAAA**AQA ..."
Local $sAccessToken = "EBAY_ACCESS_TOKEN"

$oHttp = ObjCreate("Chilkat.Http")

$oReq = ObjCreate("Chilkat.HttpRequest")

$oReq.HttpVerb = "POST"
$oReq.Path = "/FileTransferService"
$oReq.ContentType = "application/xml"

;  Build the XML body for the request.
$oXml = ObjCreate("Chilkat.Xml")
$oXml.Tag = "downloadFileRequest"
$oXml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
$oXml.UpdateChildContent "taskReferenceId","50013004806"
$oXml.UpdateChildContent "fileReferenceId","50015579016"

$oReq.LoadBodyFromString($oXml.GetXml(),"utf-8")

;  The XML body looks like this:

;  	<?xml version="1.0" encoding="UTF-8"?>
;  	<downloadFileRequest xmlns="http://www.ebay.com/marketplace/services">
;  	<taskReferenceId>50013004806</taskReferenceId>
;  	<fileReferenceId>50015579016</fileReferenceId>
;  	</downloadFileRequest>

$oReq.AddHeader "X-EBAY-SOA-OPERATION-NAME","downloadFile"
$oReq.AddHeader "X-EBAY-SOA-SECURITY-TOKEN",$sAccessToken

$oResp = ObjCreate("Chilkat.HttpResponse")
$bSuccess = $oHttp.HttpSReq("storage.sandbox.ebay.com",443,True,$oReq,$oResp)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

Local $iStatusCode = $oResp.StatusCode
ConsoleWrite("Response status code = " & $iStatusCode & @CRLF)

$oResponseBody = ObjCreate("Chilkat.BinData")
$oResp.GetBodyBd($oResponseBody)

;  We can save the response body to a file for examination if we get an unanticipated response.  
;  (It's binary, so it won't open well in a text editor.)
$oResponseBody.WriteFile("qa_output/response.mime")

If ($iStatusCode <> 200) Then
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

;  The response body looks like this:

;  	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
;  	Content-Type: application/xop+xml; charset=utf-8; type="text/xml"
;  	Content-Transfer-Encoding: binary
;  	Content-ID: <0.urn:uuid:2B668636C1E17A4D4114925305818684242>
;  
;  	<?xml version='1.0' encoding='UTF-8'?>
;  	<downloadFileResponse xmlns="http://www.ebay.com/marketplace/services">
;  	<ack>Success</ack>
;  	<version>1.1.0</version>
;  	<timestamp>2017-04-18T15:49:41.868Z</timestamp>
;  	<fileAttachment>
;  	    <Size>587</Size>
;  	    <Data>
;                  <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:urn:uuid:A37C3C73E994C267F11492530585522"/>
;  	    </Data>
;  	</fileAttachment>
;  	</downloadFileResponse>
;  	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
;  	Content-Type: application/zip
;  	Content-Transfer-Encoding: binary
;  	Content-ID: <urn:uuid:A37C3C73E994C267F11492530585522>
;  
;  	<the binary bytes of the zip start here...>
;  

;  Load the binary response into a MIME object.
$oMime = ObjCreate("Chilkat.Mime")
$bSuccess = $oMime.LoadMimeBd($oResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oMime.LastErrorText & @CRLF)
    Exit
EndIf

;  Make sure we have 2 sub-parts.  The 1st sub-part is the XML response, the 2nd sub-part
;  is the zip containing the data.

;  Note: The 2nd sub-part can be a "zip" or "gzip".  These are two different file formats.
;  A zip is indicated with a Content-Type header equal to "application/zip",
;  whereas a gzip is indicated with a Content-Type header equal to "application/x-gzip"
If ($oMime.NumParts <> 2) Then
    ConsoleWrite("Expected the MIME to have 2 parts." & @CRLF)
    ConsoleWrite("NumParts = " & $oMime.NumParts & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

;  Get the XML from the 1st MIME sub-part.

$oPart0 = ObjCreate("Chilkat.Mime")
$bSuccess = $oMime.PartAt(0,$oPart0)
If ($bSuccess = False) Then
    ConsoleWrite($oMime.LastErrorText & @CRLF)
    Exit
EndIf

Local $sDownloadResponseXml = $oPart0.GetBodyDecoded()
$oXmlResp = ObjCreate("Chilkat.Xml")
$oXmlResp.LoadXml($sDownloadResponseXml)
ConsoleWrite("Download Response XML:" & @CRLF)
ConsoleWrite($oXmlResp.GetXml() & @CRLF)

ConsoleWrite("----" & @CRLF)

;  Now get the zip from the second part (index=1), unzip, and examine..

$oPart1 = ObjCreate("Chilkat.Mime")
$bSuccess = $oMime.PartAt(1,$oPart1)
If ($bSuccess = False) Then
    ConsoleWrite($oMime.LastErrorText & @CRLF)
    Exit
EndIf

$oZipData = ObjCreate("Chilkat.BinData")
$oPart1.GetBodyBd($oZipData)

;  Check to see if we have a zip or gzip.
$oSbContentType = ObjCreate("Chilkat.StringBuilder")
$oSbContentType.Append($oPart1.ContentType)

$oXmlFromZip = ObjCreate("Chilkat.Xml")

If ($oSbContentType.Contains("gzip",False) = True) Then
    ;  This is a gzip compressed file.
    $oGzip = ObjCreate("Chilkat.Gzip")

    ;  in-place uncompress the data.
    ;  Note: The UncompressBd method was added in Chilkat v9.5.0.67
    $bSuccess = $oGzip.UncompressBd($oZipData)
    If ($bSuccess = False) Then
        ConsoleWrite($oGzip.LastErrorText & @CRLF)
        Exit
    EndIf

    $oXmlFromZip.LoadXml($oZipData.GetString("utf-8"))

Else
    ;  This is a zip archive.

    ;  Load the body into a Zip object.
    $oZip = ObjCreate("Chilkat.Zip")
    $bSuccess = $oZip.OpenBd($oZipData)
    If ($bSuccess = False) Then
        ConsoleWrite($oZip.LastErrorText & @CRLF)
        Exit
    EndIf

    ;  Save the .zip to a file (so we can examine it for debugging if something is not as expected)
    $oZipData.WriteFile("qa_output/ebay_data.zip")

    ;  The zip should contain a single XML file.
    If ($oZip.NumEntries <> 1) Then
        ConsoleWrite("Expected the .zip to have 1 entry." & @CRLF)
        ConsoleWrite("NumEntries = " & $oZip.NumEntries & @CRLF)
        ConsoleWrite("Failed." & @CRLF)
        Exit
    EndIf

    $oEntry = ObjCreate("Chilkat.ZipEntry")
    $bSuccess = $oZip.EntryAt(0,$oEntry)
    If ($bSuccess = False) Then
        ConsoleWrite($oZip.LastErrorText & @CRLF)
        Exit
    EndIf

    $oXmlFromZip.LoadXml($oEntry.UnzipToString(0,"utf-8"))
EndIf

ConsoleWrite("XML contained in the zip:" & @CRLF)
ConsoleWrite($oXmlFromZip.GetXml() & @CRLF)
ConsoleWrite("----" & @CRLF)

ConsoleWrite("Success." & @CRLF)