Introduction

Overview

The Conduit API is predominantly comprised of RPC-flavored HTTP POST methods.

Our API has human readable URLs that represent method names. They accept JSON request bodies, return JSON responses, and use standard HTTP response codes and authentication.

Concepts

Conduit, as a platform, helps warehouses coordinate pickups and deliveries. These are basic models we use to represent the entities and interactions that occur during that coordination. The concepts below are meant to be an introductory overview and are not all-encompassing.

Basic Entities

Facility

A Facility typical represents a warehouse, storefront, or other location where deliveries and/or pickups occur.

Facilities are managed by users either at the organization or facility level via the Conduit UI. Conduit's standard APIs provide read operation endpoints while any write updates are handled via the Conduit UI.

Organization

An Organization is the entity that encapsulates one more facilities.

FacilityAppointment

A FacilityAppointment represents an expected truckload at a Facility. In addition to the Facility itself, this entity often includes:

• direction (i.e. Inbound or Outbound)
• scheduled_start_time (When the truck is expected)
• order info (What is being transported)
• carrier info (Who is phsyically transporting the cargo)
• vendor info (Who is coordinating the cargo)

Order

An Order represent something that needs to be delivered and/or picked up. A FacilityAppointment can be associated to one or more orders. Multiple orders can happen in cases where a single truck contains items from different orders. An Order can also be associated with multiple FacilityAppointments in cases where an order needs to be transported across several trucks. This can happen in cases where an order is large, is not ready all at once, or is a recurring order.

Orders are represented in Conduit by a Reference Id or and Order Id.

Basic Actions

Check Availability

Conduit's core functionality is to help coordinate trucks at Facilities. Each Facility can configure their schedule to meet their operational needs including customizing when trucks can be scheduled, how far in advance an appointment must be made, and more.

In order to represent the availability of a Facility for a particular truck, we need to know when the truck is expected to arrive and whether it's for a delivery or pickup. In addition to that, we may also need to know what is being transported as that may impact the types of resources (i.e. dock doors, specialty equipment, inspection time, etc) needed at the Facility.

Book Appointment

Once availability is confirmed, an appointment can be booked with the Facility. Some Facilities require an additional approval before a FacilityAppointment is fully confirmed while others allow instant booking.

Check with your facility to see how they've configured Conduit.

Manage Appointment

FacilityAppointments can be canceled, rescheduled or updated including updating an ETA in case of late trucks. These availability and impact of these modifications are subject to the Facilities policies and how they've configured Conduit.

Check with your facility to learn more.

Check In and Check Out

Conduit tracks when a driver has checked into their FacilityAppointment and when the Facility has checked the driver out.