Add Order |
[This is preliminary documentation and is subject to change.]
Gets the service availability, estimated rate, pin numbers and labels for each package.
AddOrder determines if the specified service is available for the order and returns an estimated rate and a pin number and label for each package. AddOrder enters the order into the system for shipping.
Sample RequestXML
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:pur="http://PurolatorServices.com/">
<soap:Header/>
<soap:Body>
<pur:AddOrder>
<pur:request>
<pur:Credentials>
<pur:UserName>TestUser</pur:UserName>
<pur:Password>5VJrtqTa</pur:Password>
<pur:ClientID>0000000</pur:ClientID>
</pur:Credentials>
<pur:OrderNumber>Test-0001</pur:OrderNumber>
<pur:Ref1>MyRef 001</pur:Ref1>
<pur:Ref2>Note 001</pur:Ref2>
<pur:ShipDate>2012-08-09T00:00:00</pur:ShipDate>
<pur:ShipMethod>GROUND</pur:ShipMethod>
<pur:SpecialServices>
<pur:string>NOTIFYCONSIGNEE</pur:string>
<pur:string>OSNR</pur:string>
</pur:SpecialServices>
<pur:BillingOption>PREPAID</pur:BillingOption>
<pur:LabelType>NONE</pur:LabelType>
<pur:ShipFromAddress>
<pur:Name></pur:Name>
<pur:Company>Simple Earth Hops</pur:Company>
<pur:Add1>210 S Lindsey Street</pur:Add1>
<pur:Add2></pur:Add2>
<pur:City>Dodgeville</pur:City>
<pur:StateProv>WI</pur:StateProv>
<pur:PostalCode>53533</pur:PostalCode>
<pur:Country>US</pur:Country>
<pur:Phone></pur:Phone>
<pur:Email></pur:Email>
</pur:ShipFromAddress>
<pur:ShipToAddress>
<pur:Name></pur:Name>
<pur:Company>Red Duck Beer</pur:Company>
<pur:Add1>101 Sample Street</pur:Add1>
<pur:Add2>Suite 202</pur:Add2>
<pur:City>Scarborough</pur:City>
<pur:StateProv>ON</pur:StateProv>
<pur:PostalCode>M1M1M1</pur:PostalCode>
<pur:Country>CA</pur:Country>
<pur:Phone></pur:Phone>
<pur:Email>SampleAddress@Example.com</pur:Email>
</pur:ShipToAddress>
<pur:DeclaredValue>23.68</pur:DeclaredValue>
<pur:Currency>USD</pur:Currency>
<pur:Packages>
<pur:RequestPackageV3>
<pur:PackageID>Pkg-0001a</pur:PackageID>
<pur:WeightUOM>LB</pur:WeightUOM>
<pur:Weight>2.354</pur:Weight>
<pur:DimensionUOM>IN</pur:DimensionUOM>
<pur:DimL>10.1</pur:DimL>
<pur:DimW>13.2</pur:DimW>
<pur:DimH>1.3</pur:DimH>
</pur:RequestPackageV3>
<pur:RequestPackageV3>
<pur:PackageID>Pkg-0001b</pur:PackageID>
<pur:WeightUOM>LB</pur:WeightUOM>
<pur:Weight>4.25</pur:Weight>
<pur:DimensionUOM>IN</pur:DimensionUOM>
<pur:DimL>0</pur:DimL>
<pur:DimW>0</pur:DimW>
<pur:DimH>0</pur:DimH>
</pur:RequestPackageV3>
</pur:Packages>
<pur:Items>
<pur:RequestItemV3>
<pur:SKU>DOC</pur:SKU>
<pur:CustomsDesc>Documents</pur:CustomsDesc>
<pur:ExtendedDesc>Misc. Documents</pur:ExtendedDesc>
<pur:Quantity>201</pur:Quantity>
<pur:TotalValue>1.00</pur:TotalValue>
<pur:Currency>CAD</pur:Currency>
<pur:CountryOfOrigin>US</pur:CountryOfOrigin>
<pur:HSCode></pur:HSCode>
<pur:NAFTAEligible>false</pur:NAFTAEligible>
<pur:FDAFood>false</pur:FDAFood>
<pur:Textile>false</pur:Textile>
</pur:RequestItemV3>
<pur:RequestItemV3>
<pur:SKU>Caps-2161</pur:SKU>
<pur:CustomsDesc>Bottle Caps</pur:CustomsDesc>
<pur:ExtendedDesc>Stainless Steel Bottle Caps</pur:ExtendedDesc>
<pur:Quantity>3000</pur:Quantity>
<pur:TotalValue>22.68</pur:TotalValue>
<pur:Currency>USD</pur:Currency>
<pur:CountryOfOrigin>US</pur:CountryOfOrigin>
<pur:HSCode>39235010</pur:HSCode>
<pur:NAFTAEligible>false</pur:NAFTAEligible>
<pur:FDAFood>false</pur:FDAFood>
<pur:Textile>false</pur:Textile>
</pur:RequestItemV3>
</pur:Items>
</pur:request>
</pur:AddOrder>
</soap:Body>
</soap:Envelope>Sample ResponseXML
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AddOrderResponse xmlns="http://PurolatorServices.com/">
<AddOrderResult>
<Status>0</Status>
<Request>
<OrderNumber>Test-0001</OrderNumber>
<Ref1>MyRef 001</Ref1>
<Ref2>Note 001</Ref2>
<ShipDate>2012-08-09T00:00:00</ShipDate>
<ShipMethod>GROUND</ShipMethod>
<SpecialServices>
<string>NOTIFYCONSIGNEE</string>
<string>OSNR</string>
</SpecialServices>
<BillingOption>PREPAID</BillingOption>
<BillingAccount/>
<LabelType>NONE</LabelType>
<ShipFromAddress>
<Name/>
<Company>Simple Earth Hops</Company>
<Add1>210 S Lindsey Street</Add1>
<Add2/>
<City>Dodgeville</City>
<StateProv>WI</StateProv>
<PostalCode>53533</PostalCode>
<Country>US</Country>
<Phone/>
<Email/>
</ShipFromAddress>
<ShipToAddress>
<Name/>
<Company>Red Duck Beer</Company>
<Add1>101 Sample Street</Add1>
<Add2>Suite 202</Add2>
<City>Scarborough</City>
<StateProv>ON</StateProv>
<PostalCode>M1M1M1</PostalCode>
<Country>CA</Country>
<Phone/>
<Email>SampleAddress@Example.com</Email>
</ShipToAddress>
<DeclaredValue>23.68</DeclaredValue>
<Currency>USD</Currency>
<Packages>
<RequestPackageV3>
<PackageID>Pkg-0001a</PackageID>
<WeightUOM>LB</WeightUOM>
<Weight>2.354</Weight>
<DimensionUOM>IN</DimensionUOM>
<DimL>10.1</DimL>
<DimW>13.2</DimW>
<DimH>1.3</DimH>
</RequestPackageV3>
<RequestPackageV3>
<PackageID>Pkg-0001b</PackageID>
<WeightUOM>LB</WeightUOM>
<Weight>4.25</Weight>
<DimensionUOM>IN</DimensionUOM>
<DimL>0</DimL>
<DimW>0</DimW>
<DimH>0</DimH>
</RequestPackageV3>
</Packages>
<Items>
<RequestItemV3>
<SKU>DOC</SKU>
<CustomsDesc>Documents</CustomsDesc>
<ExtendedDesc>Misc. Documents</ExtendedDesc>
<Quantity>201</Quantity>
<TotalValue>1.00</TotalValue>
<Currency>CAD</Currency>
<CountryOfOrigin>US</CountryOfOrigin>
<HSCode/>
<NAFTAEligible>false</NAFTAEligible>
<FDAFood>false</FDAFood>
<Textile>false</Textile>
</RequestItemV3>
<RequestItemV3>
<SKU>Caps-2161</SKU>
<CustomsDesc>Bottle Caps</CustomsDesc>
<ExtendedDesc>Stainless Steel Bottle Caps</ExtendedDesc>
<Quantity>3000</Quantity>
<TotalValue>22.68</TotalValue>
<Currency>USD</Currency>
<CountryOfOrigin>US</CountryOfOrigin>
<HSCode>39235010</HSCode>
<NAFTAEligible>false</NAFTAEligible>
<FDAFood>false</FDAFood>
<Textile>false</Textile>
</RequestItemV3>
</Items>
</Request>
<Packages>
<ResponsePackage>
<PackageID>Pkg-0001a</PackageID>
<TrackingNumber>TST000006569</TrackingNumber>
<ShippingCharge>1.64680</ShippingCharge>
<Unicode>52</Unicode>
<AirportCode/>
</ResponsePackage>
<ResponsePackage>
<PackageID>Pkg-0001b</PackageID>
<TrackingNumber>TST000006577</TrackingNumber>
<ShippingCharge>2.97320</ShippingCharge>
<Unicode>52</Unicode>
<AirportCode/>
</ResponsePackage>
</Packages>
<TotalShipping>4.62</TotalShipping>
<Rates/>
</AddOrderResult>
</AddOrderResponse>
</soap:Body>
</soap:Envelope>