ShippingServicesV3 Web Service

ShippingServicesV3

Click here for a complete list of operations.

AddOrGetOrder

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/ShippingServicesV3.asmx HTTP/1.1
Host: sandbox.purolatorshipping.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://PurolatorServices.com/AddOrGetOrder"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddOrGetOrder xmlns="http://PurolatorServices.com/">
      <request>
        <Credentials>
          <UserName>string</UserName>
          <Password>string</Password>
          <ClientID>string</ClientID>
        </Credentials>
        <OrderNumber>string</OrderNumber>
        <ShipDate>dateTime</ShipDate>
        <ShipMethod>string</ShipMethod>
        <SpecialServices>
          <string>string</string>
          <string>string</string>
        </SpecialServices>
        <BillingOption>string</BillingOption>
        <BillingAccount>string</BillingAccount>
        <LabelType>string</LabelType>
        <ShipFromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </ShipFromAddress>
        <ShipToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </ShipToAddress>
        <BillingAccountAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </BillingAccountAddress>
        <DeclaredValue>decimal</DeclaredValue>
        <Currency>string</Currency>
        <PartnerID>string</PartnerID>
        <Note>string</Note>
        <PONumber>string</PONumber>
        <Ref1>string</Ref1>
        <Ref2>string</Ref2>
        <Ref3>string</Ref3>
        <Ref4>string</Ref4>
        <Ref5>string</Ref5>
        <AdditionalOptions>
          <KeyValueStrings>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueStrings>
          <KeyValueStrings>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueStrings>
        </AdditionalOptions>
        <Packages>
          <RequestPackageV3>
            <PackageNumber>string</PackageNumber>
            <PackageID>string</PackageID>
            <Pin>string</Pin>
            <WeightUOM>string</WeightUOM>
            <Weight>decimal</Weight>
            <DimensionUOM>string</DimensionUOM>
            <DimL>decimal</DimL>
            <DimW>decimal</DimW>
            <DimH>decimal</DimH>
            <LabelPrinted>boolean</LabelPrinted>
            <SpecialHandlingType>string</SpecialHandlingType>
            <AdditionalOptions xsi:nil="true" />
          </RequestPackageV3>
          <RequestPackageV3>
            <PackageNumber>string</PackageNumber>
            <PackageID>string</PackageID>
            <Pin>string</Pin>
            <WeightUOM>string</WeightUOM>
            <Weight>decimal</Weight>
            <DimensionUOM>string</DimensionUOM>
            <DimL>decimal</DimL>
            <DimW>decimal</DimW>
            <DimH>decimal</DimH>
            <LabelPrinted>boolean</LabelPrinted>
            <SpecialHandlingType>string</SpecialHandlingType>
            <AdditionalOptions xsi:nil="true" />
          </RequestPackageV3>
        </Packages>
        <Items>
          <RequestItemV3>
            <SKU>string</SKU>
            <CustomsDesc>string</CustomsDesc>
            <ExtendedDesc>string</ExtendedDesc>
            <Quantity>int</Quantity>
            <TotalValue>decimal</TotalValue>
            <Currency>string</Currency>
            <CountryOfOrigin>string</CountryOfOrigin>
            <HSCode>string</HSCode>
            <NAFTAEligible>boolean</NAFTAEligible>
            <FDAFood>boolean</FDAFood>
            <Textile>boolean</Textile>
            <PSTExempt>boolean</PSTExempt>
            <AdditionalOptions xsi:nil="true" />
          </RequestItemV3>
          <RequestItemV3>
            <SKU>string</SKU>
            <CustomsDesc>string</CustomsDesc>
            <ExtendedDesc>string</ExtendedDesc>
            <Quantity>int</Quantity>
            <TotalValue>decimal</TotalValue>
            <Currency>string</Currency>
            <CountryOfOrigin>string</CountryOfOrigin>
            <HSCode>string</HSCode>
            <NAFTAEligible>boolean</NAFTAEligible>
            <FDAFood>boolean</FDAFood>
            <Textile>boolean</Textile>
            <PSTExempt>boolean</PSTExempt>
            <AdditionalOptions xsi:nil="true" />
          </RequestItemV3>
        </Items>
      </request>
    </AddOrGetOrder>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddOrGetOrderResponse xmlns="http://PurolatorServices.com/">
      <AddOrGetOrderResult>
        <Packages>
          <ResponsePackage>
            <PackageID>string</PackageID>
            <TrackingNumber>string</TrackingNumber>
            <ShippingCharge>decimal</ShippingCharge>
            <Unicode>string</Unicode>
            <AirportCode>string</AirportCode>
            <BarCode>string</BarCode>
            <ZPLCode>string</ZPLCode>
            <LabelImage>string</LabelImage>
          </ResponsePackage>
          <ResponsePackage>
            <PackageID>string</PackageID>
            <TrackingNumber>string</TrackingNumber>
            <ShippingCharge>decimal</ShippingCharge>
            <Unicode>string</Unicode>
            <AirportCode>string</AirportCode>
            <BarCode>string</BarCode>
            <ZPLCode>string</ZPLCode>
            <LabelImage>string</LabelImage>
          </ResponsePackage>
        </Packages>
        <TotalShipping>decimal</TotalShipping>
        <Rates>
          <RateV3>
            <ShipMethod>string</ShipMethod>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <EstimatedRate>decimal</EstimatedRate>
            <IsAvailable>boolean</IsAvailable>
            <RateDetails xsi:nil="true" />
          </RateV3>
          <RateV3>
            <ShipMethod>string</ShipMethod>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <EstimatedRate>decimal</EstimatedRate>
            <IsAvailable>boolean</IsAvailable>
            <RateDetails xsi:nil="true" />
          </RateV3>
        </Rates>
      </AddOrGetOrderResult>
    </AddOrGetOrderResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/ShippingServicesV3.asmx HTTP/1.1
