VSCM PackageHub API Reference Documentation

Transcription

1 VSCM PackageHub API Reference Documentation Document Version May 6, 2017

2 Table of Contents 1. Overview Introduction Conventions and Features Security Token Authentication Result Codes and Result Messages Supported Carriers and Services Shipment Options Schemas Login Login request Sample Definition Table Login response Sample Definition Table CreateLabel CreateLabel request Sample Definition Table CreateLabel response Sample Definition Table GetRates GetRates request Sample Definition Table GetRates response Sample Definition Table CancelLabel CancelLabel request Sample Definition Table CancelLabel response Sample Definition Table

3 6. GetSupportedCarriersForClient GetSuppotedCarriersForClient request Sample Definition Table GetSuppotedCarriersForClient response Sample Definition Table

4 1. Overview 1.1. Introduction This document describes and specifies the XML public interface for the VSCM PackageHub Api methods: - Login - Create Label - Cancel Label - Get Rates - Get Supported Carrier for a Client Conventions and Features Throughout this document, there are some conventions that are detailed in this section: Object Properties Object properties will be shown in Italic font style. Example: Security Token Classes and Objects Classes and Objects will be displayed in bold. Example: LoginRequest Definition Tables Definition tables will describe the elements found in the request and response messages. - Element Name Name of the data element within the XML document. - DataType Indicates the type or format of the data element. - Req (For Requests) Indicates if the element is mandatory (M), optional (O) or conditional (C). - Definition Description of the data element. - Valid Values Indicates the expected required values, if any. Complex Data elements (containers of other elements), will be highlighted with a light blue background. Element Name DataType Req Definition Valid Values List element type M / O / C Brief element definition Allowed values, if restrictions Complex element type M / O / C Brief element definition Allowed values, if restrictions Single element type M / O / C Brief element definition Allowed values, if restrictions 3

5 API requests and responses samples The API requests and responses will be displayed over an olive-green background: POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:example xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <Method xmlns=" <Request> </Request> </Method> </soap:body> </soap:example> 1.3. Security Token Authentication To grant access to the VSCM PackageHub API it is needed to provide a Security Token in each request. That Security Token is returned from LoginResponse after a login request is done. It will be required for each API request. <s:complextype name="loginresponse"> <s:sequence> <s:element name="user" type="tns:vscmuser" maxoccurs="1" minoccurs="0"/> <s:element name="clientname" type="s:string" maxoccurs="1" minoccurs="0"/> <s:element name="subclientname" type="s:string" maxoccurs="1" minoccurs="0"/> <s:element name="resultcode" type="s:int" maxoccurs="1" minoccurs="1"/> <s:element name="securitytoken" type="s:string" maxoccurs="1" minoccurs="0"/> <s:element name="timeinms" type="s:double" maxoccurs="1" minoccurs="1"/> <s:element name="resultpath" type="s:string" maxoccurs="1" minoccurs="0"/> </s:sequence> </s:complextype> Important: Each Security Token is valid for an hour since the last time it was used. After every request, the time is renewed. 4

6 1.4. Result Codes and Result Messages Each API Response includes a ResultCode and a ResultMessage. ResultCode is a numeric identifier which allows to easily check the success of a method or its failure reason. ResultMessage contains additional details of the issue that generated the result code. The possible ResultCodes and the general causes that throw them are listed below. Result Code Cause 0 Success 1 Warning 1000 Unexpected Exception 1001 Database Error 1002 Translator Error 2000 Carrier Custom Error 2001 Login Error 2002 Label Creation Error 2003 Label Cancel Error 2004 Get Rates Error 2005 Get Supported Carriers Error 2006 Shipping Manifest Error 2007 Address Validation Error 2008 Shipping Manifest Error 5

