Skip to content
DevelopersGet an API key

Loads

Loads with their stops, routes, rate and invoice.

List loads

GET/v1/loads

Newest first, a page at a time. See Pagination and syncing.

curl "https://harlo-api-dev.pages.dev/v1/loads?limit=10" \
  -H "Authorization: Bearer $HARLO_API_KEY"

Filters

ParameterWhat it does
statusOnly loads in this status (draft, booked, dispatched, in_transit, delivered, cancelled).
customer_idOnly this customer's loads.

Paging, order and format

ParameterWhat it does
limitHow many to return, 1 to 100.Default: 25
cursor`next_cursor` from the previous page.
sortOrder: newest first by default.Values: -created_at, created_at, -updated_at, updated_atDefault: -created_at
updated_sinceOnly records changed at or after this ISO 8601 time.
created_sinceOnly records created at or after this ISO 8601 time.
format`csv` returns the page as a spreadsheet: nested fields become columns like `customer.name`.Values: json, csvDefault: json

Retrieve a load

GET/v1/loads/{id}

curl "https://harlo-api-dev.pages.dev/v1/loads/1d59290d-7e23-46ff-ac6a-438b17da2d07" \
  -H "Authorization: Bearer $HARLO_API_KEY"
Example response
{
  "id": "1d59290d-7e23-46ff-ac6a-438b17da2d07",
  "object": "load",
  "number": "L-00002",
  "status": "draft",
  "activation": "Activated",
  "life_cycle": "Open",
  "customer": {
    "id": "f96a1a46-3469-450a-8a70-4e16e433b248",
    "name": "Blue Lake Logistics LLC"
  },
  "customer_reference": "BLL-55102",
  "references": [
    {
      "type": "Load Number",
      "number": "BLL-55102"
    }
  ],
  "equipment": {
    "type": "Dry Van",
    "length": "53",
    "temperature": null
  },
  "mode": null,
  "service_level": null,
  "payment_terms": "Net 30",
  "stops": [
    {
      "sequence": 1,
      "type": "pickup",
      "facility": {
        "id": "7355370d-b6c5-444e-96c2-b15774dc2873",
        "number": "F-0001",
        "name": "Midwest Foods DC",
        "address": "3000 Channahon Road, Joliet, IL, USA",
        "city": "Joliet",
        "state": "IL",
        "postal_code": "60436"
      },
      "appointment": {
        "start_date": "2026-11-16",
        "start_time": "08:00",
        "end_date": "2026-11-16",
        "end_time": "10:00",
        "timezone": "America/Chicago"
      },
      "arrived_at": null,
      "departed_at": null,
      "references": [
        {
          "type": "PO Number",
          "number": "PO 44721"
        }
      ],
      "commodities": [
        {
          "description": "Packaged foods",
          "quantity": null,
          "type": null,
          "weight": "38500",
          "weight_unit": "lbs"
        }
      ]
    },
    {
      "sequence": 2,
      "type": "delivery",
      "facility": {
        "id": "ca799378-f757-4bb2-8b55-6a64a3d07ec9",
        "number": "F-0002",
        "name": "Gulf Coast Grocers",
        "address": "4200 Irving Boulevard, Dallas, TX, USA",
        "city": "Dallas",
        "state": "TX",
        "postal_code": "75247"
      },
      "appointment": {
        "start_date": "2026-11-18",
        "start_time": "07:00",
        "end_date": "2026-11-18",
        "end_time": null,
        "timezone": "America/Chicago"
      },
      "arrived_at": null,
      "departed_at": null,
      "references": [
        {
          "type": "Appointment",
          "number": "8812"
        }
      ],
      "commodities": []
    }
  ],
  "routes": [
    {
      "id": "5e3063b5-fae9-432b-b07d-1d676ca68c28",
      "number": null,
      "life_cycle": "Open",
      "dispatch_status": "Planned",
      "dispatched_at": null,
      "driver": null,
      "truck": null,
      "trailer": null
    }
  ],
  "rate": {
    "currency": "USD",
    "total": 2760,
    "lines": [
      {
        "type": "Linehaul",
        "quantity": 1,
        "unit_price": 2450,
        "amount": 2450,
        "status": "pending"
      },
      {
        "type": "Fuel Surcharge",
        "quantity": 1,
        "unit_price": 310,
        "amount": 310,
        "status": "pending"
      }
    ]
  },
  "invoice": null,
  "notes": null,
  "created_at": "2026-11-14T07:32:59.70463+00:00",
  "updated_at": "2026-11-14T07:32:59.70463+00:00"
}

The load object

FieldTypeWhat it is
ididUnique id of the load.
objectstringAlways "load".
numberstring, nullableYour load number, e.g. L-00042.
statusstringdraft, booked, dispatched, in_transit, delivered, or cancelled.
activationstring, nullableActivated, Hold, or Cancelled.
life_cyclestring, nullableWhere the freight is: Open, Assigned, Dispatched, Arrived Stop, Departed Stop, Delivered.
customerobject
idid, nullable
namestring, nullable
customer_referencestring, nullableThe customer's own load or order number.
referencesarray of objects
typestringWhat the number is, as entered, e.g. "PO Number".
numberstring
equipmentobject
typestring, nullable
lengthstring, nullable
temperaturestring, nullable
modestring, nullable
service_levelstring, nullable
payment_termsstring, nullablee.g. Net 30.
stopsarray of objects
sequenceinteger1 for the first stop.
typestringpickup or delivery.
facilityobject
idstring, nullable
numberstring, nullable
namestring, nullable
addressstring, nullable
citystring, nullable
statestring, nullable
postal_codestring, nullable
appointmentobjectScheduled window, in the stop's local time.
start_datedate, nullable
start_timestring, nullableHH:MM, local to the stop.
end_datedate, nullable
end_timestring, nullable
timezonestring, nullableIANA zone of the stop, e.g. America/Chicago.
arrived_attimestamp, nullableActual arrival (UTC).
departed_attimestamp, nullableActual departure (UTC).
referencesarray of objects
typestringWhat the number is, as entered, e.g. "PO Number".
numberstring
commoditiesarray of objects
descriptionstring, nullable
quantitystring, nullable
typestring, nullable
weightstring, nullable
weight_unitstring, nullable
routesarray of objects
ididUnique id of the route.
numberstring, nullable
life_cyclestring, nullable
dispatch_statusstring, nullable
dispatched_attimestamp, nullable
driverobject, nullable
idstring
numberstring, nullable
namestring
truckobject, nullable
idstring
unitstring, nullable
trailerobject, nullable
idstring
unitstring, nullable
rateobject
currencystring
totalnumberWhat the customer pays, all lines.
linesarray of objects
typestringe.g. Linehaul, Fuel Surcharge, Detention.
quantitynumber, nullable
unit_pricenumber, nullable
amountnumber, nullable
statusstringpending, approved, invoiced, or paid.
invoiceobject, nullableThe load's current invoice, if billed.
idid
numberstring
statusstring
notesstring, nullable
created_attimestamp, nullableWhen it was created.
updated_attimestamp, nullableWhen it last changed. Use with `updated_since` to sync.
NextInvoices