Host: sandbox.purolatorshipping.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddOrGetOrder xmlns="http://PurolatorServices.com/">
      <request>
        <Credentials>
          <UserName>string</UserName>
          <Password>string</Password>
          <ClientID>string</ClientID>
        </Credentials>
        <OrderNumber>string</OrderNumber>
        <ShipDate>dateTime</ShipDate>
        <ShipMethod>string</ShipMethod>
        <SpecialServices>
          <string>string</string>
          <string>string</string>
        </SpecialServices>
        <BillingOption>string</BillingOption>
        <BillingAccount>string</BillingAccount>
        <LabelType>string</LabelType>
        <ShipFromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </ShipFromAddress>
        <ShipToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </ShipToAddress>
        <BillingAccountAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Add1>string</Add1>
          <Add2>string</Add2>
          <City>string</City>
          <StateProv>string</StateProv>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Phone>string</Phone>
          <Email>string</Email>
        </BillingAccountAddress>
        <DeclaredValue>decimal</DeclaredValue>
        <Currency>string</Currency>
        <PartnerID>string</PartnerID>
        <Note>string</Note>
        <PONumber>string</PONumber>
        <Ref1>string</Ref1>
        <Ref2>string</Ref2>
        <Ref3>string</Ref3>
        <Ref4>string</Ref4>
        <Ref5>string</Ref5>
        <AdditionalOptions>
          <KeyValueStrings>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueStrings>
          <KeyValueStrings>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueStrings>
        </AdditionalOptions>
        <Packages>
          <RequestPackageV3>
            <PackageNumber>string</PackageNumber>
            <PackageID>string</PackageID>
            <Pin>string</Pin>
            <WeightUOM>string</WeightUOM>
            <Weight>decimal</Weight>
            <DimensionUOM>string</DimensionUOM>
            <DimL>decimal</DimL>
            <DimW>decimal</DimW>
            <DimH>decimal</DimH>
            <LabelPrinted>boolean</LabelPrinted>
            <SpecialHandlingType>string</SpecialHandlingType>
            <AdditionalOptions xsi:nil="true" />
          </RequestPackageV3>
          <RequestPackageV3>
            <PackageNumber>string</PackageNumber>
            <PackageID>string</PackageID>
            <Pin>string</Pin>
            <WeightUOM>string</WeightUOM>
            <Weight>decimal</Weight>
            <DimensionUOM>string</DimensionUOM>
            <DimL>decimal</DimL>
            <DimW>decimal</DimW>
            <DimH>decimal</DimH>
            <LabelPrinted>boolean</LabelPrinted>
            <SpecialHandlingType>string</SpecialHandlingType>
            <AdditionalOptions xsi:nil="true" />
          </RequestPackageV3>
        </Packages>
        <Items>
          <RequestItemV3>
            <SKU>string</SKU>
            <CustomsDesc>string</CustomsDesc>
            <ExtendedDesc>string</ExtendedDesc>
            <Quantity>int</Quantity>
            <TotalValue>decimal</TotalValue>
            <Currency>string</Currency>
            <CountryOfOrigin>string</CountryOfOrigin>
            <HSCode>string</HSCode>
            <NAFTAEligible>boolean</NAFTAEligible>
            <FDAFood>boolean</FDAFood>
            <Textile>boolean</Textile>
            <PSTExempt>boolean</PSTExempt>
            <AdditionalOptions xsi:nil="true" />
          </RequestItemV3>
          <RequestItemV3>
            <SKU>string</SKU>
            <CustomsDesc>string</CustomsDesc>
            <ExtendedDesc>string</ExtendedDesc>
            <Quantity>int</Quantity>
            <TotalValue>decimal</TotalValue>
            <Currency>string</Currency>
            <CountryOfOrigin>string</CountryOfOrigin>
            <HSCode>string</HSCode>
            <NAFTAEligible>boolean</NAFTAEligible>
            <FDAFood>boolean</FDAFood>
            <Textile>boolean</Textile>
            <PSTExempt>boolean</PSTExempt>
            <AdditionalOptions xsi:nil="true" />
          </RequestItemV3>
        </Items>
      </request>
    </AddOrGetOrder>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddOrGetOrderResponse xmlns="http://PurolatorServices.com/">
      <AddOrGetOrderResult>
        <Packages>
          <ResponsePackage>
            <PackageID>string</PackageID>
            <TrackingNumber>string</TrackingNumber>
            <ShippingCharge>decimal</ShippingCharge>
            <Unicode>string</Unicode>
            <AirportCode>string</AirportCode>
            <BarCode>string</BarCode>
            <ZPLCode>string</ZPLCode>
            <LabelImage>string</LabelImage>
          </ResponsePackage>
          <ResponsePackage>
            <PackageID>string</PackageID>
            <TrackingNumber>string</TrackingNumber>
            <ShippingCharge>decimal</ShippingCharge>
            <Unicode>string</Unicode>
            <AirportCode>string</AirportCode>
            <BarCode>string</BarCode>
            <ZPLCode>string</ZPLCode>
            <LabelImage>string</LabelImage>
          </ResponsePackage>
        </Packages>
        <TotalShipping>decimal</TotalShipping>
        <Rates>
          <RateV3>
            <ShipMethod>string</ShipMethod>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <EstimatedRate>decimal</EstimatedRate>
            <IsAvailable>boolean</IsAvailable>
            <RateDetails xsi:nil="true" />
          </RateV3>
          <RateV3>
            <ShipMethod>string</ShipMethod>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <EstimatedRate>decimal</EstimatedRate>
            <IsAvailable>boolean</IsAvailable>
            <RateDetails xsi:nil="true" />
          </RateV3>
        </Rates>
      </AddOrGetOrderResult>
    </AddOrGetOrderResponse>
  </soap12:Body>
</soap12:Envelope>