SmartFreight - Spojit

The SmartFreight connector lets your workflows calculate shipping rates, create and manage consignments, compare carrier costs, and track deliveries through SmartFreight’s SOAP API.

Connection setup

Get your API credentials

Contact SmartFreight support or log in to your SmartFreight account to obtain your API ID, API Password, and WSDL endpoint URL.

Add the connection in Spojit

Go to Connections in Spojit, click Add Connection, select SmartFreight, and enter:

WSDL Endpoint: Your SmartFreight SOAP endpoint (e.g., https://api-au-1.smartfreight.com/api/soap/classic?wsdl)
API ID: Your SmartFreight API identifier
API Password: Your SmartFreight API password

Tools

Rate & Delivery

calculate-rate: Calculate shipping rate for a consignment

consignment

object

required

Consignment data (connote fields) including receiver details, carrier, and freight line items.

Example request:

{
  "consignment": {
    "recname": "John Smith",
    "recaddr": {
      "add1": "123 Main Street",
      "add3": "Sydney",
      "add4": "NSW",
      "add5": "2000"
    },
    "carriername": "TNT",
    "freightlinedetails": [
      {
        "amt": 1,
        "desc": "Carton",
        "wgt": 10.5,
        "len": 40,
        "wid": 30,
        "hgt": 20
      }
    ]
  }
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "CalculateRateResult": {
      "connote": {
        "totalcost": "25.50",
        "carriername": "TNT",
        "carrierservicetype": "Road Express",
        "eta": "2",
        "freightlinedetails": {
          "amt": 1,
          "desc": "Carton",
          "wgt": 10.5,
          "cubicwgt": 4.0,
          "rateperkilo": "2.43",
          "cost": "25.50"
        }
      }
    }
  }
}

get-delivery-options: Get available delivery options

consignment

object

required

Consignment data with receiver address and freight details.

Example request:

{
  "consignment": {
    "recname": "Jane Doe",
    "recaddr": {
      "add1": "456 George Street",
      "add3": "Melbourne",
      "add4": "VIC",
      "add5": "3000"
    },
    "freightlinedetails": [
      {
        "amt": 2,
        "desc": "Parcel",
        "wgt": 5.0
      }
    ]
  }
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "GetDeliveryOptionsResult": {
      "options": {
        "option": [
          {
            "carriername": "TNT",
            "carrierservicetype": "Road Express",
            "eta": "2",
            "cost": "18.90"
          },
          {
            "carriername": "Toll",
            "carrierservicetype": "Priority",
            "eta": "1",
            "cost": "24.50"
          },
          {
            "carriername": "StarTrack",
            "carrierservicetype": "Premium",
            "eta": "1",
            "cost": "22.00"
          }
        ]
      }
    }
  }
}

cost-comparison: Compare costs across multiple carriers

consignment

object

required

Consignment data with receiver address and freight details.

Example request:

{
  "consignment": {
    "recname": "Bob Wilson",
    "recaddr": {
      "add1": "789 Queen Street",
      "add3": "Brisbane",
      "add4": "QLD",
      "add5": "4000"
    },
    "freightlinedetails": [
      {
        "amt": 1,
        "desc": "Pallet",
        "wgt": 250.0,
        "len": 120,
        "wid": 100,
        "hgt": 150
      }
    ]
  }
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "CostComparisonResult": {
      "connote": {
        "comparison": {
          "carrier": [
            {
              "carriername": "TNT",
              "carrierservicetype": "Road Express",
              "totalcost": "185.00",
              "eta": "3"
            },
            {
              "carriername": "Toll",
              "carrierservicetype": "IPEC",
              "totalcost": "195.50",
              "eta": "2"
            },
            {
              "carriername": "StarTrack",
              "carrierservicetype": "Premium",
              "totalcost": "210.00",
              "eta": "2"
            }
          ]
        }
      }
    }
  }
}

Consignment Management

import-consignment: Create a new consignment

consignment

object

required

Full consignment data including sender, receiver, carrier, and freight details.

Example request:

{
  "consignment": {
    "recname": "John Smith",
    "recaccno": "CUST001",
    "recaddr": {
      "add1": "123 Main Street",
      "add2": "Unit 4",
      "add3": "Sydney",
      "add4": "NSW",
      "add5": "2000"
    },
    "recphone": "0400000000",
    "recemail": "john@example.com",
    "carriername": "TNT",
    "carrierservicetype": "Road Express",
    "specialinstruction": "Leave at reception",
    "reference": "ORD-12345",
    "freightlinedetails": [
      {
        "amt": 2,
        "desc": "Carton",
        "wgt": 10.5,
        "len": 40,
        "wid": 30,
        "hgt": 20
      },
      {
        "amt": 1,
        "desc": "Satchel",
        "wgt": 1.2
      }
    ]
  }
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "ImportResult": {
      "connote": {
        "conid": "987654",
        "connumber": "TNT123456789",
        "carriername": "TNT",
        "carrierservicetype": "Road Express",
        "totalcost": "42.30",
        "recname": "John Smith",
        "recaddr": {
          "add1": "123 Main Street",
          "add2": "Unit 4",
          "add3": "Sydney",
          "add4": "NSW",
          "add5": "2000"
        },
        "status": "Imported",
        "freightlinedetails": [
          {
            "amt": 2,
            "desc": "Carton",
            "wgt": 10.5,
            "cost": "35.00"
          },
          {
            "amt": 1,
            "desc": "Satchel",
            "wgt": 1.2,
            "cost": "7.30"
          }
        ]
      }
    }
  }
}

find-consignment: Search for consignments

xmlfield

string

required

Consignment field name to search (e.g., recaccno, recname).

fieldvalue

string

Value to search for.

Example request:

{
  "xmlfield": "recaccno",
  "fieldvalue": "CUST001"
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "FindConResult": "987654,987655,987660"
  }
}

get-consignment: Get consignment details by ID

conid

string

required

SmartFreight consignment ID.

Example request:

{
  "conid": "987654"
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "EnquiryResult": {
      "connote": {
        "conid": "987654",
        "connumber": "TNT123456789",
        "carriername": "TNT",
        "carrierservicetype": "Road Express",
        "totalcost": "42.30",
        "status": "Dispatched",
        "recname": "John Smith",
        "recaccno": "CUST001",
        "recaddr": {
          "add1": "123 Main Street",
          "add2": "Unit 4",
          "add3": "Sydney",
          "add4": "NSW",
          "add5": "2000"
        },
        "recphone": "0400000000",
        "recemail": "john@example.com",
        "specialinstruction": "Leave at reception",
        "reference": "ORD-12345",
        "freightlinedetails": [
          {
            "amt": 2,
            "desc": "Carton",
            "wgt": 10.5,
            "len": 40,
            "wid": 30,
            "hgt": 20,
            "cost": "35.00"
          },
          {
            "amt": 1,
            "desc": "Satchel",
            "wgt": 1.2,
            "cost": "7.30"
          }
        ]
      }
    }
  }
}

delete-consignment: Delete a consignment

conid

string

required

SmartFreight consignment ID.

Example request:

{
  "conid": "987654"
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "DeleteConResult": "OK"
  }
}

Tracking

tracking-events: Get tracking events for a consignment

conid

string

required

SmartFreight consignment ID.

Example request:

{
  "conid": "987654"
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "TrackingEventsResult": {
      "events": {
        "event": [
          {
            "status": "Delivered",
            "date": "2024-03-15",
            "time": "14:32",
            "location": "Sydney",
            "description": "Signed for by J Smith"
          },
          {
            "status": "On Board for Delivery",
            "date": "2024-03-15",
            "time": "06:45",
            "location": "Sydney Depot",
            "description": "Out for delivery"
          },
          {
            "status": "In Transit",
            "date": "2024-03-14",
            "time": "18:20",
            "location": "Melbourne Hub",
            "description": "Departed facility"
          },
          {
            "status": "Picked Up",
            "date": "2024-03-13",
            "time": "15:00",
            "location": "Melbourne",
            "description": "Consignment collected"
          }
        ]
      }
    }
  }
}

Advanced

raw-soap-request: Execute an arbitrary SOAP operation

Send a raw SOAP request to any SmartFreight API operation. API credentials are injected automatically.

operation

string

required

SOAP operation name (e.g., CalculateRate, Import).

body

object

Request body parameters as key-value pairs.

Example request:

{
  "operation": "Enquiry",
  "body": {
    "conid": "987654"
  }
}

Example response (parsed from SOAP XML):

{
  "success": true,
  "data": {
    "EnquiryResult": {
      "connote": {
        "conid": "987654",
        "connumber": "TNT123456789",
        "carriername": "TNT",
        "status": "Dispatched",
        "totalcost": "42.30"
      }
    }
  }
}

​Connection setup

​Tools

​Rate & Delivery

​Consignment Management

​Tracking

​Advanced

Connection setup

Tools

Rate & Delivery

Consignment Management

Tracking

Advanced