Connect your shipper operation

Before you start

Select your shipper organization in the Company portal. The owner creates API keys and configures email connections. Owners and admins can manage loads and quotes; company funding and payment release require the signed-in owner.

• Open shipper integrations
• Organization permissions

1. Create a scoped connection

1. Open Connections and enter a meaningful connection name, such as your dispatch system.
2. Choose the scopes needed by the workflow. Load creation needs loads:write; quote review needs quotes:read; awarding needs quotes:accept. Add read scopes for the jobs, tracking or documents you need.
3. Create the key and save the one-time secret in your system’s credential store. Keep it on your server or in the automation tool’s secure connection settings.

• All API scopes and authentication

2. Post a load

Send POST /loads with the load details inside data. Include a stable Idempotency-Key header and optionally your system’s externalRef. Required load fields include itemName, loadType, readiness, pickupLocation and dropoffLocation.

Weights use kilograms and dimensions use metres. Put equipment, access instructions and collection or delivery windows in the appropriate details and site fields. AVAILABLE_FROM readiness also requires its availability date.

{
  "externalRef": "TMS-LOAD-1001",
  "data": {
    "itemName": "Pallet shipment",
    "loadType": "Pallets",
    "readiness": "READY_NOW",
    "pickupLocation": "Melbourne VIC",
    "dropoffLocation": "Sydney NSW",
    "loadWeight": 1200,
    "details": "Tail lift required; collect 09:00–12:00"
  }
}

• Load field reference
• Download load CSV template

3. Compare and award quotes

1. List the load’s quotes with GET /quotes?jobId=YOUR_JOB_ID or the Quotes page in your company portal.
2. Review the carrier, payout mode and verification status. Call GET /quotes/{quoteId}/preview to see freight, GST, platform fees and the total to fund.
3. Award the selected quote with POST /quotes/{quoteId}/accept using a stable idempotency key, or the Award quote button in your portal. If an unverified driver-pay quote needs risk acknowledgement, review and explicitly acknowledge it.

4. Fund and release company payments

The signed-in owner uses Company wallet to add company funds. After award, use Fund from company wallet on the company Jobs page. When delivery is complete, the owner confirms delivery and releases payment.

API keys can read authorized payment state, but cannot top up, fund, release, refund, withdraw or dispute company money. A funded company booking cannot be cancelled through an integration key. Existing personal wallets remain separate.

• Open shipper company wallet

5. Track delivery and documents

Read organization jobs, tracking and supported job documents through the API, or follow them on the company Jobs page. Document responses include filename, contentType and base64 PDF content. Subscribe to job and payment events to update your own system.

• Delivery and payment webhooks
• Open shipper operations