7 1.5. Supported Carriers and Services This is the list of supported carriers, along with their respective available services and label formats: Carrier Available Services Available Label Formats DHL FedEx USPS Purolator Express 9 Doc Express 9 Non Doc Express 12 Doc Express 12 Non Doc Express 1030 Doc Express 1030 Non Doc Express Worldwide Global Mail Ground Two Day First Class Mail Priority Mail Air Ground PDF ZPL2 PNG PNG PNG ZPL2 PNG 1.6. Shipment Options Special options available in Package Hub Api s requests. Available in method(s) Option Description Option Allowed Values CreateLabel COMMERCIAL INVOICE Generate commercial invoice in the request shipment. CreateLabel PLT Only for DHL. Create a PaperLess Trade shipment. TRUE FALSE TRUE FALSE 1.7. Schemas The schemas are available within the url: /V1/ShipApi.asmx?WSDL 6

8 2. Login POST /SignIn 2.1. Login request Sample POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <Login xmlns=" <LoginRequest> <UserName>string</UserName> <Password>string</Password> </LoginRequest> </Login> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Req Definition Valid Values LogIn tns:login M Login information element container. LoginRequest tns:loginrequest M Login Request container. UserName s:string M Valid User Name to log into API. Password s:string M Valid Password to log into API Login response Sample HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <LoginResponse xmlns=" 7

9 <LoginResult> <ResultCode>int</ResultCode> <ResultMessage>string</ResultMessage> <SecurityToken>string</SecurityToken> <TimeInMs>double</TimeInMs> </LoginResult> </LoginResponse> </soap12:body> </soap12:envelope> Definition Table Element Name Data Type Definition LoginResponse tns: LoginResponse Sign in response container. LoginResult tns:loginresponse Sign In result. ResultCode s:int Result code. ResultMessage s:string Result message. SecurityToken s:string Security token generated for future requests. TimeInMs s:double Execution time in ms. 3. CreateLabel POST /CreateLabel 3.1. CreateLabel request Sample POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <CreateLabel xmlns=" <createlabelrequest> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <Carrier>string</Carrier> <ServiceType>string</ServiceType> <OrderNumber>string</OrderNumber> <ServiceLevel>string</ServiceLevel> <PackageType>string</PackageType> <ShipToAddress> 8

10 9 <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <Address3>string</Address3> <City>string</City> <Neighborhood>string</Neighborhood> <State>string</State> <PostalCode>string</PostalCode> <Country>string</Country> <Company>string</Company> <PhoneNumber>string</PhoneNumber> < Address>string</ Address> <IsResidential>boolean</IsResidential> </ShipToAddress> <ShipFromAddress> <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <Address3>string</Address3> <City>string</City> <Neighborhood>string</Neighborhood> <State>string</State> <PostalCode>string</PostalCode> <Country>string</Country> <Company>string</Company> <PhoneNumber>string</PhoneNumber> < Address>string</ Address> <IsResidential>boolean</IsResidential> </ShipFromAddress> <ShipFromPostalCode>string</ShipFromPostalCode> <ShipDate>dateTime</ShipDate> <ShipmentOptions> <ShipmentOption> <Option>string</Option> <OptionValue>string</OptionValue> </ShipmentOption> <ShipmentOption> <Option>string</Option> <OptionValue>string</OptionValue> </ShipmentOption> </ShipmentOptions> <Packages> <Package> <PackageNumber>int</PackageNumber> <Height>decimal</Height> <Length>decimal</Length> <WeightInLbs>decimal</WeightInLbs> <Width>decimal</Width> </Package> <Package> <PackageNumber>int</PackageNumber> <Height>decimal</Height> <Length>decimal</Length> <WeightInLbs>decimal</WeightInLbs> <Width>decimal</Width> </Package> </Packages> <CustomsInfo> <ReasonForExport>string</ReasonForExport> <Comments>string</Comments> <InvoiceNumber>string</InvoiceNumber>

