Click or drag to resize

Sample Code

[This is preliminary documentation and is subject to change.]

Sample Code

Click on the links below to download sample applications that implement the Purolator International web services.

C# .NET solution.

VB .NET solution.

The exact process for creating an application to interact with the web service will differ significantly between programming languages, but the process for some languages can be summarized by:

  1. Use a tool to generate a proxy/wrapper/client class from the WSDL file. This class will typically have a set of objects representing web service methods, the associated Request and Response objects, and data objects used to create Requests and Responses.

    The Purolator International Web Service WSDL can be found at http://sandbox.purolatorshipping.com/WebServices/ShippingServicesV3.asmx?WSDL .

    Typically, this will need to be completed once and only updated if our web service changes, but for some languages/frameworks this may need to be completed once each time the application starts.

  2. Determine which web service method needs to be executed.

  3. Use the proxy class to create the Request object.

  4. Populate the Request object with the relevant data.

  5. Pass the Request object to the proxy class to execute the web service method.

  6. Handle the Response returned from calling the proxy class as appropriate. For example:

    • If Response.Status is 2 (Error) then fix the problems in the request and resubmit.

      See Return Codes for information about each error message.

    • If Response.Status is 0 (Success) and the request LabelType specified was ZPL or ZPLIMAGES, then send the ZPL code to the Zebra printer.

  7. Closeout any outstanding orders which are being shipped. This typically occurs at the end of a day, but multiple closeouts can occur within one day and a closeout may cover multiple days.

    Closing out a collection of orders:

    • Finalizes them in the OLS database and prevents future modification.

    • Consolidates rates for all orders with the same order information (including the exact destination address, ship method, and other shipping options).

    • May create required documentation for customs.

Since sample (working) source code is often the most helpful way to demonstrate using an API (at least to a programmer) we have created a few sample applications: .NET (C#, VB.NET) / Java (TBD)