How to Execute Outbound SOAP Function by Name in Qntrl | Web Services Online Help | Qntrl Online Help

Business Case: Integrating Order Shipment Tracking with an External Carrier API

Scenario

A logistics company, QuickShip, provides real-time shipment tracking services. An ecommerce platform, Cell Retail, integrates with QuickShip’s SOAP-based tracking API using Qntrl’s Outbound SOAP Web Services.

How it Works

Whenever an order is shipped, Qntrl sends a SOAP request to QuickShip’s API to retrieve the latest shipment status. The response is processed in Qntrl, and the order status is updated in Cell Retail’s system.
 

Business Impact   

      ✅ Real-time shipment tracking for customers.
      ✅ Automated order status updates based on tracking data.
      ✅ Secure and structured communication with external APIs.

 

Step-by-Step Process to Create an Outbound SOAP Web Service   

Configuring the WSDL Contract   

  1. Navigate to(settings) >> Webservices >> Outbound >> Select SOAP.
  2. Click New SOAP and enter the details:
    • Name: QuickShipTrackingService
    • Select Download WSDL to retrieve the contract.
    • If required, enter the authentication credentials (API key, Basic Auth, OAuth).
    • Execute in Bridge: Choose this if execution via a bridge is needed.
  1. Click Save to complete the setup.
Notes

If modifications to the WSDL are needed, uncheck Download WSDL and manually edit the XML.

 


Generating SOAP Functions   

  1. Go to the SOAP Functions section.
  2. Click Generate SOAP Functions to parse the WSDL and list available APIs.
  3. If needed, create a new SOAP function manually:
    • Click SOAP Function (top-right corner).
    • Configure the SOAP request fields manually.
  1. Select the TrackShipment API function from the list.
  2. The following fields are auto-populated:
    1. Name: TrackShipment
    2. Binding: QuickShipBinding
    4. Operation: TrackShipment
  1. Fill in additional details:
    • Credential: Select the authentication method.
    • Connection Timeout: Define the timeout in milliseconds.
  1. Click Send to execute the request and receive an XML response.
  2. Use local variables or config store values in the request message.
  3. Click the Refresh icon to populate available variables.
  4. Assign values dynamically based on request execution.

NotesIf the WSDL is updated, click Regenerate Sample SOAP Messages to refresh the function definitions.

 


Sending the SOAP Request and Response 

Qntrl executes the TrackShipment function by sending a SOAP request to QuickShip’s tracking API.

Sample SOAP Request  

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
     xmlns:trk="http://api.quickship.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <trk:TrackShipment>
         <trk:TrackingNumber>123456789</trk:TrackingNumber>
         <trk:CarrierCode>QSHIP</trk:CarrierCode>
      </trk:TrackShipment>
   </soapenv:Body>
</soapenv:Envelope>

 

Sample SOAP Response  

   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <trk:TrackShipmentResponse xmlns:trk="http://api.quickship.com/">
         <trk:Status>In Transit</trk:Status>
         <trk:ExpectedDelivery>2025-04-05</trk:ExpectedDelivery>
      </trk:TrackShipmentResponse>
   </soapenv:Body>
</soapenv:Envelope>

 

Executing Outbound SOAP in Codex   

Use Codex to execute the SOAP function dynamically.

Executed by ID

outboundSOAP.execute("track_shipment_id", { "TrackingNumber": "123456789", "CarrierCode": "QSHIP" });

Executed by Name

let response = outboundSOAP.executeByName("QuickShipTrackingService", "TrackShipment", "{TrackingNumber}:123456789");
Notes

The response can be stored and used to update the shipment status in the Cell's Retail system.


    • Related Articles

    • Business Case: Automating Order Management

      Scenario Consider a retail company that uses Qntrl to manage its order fulfillment process. The company has an external e-commerce platform that receives orders from customers and needs to integrate with Qntrl to process these orders automatically. ...

    • Business Case: Automating Vendor Invoice Validation with External ERP

      Scenario A company is looking to simplify and automate its vendor invoice processing. The finance team receives invoices from various vendors daily. Each time a new invoice is submitted in Qntrl, the system needs to validate invoice must be validated ...

    • Business Case: Automate Card Creation via External CRM

      Scenario A company uses an external CRM (like Zoho CRM or Salesforce) to collect leads. Whenever a lead qualifies, the CRM needs to automatically create a task card in Qntrl's process management system to trigger internal follow-up actions. Instead ...

    • Configure Inbound REST API

      Qntrl’s Inbound REST Web Service allows you to create custom API endpoints that external users or systems can call to perform specific actions inside Qntrl. When a user triggers the API, Qntrl receives the request and processes it based on the ...

    • Create and configure an Outbound REST API

      Outbound REST Web Services enables users to interact with external web services by sending HTTP requests to retrieve, create, update, or delete data on REST-compliant servers. This functionality is designed to integrate seamlessly with external APIs ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.