11 <ImporterCustomsReference>string</ImporterCustomsReference> <InsuredNumber>string</InsuredNumber> <Value>string</Value> <CurrencyCode>string</CurrencyCode> <LicenseNumber>string</LicenseNumber> <CertificateNumber>string</CertificateNumber> <CustomsItems> <PackageCustomsItem xsi:nil="true" /> <PackageCustomsItem xsi:nil="true" /> </CustomsItems> </CustomsInfo> <PreferredLabelFormat>string</PreferredLabelFormat> <SecurityToken>string</SecurityToken> <ValidateAddressFirst>boolean</ValidateAddressFirst> </createlabelrequest> </CreateLabel> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Req Definition Valid Values CreateLabel tns:createlabel M CreateLabel data element container. LabelRequest tns: createlabelrequest M Request container. ClientName s:string M Package Hub Api client name. SubClientName s:string O Package Hub Api sub client name. SecurityToken s:string M Token provided after successful log in. Carrier s:string M Carrier to request for a label. ServiceType s:string M Specific service type to request. Please, see the table in section 1.5 to see what carrier supports each service type. Unknown UPS USPS FedEx Landmark Purolator DHL Estafeta Unknown Ground FirstClassMail FirstClassMailInternational ParcelPost PriorityMail ExpressMail PriorityMailInternational ExpressMailInternational Ground MediaMail 10

12 OrderNumber s:string M Client order number. LibraryMail ReturnsService Ground RetailGround GroundHomeDelivery PurolatorAir ExpressWorldwide Express9Doc Express9NonDoc Express1030Doc Express1030NonDoc Express12Doc Express12NonDoc GlobalMailBusiness FedExGround ServiceLevel s:string M Service level. slnone slspecificdays slspecificdays slspecificcarrier slcheapest slfastest PackageType s:string M Package type of the shipment. If not specified, Package will be selected by default. Unknown Package FlatRateEnvelope LegalFlatRateEnvelope PaddedFlatRateEnvelope SmallFlatRateBox MediumFlatRateBox LargeFlatRateBox LargeFlatRateBoxAPO RegionalRateBoxA RegionalRateBoxC SoftPack Flat OversizedParcel Letter Envelope ShipFromPostalCode s:string O The postal code from which the package will be sent. ShipDate s:datetime O Date of the shipment. If not specify it will be de current date by default. PreferredLabelFormat s:string O Preferred format for the labels requested. If not specified, PNG will be selected by default. PNG PDF ZPL2 ValidateAddressFirst s:boolean O Validate address before the shipment creation. ShipmentOptions tns: ArrayOfShipmentOpt ion O Special options for the shipment. ShipmentOption tns:shipmentoption O Shipment option container. 11

13 Option s:string O OptionValue s:string O Please, see the table in section 1.6 to see what shipment options are available. ShipToAddress tns:address M Receiver address of the shipment container. Name s:string M Address name. Company s:string M Address company. Address1 s:string M Main address. Address2 s:string O Optional address. Address3 s:string O Optional address. City s:string M City. Neighborhood s:string O Neighborhood. State s:string M State. PostalCode s:string M Postal code. Country s:string M Country ISO2 Code. PhoneNumber s:string O Phone number. Address s:string O address. ShipFromAddress tns:address M Sender address of the shipment container. Name s:string M Address name. Company s:string M Address company. Address1 s:string M Main address. Address2 s:string O Optional address. Address3 s:string O Optional address. City s:string M City. Neighborhood s:string O Neighborhood. State s:string M State. PostalCode s:string M Postal code. Country s:string M Country ISO2 Code. PhoneNumber s:string O Phone number. Address s:string O address. Packages tns:arrayofpackage O Array of packages of the 12

14 shipment. Package tns:package O Package container. PackageNumber s:int M Package sort number. Height s:decimal O Height of the package. Length s:decimal O Length of the package. Width s:decimal O Width of the package. WeightInLbs s:decimal M Weight of the package. CustomInfo tns:packagecustoms Information O Customs information of the shipment container. ReasonForExport s:string O Reason for export. Comments s:string O Additional comments. InvoiceNumber s:string O Invoice number. ImporterCustoms Reference s:string O Customs reference. InsuredNumber s:string O Insured number. Value s:string O Declared value. CurrencyCode s:string O Currency code. LicenseNumber s:string O License number. CertificateNumber s:string O Certificate number CustomsItems tns:arrayofpackage CustomsItem O Customs items list. PackageCustomsItem tns:packagecustoms Item O Package Customs Item container. PackageNumber s:string O Specify which package contains the current item. ItemCode s:string O Item code. Description s:string O Description of the item. Quantity s:int O Quantity of items. UnitPrice s:decimal O Price of the item. UnitWeightInLbs s:decimal O Weight of the item. HarmonizedCode s:string O Harmonized code. OriginCountryCode s:string O Origin country ISO code. 13

