Route Stop

The route stop resource.

Base/routeStop

GET/routeStop

List route stops

Retrieve a paginated list of route stops. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/routeStop

curl --request GET \
  --url '<your-host>/routeStop?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "routePlanId": "xyz789",
    "sequence": 0,
    "createdAt": "2026-01-01T00:00:00Z",
    "customerLocationId": "xyz789",
    "tankId": "xyz789",
    "salesInvoiceLineId": "xyz789"
  }
]

GET/routeStop

Retrieve a route stop

Fetch a single route stop by filtering on `id`.

Query parameters

idstring

Match on the route stop's `id`, e.g. `eq.{id}`.

GET/routeStop

curl --request GET \
  --url '<your-host>/routeStop?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "routePlanId": "xyz789",
  "sequence": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "customerLocationId": "xyz789",
  "tankId": "xyz789",
  "salesInvoiceLineId": "xyz789"
}

POST/routeStop

Create a route stop

Create a new route stop.

Body parameters

companyIdstringrequired

References company.id

routePlanIdstringrequired

References routePlan.id

sequencenumberrequired

customerLocationIdstring

References customerLocation.id

tankIdstring

References tank.id

salesInvoiceLineIdstring

References salesInvoiceLine.id

plannedGallonsnumber

plannedArrivaltimestamp

plannedDriveSecondsnumber

deliveryFillOrderIdstring

POST/routeStop

curl --request POST \
  --url <your-host>/routeStop \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","routePlanId":"xyz789","sequence":0}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "routePlanId": "xyz789",
  "sequence": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "customerLocationId": "xyz789",
  "tankId": "xyz789",
  "salesInvoiceLineId": "xyz789"
}

PATCH/routeStop

Update a route stop

Update an existing route stop, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

routePlanIdstringrequired

References routePlan.id

sequencenumberrequired

customerLocationIdstring

References customerLocation.id

tankIdstring

References tank.id

salesInvoiceLineIdstring

References salesInvoiceLine.id

plannedGallonsnumber

plannedArrivaltimestamp

plannedDriveSecondsnumber

deliveryFillOrderIdstring

PATCH/routeStop

curl --request PATCH \
  --url '<your-host>/routeStop?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "routePlanId": "xyz789",
  "sequence": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "customerLocationId": "xyz789",
  "tankId": "xyz789",
  "salesInvoiceLineId": "xyz789"
}

DELETE/routeStop

Delete a route stop

Delete a route stop, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the route stop to delete, e.g. `eq.{id}`.

DELETE/routeStop

curl --request DELETE \
  --url '<your-host>/routeStop?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content