Introduction

Conduit helps warehouses and other facilities schedule and run their pickups and deliveries. This site explains how to connect Conduit to your own systems, such as a WMS, TMS or ERP, so appointment data flows between them without manual entry.

Questions that aren't answered here? Contact us at [email protected].

Ways to integrate

Conduit works on its own, so you only need the integrations that fit your business. Most combine a few of these:

Integration What it does Start here
Import orders, loads and shipments Send the loads you expect from your WMS, TMS or ERP. Carriers can then only book against real loads, and appointment details are filled in for them. Orders, Loads & Shipments
Receive appointment updates Get notified when appointments are booked, checked in, checked out, cancelled and more, so your systems stay in sync. Webhooks
Book and manage appointments Check availability and book, update or cancel appointments from your own portal or system. API Docs
Read appointment data Pull appointments into your systems or data warehouse. List FacilityAppointments
Single sign-on Let your team sign in to Conduit with your identity provider. SSO

If these don't cover what you need, we also build custom integrations, such as:

  • direct connections to your TMS, WMS or ERP
  • EDI
  • files delivered over SFTP or Amazon S3
  • sending events to several systems in different formats

Contact us at [email protected] to discuss. For a non-technical overview of integration options, see Integrations (WMS, TMS & ERP) in the Conduit help center.

Getting started

  1. Get an API key. Organization admins can create one in Conduit. See Authentication.
  2. Find your facility IDs. Most endpoints take a facility ID. Get them from List Facilities.
  3. Pick your integrations from the table above and follow their guides.

To try things out without affecting live data, use the UAT environment at https://api-uat.getconduit.ai. Production is https://api.getconduit.ai.

How the API works

  • Requests: every endpoint is an HTTP POST with a JSON body, and its URL names the action, such as /conduit.v1.get_facility_appointment.
  • Authentication: send your API key as a bearer token in the Authorization header.
  • Responses: JSON, with standard HTTP status codes. A 400 includes a message explaining what to fix.
  • Dates and times: ISO 8601. Appointment times are returned in the facility's time zone, for example 2025-05-11T11:00:00-07:00.

Key concepts

Organization

Your company's account in Conduit. It contains your facilities, users and API keys.

Facility

A warehouse, plant, store or other location where pickups and deliveries happen. Each facility sets its own schedule and booking rules, such as when trucks can arrive, how far in advance they must book, and whether appointments need approval. Facilities are set up and managed in Conduit, and the API can read them.

Appointment

A truck's scheduled visit to a facility, called a FacilityAppointment in the API. Each appointment is either Inbound (a delivery) or Outbound (a pickup), and includes:

  • when the truck is expected
  • what it's carrying, as one or more orders
  • the carrier and driver
  • where it is in its visit

An appointment usually moves through these statuses:

  1. Requested, if the facility approves bookings
  2. Scheduled
  3. Checked In
  4. Unloading or Loading
  5. Unloaded or Loaded
  6. Checked Out

It can also be cancelled, declined or rejected along the way. See the FacilityAppointment model in the API Docs for every status and field.

Order

An order, load or shipment you expect at a facility, identified by a reference ID such as a PO#, SO#, load number or shipment ID. An appointment can carry several orders, and a large order can be split across several appointments. Orders are optional; facilities that import them can check that carriers book against real loads. See Orders, Loads & Shipments.

Common workflows

Book an appointment

  1. Call Get Facility Availability to find open times for the facility, direction and reference IDs.
  2. Call Request FacilityAppointment with the chosen time. Depending on the facility's settings, the appointment is either Scheduled right away or Requested until the facility approves it.

Keep your system in sync

  1. Subscribe to webhooks for the events you care about.
  2. When an event arrives, fetch the appointment with Get FacilityAppointment and update your records.

Manage an appointment

Update an appointment's ETA, orders or customer, or cancel it, with the appointment endpoints in the API Docs. What can be changed, and when, depends on the facility's settings.