15 3.2. CreateLabel response Sample HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <CreateLabelResponse xmlns=" <CreateLabelResult> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <Carrier>string</Carrier> <ServiceType>string</ServiceType> <OrderNumber>string</OrderNumber> <ShipDate>dateTime</ShipDate> <ShippingCharge>decimal</ShippingCharge> <Zone>string</Zone> <BilledWeight>decimal</BilledWeight> <TransactionNumber>string</TransactionNumber> <Packages> <ShippedPackage> <PackageNumber>int</PackageNumber> <WeightInLbs>decimal</WeightInLbs> <PackageContent>string</PackageContent> <PackageShippingLabel xsi:nil="true" /> </ShippedPackage> <ShippedPackage> <PackageNumber>int</PackageNumber> <WeightInLbs>decimal</WeightInLbs> <PackageContent>string</PackageContent> <PackageShippingLabel xsi:nil="true" /> </ShippedPackage> </Packages> <AdditionalDocuments> <AdditionalDocument> <DocumentType>string</DocumentType> <Document>string</Document> <DocumentFormat>string</DocumentFormat> </AdditionalDocument> <AdditionalDocument> <DocumentType>string</DocumentType> <Document>string</Document> <DocumentFormat>string</DocumentFormat> </AdditionalDocument> </AdditionalDocuments> <ResultCode>int</ResultCode> <ResultMessage>string</ResultMessage> <SecurityToken>string</SecurityToken> <TimeInMs>double</TimeInMs> <TrackingNumber>string</TrackingNumber> </CreateLabelResult> </CreateLabelResponse> </soap12:body> </soap12:envelope> 14

16 Definition Table Element Name DataType Definition CreateLabelResponse tns: LabelResponse CreateLabel response data element container. CreateLabelResult tns:labelresponse Response container. ClientName s:string Package Hub Api client name. SubClientName s:string Package Hub Api sub client name. Carrier s:string Carrier for shipment created. ServiceType s:string Service type used for the shipment. TrackingNumber s:string Shipment tracking number. OrderNumber s:string Order number. TransactionNumber s:string Shipment transaction number. ShipDate s:datetime Shipping date. ShippingCharge s:decimal Price. Zone s:string Zone. BilledWeight s:decimal Weight billed. ResultCode s:int Result code. ResultMessage s:string Result message. SecurityToken s:string Security token used in the request. TimeInMs s:double Method cost time in milliseconds. AdditionalDocuments tns:arrayofadditionaldocument Additional documents attached in the response. AdditionalDocument tns:additionaldocument Additional document container. DocumentType s:string Type of document attached: COMMERCIALINVOICE Document DocumentFormat s:string s:string Packages tns:arrayofshippedpackages Array of Packages. ShippedPackage tns:shippedpackage Package definition. PackageNumber s:int Sort number of the package. PackageContent s:string Content of the package if any customs items specify the current package as the container. WeightInLbs s:decimal Weight of the package in lbs. PackageShippingLabel tns:packageshippinglabel Package shipping label container. 15

17 ShipLabel s:string Label image in base64. ShipLabelFormat s:string Label image format. 4. GetRates POST /GetRates 4.1. GetRates request Sample POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetRates xmlns=" <getratesrequest> <SubClientName>string</SubClientName> <ShipToAddress> <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <Address3>string</Address3> <City>string</City> <Neighborhood>string</Neighborhood> <State>string</State> <PostalCode>string</PostalCode> <Country>string</Country> <Company>string</Company> <PhoneNumber>string</PhoneNumber> < Address>string</ Address> <IsResidential>boolean</IsResidential> </ShipToAddress> <ShipFromAddress> <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <Address3>string</Address3> <City>string</City> <Neighborhood>string</Neighborhood> <State>string</State> <PostalCode>string</PostalCode> <Country>string</Country> <Company>string</Company> <PhoneNumber>string</PhoneNumber> < Address>string</ Address> <IsResidential>boolean</IsResidential> </ShipFromAddress> <CarrierList> <string>string</string> 16

