UKMailWebServiceAPI-DevelopersGuidev120

UKMailWebServiceAPI-DevelopersGuideIntegrateWithUKMailThroughWebServicesUKMailWebServiceAPI-DevelopersGuide___________________________________________________________________________________________________________________________________________________________________UKMailWebServiceAPI-DevelopersGuidev1.20Page2of75Version:1.20Date:24/11/2014UNRESTRICTEDTableofContentsTableofContents.........................................................................................................2Introduction................................................................................................................3UKMailWebAPIProcessOverviewforCreatingaDomesticConsignment...........................4StepsToObtainaTestUsername&PasswordToStartDevelopment..................................5SecurityModel.............................................................................................................6BookingADriverToCollectParcelsForDespatch...........................................................11DespatchingDomesticConsignments............................................................................13DespatchingInternationalConsignments.......................................................................17DespatchingPacketsConsignments..............................................................................21CollectParcelsAndReturnThemToAccountAddress.....................................................24CollectParcelsAndTakeThemToAnAdhocAddress......................................................27CancellingADomesticOrInternationalConsignment......................................................31CancellingAReturnToSenderOrSendToThirdParty.......................................................33TrackingAPI–ConsignmentStatus..............................................................................35ReferenceData–RetrievingUKMailPostcodeTable.......................................................52ReferenceData–RetrievingUKMailCountryTable........................................................56AppendixA–ConsignmentStatusCodesAndDescriptions..............................................58AppendixB–DeliveryTypeCodesAndDescriptions.......................................................59AppendixC–IrishCounties........................................................................................61AppendixD–USStates..............................................................................................62AppendixE–AccountStatus.......................................................................................64AppendixF–CurrencyCodes......................................................................................65AppendixG-UKMailDeliveryChoicesServiceCodes.....................................................73UKMailWebServiceAPI-DevelopersGuide___________________________________________________________________________________________________________________________________________________________________UKMailWebServiceAPI-DevelopersGuidev1.20Page3of75Version:1.20Date:24/11/2014UNRESTRICTEDIntroductionUKMailprovidesawebserviceAPIforcustomersandpartnerstointegratetheirITsystemsdirectly.ThefunctionsofferedbythewebserviceAPIinclude:Trackconsignmentstodelivery.Bookdriverstocollectparcelsandpackets.Createdomesticconsignmentsandproducelabelimages.Createinternationalconsignmentsandproducelabelimages.CreatePacketsconsignmentsandproducelabelimages.CancelconsignmentsArrangeforparcelstobereturnedtoyou.Arrangeforparcelstobecollectedandtakentoathirdpartyaddress.RetrievethelatestUKMailreferencedataincludingserviceavailabilitybypostcode.Webservicesareofferedwithtwohttpbindings:Soap1.1compliant,ifyouarenotusingMicrosoft.Net(3.5+)developmenttoolstoconsumethewebservicesthenthisistheoptiontouse.Soap1.2MicrosoftWCFwebservices.IfyouareusingMicrosoft.Net(3.5+)developmenttoolsthenthisisthebestoption.UKMailtestwithandrecommendthefreeSoapUI:1.20Date:24/11/2014UNRESTRICTEDLoginvia‘Login’APIserviceUsingtheauthenticationtokenfromthepreviousstep,Requestacollectionusingthe‘BookCollection’APIserviceUsingtheauthenticationtokenandcollectionreferencefrompreviousstepsrequesttoaddaconsignmentusingthe‘AddDomesticConsignment’APIserviceLoginAPIwillreturnanauthenticationtoken,storethistokenBookCollectionAPIwillreturnacollectionreference,storethisreference‘AddDomesticConsignment’requestreturnsalabelinbinaryPNGformatUKMailWebAPIProcessOverviewforCreatingaDomesticConsignmentBelowisacompletebasicoverviewoftheprocessforcreatingadomesticconsignmentusingtheUKmailwebservices.*Asimilarprocesscanbeusedforourinternationalconsignmentsandpacketsconsignmentsservices.UKMailWebSe