Upload Orders
Overview
Orders can be used to valid and prefill information on appointments or check ins made on Conduit.
Full and partial uploads
Full upload (default)
For each facility in the file, the orders in the file replace all of the facility's existing orders.
- Orders in the upload are added or updated
- Orders for that facility not in the upload are removed and can no longer be matched
- Appointments that are already booked keep their order details
- Facilities not in the upload keep their orders
Partial upload
Orders in the upload are added or updated, and orders not in the upload are kept. Partial uploads are set up per organization; contact [email protected] to discuss.
Notes
- Conduit checks every row before saving anything. If any row is invalid, the whole file is rejected with a
400. - A
202response means the orders have been saved. - See the Orders, Loads & Shipments guide for how orders are matched and used.
Fields
Send a CSV containing the Orders for a Facility. The CSV must contain a header with the required columms from the table below and optionally including any non-required fields.
| Field | Description | Required |
|---|---|---|
| Reference ID | Primary value of an order that uniquely identifies it. Typically the primary value used to schedule/check-in | Yes |
| External Reference ID | If a primary ID exists from an external system that is a unique ID, map it to this field | No |
| Facility ID | The Conduit UUID of the facility that the order belongs to | Yes |
| Direction | "Inbound" or "Outbound" | No |
| Load Type | The type of order | No |
| Earliest Scheduled Start Time | ISO 8601 timestamp of the pick up, delivery, or ready by date for the order. Include a UTC offset; without one, US Pacific time is used. Conduit doesn't offer appointment times before this time. | No |
| Item IDs | The contents of the order | No |
| Shipper Receiver | Shipper or receiver of the order depending on if the appointment is outbound or inbound | No |
| Carrier | The carrier for the order | No |
| Carrier SCAC | The carrier's SCAC code | No |
| Carrier Emails | The emails associated with the carrier | No |
| Customer | The customer of the order (commonly used by 3PLs) | No |
| Notes | Relevant notes for the order that you want to show in Conduit | No |
Examples
In addition to these standard fields, you may also add custom reference ID types (such as Transport Ref ID) based on your Conduit configuration. Contact Conduit for the specific custom reference id key if you would like to send additional reference types.
See Create Order for REST equivalent for a single order.
Body
Responses
- 202
- 400
Bad Request
curl https://api.getconduit.ai/conduit.v1.upload_facility_orders \
--request POST \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--form 'file='