18 <string>string</string> </CarrierList> <ServiceTypeList> <string>string</string> <string>string</string> </ServiceTypeList> <WeightInLbs>decimal</WeightInLbs> <PackageType>string</PackageType> <ShipDate>dateTime</ShipDate> <DeclaredValue>decimal</DeclaredValue> <IncludeInsuranceQuote>boolean</IncludeInsuranceQuote> <IncludeFirstMileLabel>boolean</IncludeFirstMileLabel> <RateShopInCarrierList>boolean</RateShopInCarrierList> <ClientName>string</ClientName> <SecurityToken>string</SecurityToken> </getratesrequest> </GetRates> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Req Definition Valid Values GetRates tns:getrates M GetRates data element container. GetRatesRequest tns:ratesrequest M Request container. ClientName s:string M Package Hub Api client name. SubClientName s:string O Package Hub Api sub client name. CarrierList tns:arrayofstring C List of carrier to request for rates. Condition: Is mandatory to specify at least one carrier if RateShopInCarrierList parameter is false. Unknown UPS USPS FedEx Landmark Purolator DHL Estafeta NOTE: If the Client has not configured the specified carrier, it will not return rates. ServiceTypeList tns:arrayofstring O Specific service type to request. Please, see the table in section 1.5 to see what carrier supports each service type. Unknown Ground FirstClassMail FirstClassMailInternational ParcelPost PriorityMail ExpressMail PriorityMailInternational ExpressMailInternational Ground MediaMail 17

19 WeightInLbs s:decimal M Weight of the shipment. LibraryMail ReturnsService Ground RetailGround GroundHomeDelivery PurolatorAir ExpressWorldwide Express9Doc Express9NonDoc Express1030Doc Express1030NonDoc Express12Doc Express12NonDoc GlobalMailBusiness FedExGround PackageType s:string M Package type of the shipment. If not specified, Package will be selected by default. Unknown Package FlatRateEnvelope LegalFlatRateEnvelope PaddedFlatRateEnvelope SmallFlatRateBox MediumFlatRateBox LargeFlatRateBox LargeFlatRateBoxAPO RegionalRateBoxA RegionalRateBoxC SoftPack Flat OversizedParcel Letter Envelope ShipDate s:datetime O Date for the shipment. DeclaredValue s:decimal O Declared value. IncludeInsuranceQuote s:boolean O Flag to include insurance quote. IncludeFirstMileLabel s:boolean O Flag to include first mile label. RateShopInCarrierList s:boolean O Flag to look in all configured client carriers. If this flag is true, carrierlist and servicetypelist will be ignored. SecurityToken s:string M Token provided after successful log in. ShipToAddress tns:address M Receiver address of the shipment container. Name s:string M Address name. Company s:string M Address company. Address1 s:string M Main address. 18

20 Address2 s:string O Optional address. Address3 s:string O Optional address. City s:string M City. Neighborhood s:string O Neighborhood. State s:string M State. PostalCode s:string M Postal code. Country s:string M Country ISO2 Code. PhoneNumber s:string O Phone number. Address s:string O address. ShipFromAddress tns:address M Sender address of the shipment container. Name s:string M Address name. Company s:string M Address company. Address1 s:string M Main address. Address2 s:string O Optional address. City s:string M City. Neighborhood s:string O Neighborhood. State s:string M State. PostalCode s:string M Postal code. Country s:string M Country ISO2 Code. PhoneNumber s:string O Phone number. Address s:string O address GetRates response Sample HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetRatesResponse xmlns=" <GetRatesResult> 19

21 <CarrierRates> <CarrierRate> <ShipCarrier>string</ShipCarrier> <Rates xsi:nil="true" /> </CarrierRate> <CarrierRate> <ShipCarrier>string</ShipCarrier> <Rates xsi:nil="true" /> </CarrierRate> </CarrierRates> <RecommendedRate> <Carrier>string</Carrier> <Service>string</Service> <ServiceDescription>string</ServiceDescription> <Zone>string</Zone> <Price>decimal</Price> <Classification>string</Classification> <DeliveryDays>string</DeliveryDays> <ToZip>string</ToZip> <FromZip>string</FromZip> <ToCountry>string</ToCountry> <WeightLb>double</WeightLb> <WeightOz>double</WeightOz> <Length>double</Length> <Height>double</Height> <Width>double</Width> <ShipDate>dateTime</ShipDate> <InsuredValue>decimal</InsuredValue> <RegisteredValue>decimal</RegisteredValue> <CODValue>decimal</CODValue> <DeclaredValue>decimal</DeclaredValue> <RectangularShaped>boolean</RectangularShaped> <Prohibitions>string</Prohibitions> <Observations>string</Observations> <Regulations>string</Regulations> <Restrictions>string</Restrictions> <MaxDimensions>string</MaxDimensions> <DimWeighting>string</DimWeighting> <EffectiveWeightInOunces>int</EffectiveWeightInOunces> <RateCategory>int</RateCategory> <CubicPricing>boolean</CubicPricing> <PackageType>string</PackageType> <Charges> <ShipRateCharge xsi:nil="true" /> <ShipRateCharge xsi:nil="true" /> </Charges> <Options> <ShipRateOption xsi:nil="true" /> <ShipRateOption xsi:nil="true" /> </Options> <EstimatedDelivaryDate>dateTime</EstimatedDelivaryDate> <Packages> <ShippedPackage xsi:nil="true" /> <ShippedPackage xsi:nil="true" /> </Packages> </RecommendedRate> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <ResultCode>int</ResultCode> <ResultMessage>string</ResultMessage> <SecurityToken>string</SecurityToken> 20

22 <TimeInMs>double</TimeInMs> </GetRatesResult> </GetRatesResponse> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Definition GetRatesResponse tns:getratesresponse GetRates response data element container. GetRatesResult tns:ratesresponse Response container. ClientName s:string Package Hub Api client name. SubClientName s:string Package Hub Api sub client name. ResultCode s:int Result code. ResultMessage s:string Result message. SecurityToken s:string Security token used in the request. TimeInMs s:double Execution time in ms. CarrierRates tns:arrayofcarrierrates Carrier Rates. CarrierRate tns:shipcarrierrate Rates for each carrier returned. ShipCarrier s:string Carrier name. RecommendedRate tns:shiprate Recommended rate if possible. Rates tns:arrayofshiprate List of rates for a carrier. ShipRate ShipRate object container used in Rates and RecommendedRate parameters. Carrier s:string Carrier name. Service s:string Service type. ServiceDescription s:string Service description. Zone s:string Zone. Price s:decimal Price. Classification s:string Service level classification. DeliveryDays s:string Delivery days. ToZip s:string Destination zip code. FromZip s:string Origin zip code. ToCountry s:string Destination country. WeightLb s:double Weight in LB unit. WeightOz s:double Weight in Oz unit. 21

23 Length s:double Length of the shipment. Height s:double Height of the shipment. Width s:double Width of the shipment. ShipDate s:datetime Shipping date. InsuredValue s:decimal Insured value. RegisteredValue s:decimal Registered value. CODValue s:decimal Collect on delivery. DeclaredValue s:boolean Declared value. RectangularShaped s:string Rectangular shaped. Prohibitions s:string If exists, prohibitions returned. Observations s:string If exists, observations returned. Regulations s:string If exists, regulations returned. MaxDimensions s:string Max dimensions. DimWeighting s:string Weight. EffectiveWeightIn Ounces s:int Effective weight in ounces. RateCategory s:int Category of the rate. CubicPricing s:boolean Price if the rate is cubic. PackageType s:string Package type. Charges tns:arrayofshipratecharge If exists, container of extra charges. ShipRateCharge tns:shipratecharge Individual charge container. ChargeType s:shipratechargetype Charge type Price s:decimal Charge amount. Options tns:arrayofshiprateopion Options. ShipRateOption tns:shiprateoption Shipping Rate Option. OptionType tns:shipratechargetype Option type. Price s:decimal Price. 22

24 5. CancelLabel POST /CancelLabel 5.1. CancelLabel request Sample POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <CancelLabel xmlns=" <cancellabelrequest> <TrackingNumber>string</TrackingNumber> <TransactionId>string</TransactionId> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <SecurityToken>string</SecurityToken> <Carrier>string</Carrier> </cancellabelrequest> </CancelLabel> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Req Definition Valid Values CancelLabel tns:cancellabel M Request data element container. CancelLabelRequest tns: CancelLabelRequest M Request container. TrackingNumber s:string M Tracking number. TransactionId s:string O Transaction Id. ClientName s:string M Package Hub Api client name. SubClientName s:string O Package Hub Api sub client name. SecurityToken s:string M Token provided after successful log in. Carrier s:string M Carrier name. Unknown UPS 23

25 USPS FedEx Landmark Purolator DHL Estafeta 5.2. CancelLabel response Sample HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <CancelLabelResponse xmlns=" <CancelLabelResult> <TrackingNumber>string</TrackingNumber> <Status>string</Status> <Amount>decimal</Amount> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <ResultCode>int</ResultCode> <ResultMessage>string</ResultMessage> <SecurityToken>string</SecurityToken> <TimeInMs>double</TimeInMs> </CancelLabelResult> </CancelLabelResponse> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Definition CancelStampResponse tnscancelstampresponse Response data element container. CancelStampResult Tns:CancelLabelResponse Response container. TrackingNumber s:string Tracking number. Status s:string Status responded. Amount s:decimal Amount. ClientName s:string Package Hub Api client name. SubClientName s:string Package Hub Api sub client name. ResultCode s:int Result code. 24

26 ResultMessage s:string Result message. SecurityToken s:string Security token used in the request. TimeInMs s:double Execution time in ms. ResultPath s:string Result path. 6. GetSupportedCarriersForClient POST /GetSupportedCarriersForClient 6.1. GetSuppotedCarriersForClient request Sample POST /V1/ShipApi.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetSupportedCarriersForClient xmlns=" <clientsupportedcarrierrequest> <ClientName>string</ClientName> <SecurityToken>string</SecurityToken> <SubClientName>string</SubClientName> </clientsupportedcarrierrequest> </GetSupportedCarriersForClient> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Req Definition Valid Values GetSupportedCarriersForClient tns:getsupported CarriersForClient M SupportedCarriers element container. ClientSupportedCarrierRequest tns: ClientSupported CarrierRequest M Carriers Data Request. ClientName s:string M Package Hub Api client name. 25

27 SubClientName s:string O Package Hub Api sub client name. SecurityToken s:string M Token provided after successful log in. Carrier s:string O Carrier name GetSuppotedCarriersForClient response Sample HTTP/ OK HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetSupportedCarriersForClientResponse xmlns=" <GetSupportedCarriersForClientResult> <Carriers> <ClientSupportedCarrier> <CarrierName>string</CarrierName> </ClientSupportedCarrier> <ClientSupportedCarrier> <CarrierName>string</CarrierName> </ClientSupportedCarrier> </Carriers> <ClientName>string</ClientName> <SubClientName>string</SubClientName> <ResultCode>int</ResultCode> <SecurityToken>string</SecurityToken> <TimeInMs>double</TimeInMs> </GetSupportedCarriersForClientResult> </GetSupportedCarriersForClientResponse> </soap12:body> </soap12:envelope> Definition Table Element Name DataType Definition GetSupportedCarriers ForClientResponse GetSupportedCarriers ForClientResult tns: GetSupportedCarriers ForClientResponse tns: ClientSupportedCarrier Response response data element container. Response container. 26

28 ClientName s:string Package Hub Api client name. SubClientName s:string Package Hub Api sub client name. ResultCode s:int Result code. ResultMessage s:string Result message. SecurityToken s:string Security token used in the request. TimeInMs s:double Execution time in ms. Carriers tns: ArrayOfClientSupported Carrier List of supported carriers. ClientSupportedCarrier tns:clientsupportedcarrier Individual supported carrier container. CarrierName s:string Name of the carrier. 27