docs.vin

rail

The rail noun — identity, lifecycle, events, and every capability as an anchored section: 18 capabilities, 0 live, 18 sandbox, 0 declared.

rail is one of the estate's 317 automotive nouns — a job a car needs done. It carries 18 capabilities: 0 live, 18 sandbox, 0 declared · doors aggregator.vin.

Identity

Nounrail
PillarData (facets: 7 data · 6 services · 5 commerce)
Capabilities18 — 0 live · 18 sandbox · 0 declared
EntitiesTransport
Doorsaggregator.vin
SDKVin.rail.* from apis.vin
Address/catalog/rail#{action} — the anchor IS the wire name minus rail.

Events

The vocabulary this noun can append to the record — 29 past-tense, versioned event types, each linked to the capability that emits it:

Discover & read

eta

rail.eta · GET /rails/eta · gate key · sandbox · answers RailEta@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.etaUpdated@1.

the SDK — rail.eta
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.eta({"vin":"1C4AJWAG5GL156169"})
GET /rails/eta
curl 'https://apis.vin/rails/eta?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.113Z · HTTP 200
{
  "type": "OK",
  "answers": "RailEta@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "eta": {
      "status": "arrived",
      "etaDays": 0,
      "etaDate": "2026-08-10"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "eta": {
      "status": "arrived",
      "etaDays": 0,
      "etaDate": "2026-08-10"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

capacity

rail.capacity · GET /rails/capacity · gate none · sandbox · answers RailCapacity@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — rail.capacity
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.capacity({"vin":"1C4AJWAG5GL156169"})
GET /rails/capacity
curl 'https://apis.vin/rails/capacity?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.112Z · HTTP 200
{
  "type": "OK",
  "answers": "RailCapacity@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcarsPerWeek": 116,
    "available": true
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcarsPerWeek": 116,
    "available": true
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

rampLocate

rail.rampLocate · GET /rails/ramp-locate · gate key · sandbox · answers RailRampLocate@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.rampLocated@1.

the SDK — rail.rampLocate
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.rampLocate({"vin":"1C4AJWAG5GL156169"})
GET /rails/ramp-locate
curl 'https://apis.vin/rails/ramp-locate?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.148Z · HTTP 200
{
  "type": "OK",
  "answers": "RailRampLocate@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "ramp": {
      "facility": "RAMP-37",
      "distanceMiles": 100
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "ramp": {
      "facility": "RAMP-37",
      "distanceMiles": 100
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

railcarTrack

rail.railcarTrack · GET /rails/railcar-track · gate none · sandbox · answers RailRailcarTrack@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — rail.railcarTrack
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.railcarTrack({"vin":"1C4AJWAG5GL156169"})
GET /rails/railcar-track
curl 'https://apis.vin/rails/railcar-track?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.132Z · HTTP 200
{
  "type": "OK",
  "answers": "RailRailcarTrack@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcar": {
      "id": "RC-a934eb89",
      "leg": "released",
      "milesRemaining": 0
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcar": {
      "id": "RC-a934eb89",
      "leg": "released",
      "milesRemaining": 0
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Quote & price

quote

rail.quote · GET /rails/quote · gate key · sandbox · answers RailQuote@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.quoted@1.

the SDK — rail.quote
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.quote({"vin":"1C4AJWAG5GL156169"})
GET /rails/quote
curl 'https://apis.vin/rails/quote?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.117Z · HTTP 200
{
  "type": "OK",
  "answers": "RailQuote@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "quote": {
      "id": "RQ-fa49d30b",
      "rateCents": 61755,
      "currency": "USD",
      "status": "extended"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "quote": {
      "id": "RQ-fa49d30b",
      "rateCents": 61755,
      "currency": "USD",
      "status": "extended"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

rate

rail.rate · GET /rails/rate · gate key · sandbox · answers RailRate@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.rated@1.

the SDK — rail.rate
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.rate({"vin":"1C4AJWAG5GL156169"})
GET /rails/rate
curl 'https://apis.vin/rails/rate?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.160Z · HTTP 200
{
  "type": "OK",
  "answers": "RailRate@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "quote": {
      "id": "RQ-fa49d30b",
      "rateCents": 61755,
      "currency": "USD",
      "status": "tariff"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "quote": {
      "id": "RQ-fa49d30b",
      "rateCents": 61755,
      "currency": "USD",
      "status": "tariff"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

book

rail.book · POST /rails/book · gate offer · sandbox · answers RailBook@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.completed@1 · Rail.dispatched@1 · Rail.ordered@1 · ServiceOrder.settled@1.

the SDK — rail.book
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.book({"vin":"1C4AJWAG5GL156169"})
POST /rails/book
curl -X POST https://apis.vin/rails/book \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.111Z · HTTP 200
{
  "type": "OK",
  "answers": "RailBook@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "action": "book",
      "status": "booked",
      "rateCents": 61755,
      "currency": "USD"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "action": "book",
      "status": "booked",
      "rateCents": 61755,
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

schedule

rail.schedule · POST /rails/schedule · gate offer · sandbox · answers RailSchedule@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.scheduleRequested@1 · Rail.scheduled@1.

the SDK — rail.schedule
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.schedule({"vin":"1C4AJWAG5GL156169"})
POST /rails/schedule
curl -X POST https://apis.vin/rails/schedule \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.161Z · HTTP 200
{
  "type": "OK",
  "answers": "RailSchedule@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "schedule": {
      "nextDepartureDate": "2026-08-16",
      "train": "TRN-e7693e3d"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "schedule": {
      "nextDepartureDate": "2026-08-16",
      "train": "TRN-e7693e3d"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

rail.pay · POST /rails/pay · gate offer · sandbox · answers RailPay@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.paid@1 · Rail.payFailed@1 · Rail.payRequested@1.

the SDK — rail.pay
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.pay({"vin":"1C4AJWAG5GL156169"})
POST /rails/pay
curl -X POST https://apis.vin/rails/pay \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.117Z · HTTP 200
{
  "type": "OK",
  "answers": "RailPay@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "payment": {
      "id": "PAY-91b72d0d",
      "status": "settled",
      "amountCents": 61755,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "payment": {
      "id": "PAY-91b72d0d",
      "status": "settled",
      "amountCents": 61755,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

settle

rail.settle · POST /rails/settle · gate offer · sandbox · answers RailSettle@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.settleFailed@1 · Rail.settleRequested@1 · Rail.settled@1.

the SDK — rail.settle
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.settle({"vin":"1C4AJWAG5GL156169"})
POST /rails/settle
curl -X POST https://apis.vin/rails/settle \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.161Z · HTTP 200
{
  "type": "OK",
  "answers": "RailSettle@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "payment": {
      "id": "PAY-7fcfb20e",
      "status": "settled",
      "amountCents": 61755,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "payment": {
      "id": "PAY-7fcfb20e",
      "status": "settled",
      "amountCents": 61755,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

demurrageBill

rail.demurrageBill · POST /rails/demurrage-bill · gate offer · sandbox · answers RailDemurrageBill@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.demurrageBillRequested@1 · Rail.demurrageBilled@1.

the SDK — rail.demurrageBill
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.demurrageBill({"vin":"1C4AJWAG5GL156169"})
POST /rails/demurrage-bill
curl -X POST https://apis.vin/rails/demurrage-bill \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.112Z · HTTP 200
{
  "type": "OK",
  "answers": "RailDemurrageBill@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "bill": {
      "status": "no-demurrage",
      "amountCents": 0,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "bill": {
      "status": "no-demurrage",
      "amountCents": 0,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

deliver

rail.deliver · POST /rails/deliver · gate offer · sandbox · answers RailDeliver@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.deliverFailed@1 · Rail.deliverRequested@1 · Rail.delivered@1.

the SDK — rail.deliver
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.deliver({"vin":"1C4AJWAG5GL156169"})
POST /rails/deliver
curl -X POST https://apis.vin/rails/deliver \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.112Z · HTTP 200
{
  "type": "OK",
  "answers": "RailDeliver@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "status": "delivered"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "status": "delivered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

deramp

rail.deramp · POST /rails/deramp · gate offer · sandbox · answers RailDeramp@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.derampRequested@1 · Rail.deramped@1.

the SDK — rail.deramp
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.deramp({"vin":"1C4AJWAG5GL156169"})
POST /rails/deramp
curl -X POST https://apis.vin/rails/deramp \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.112Z · HTTP 200
{
  "type": "OK",
  "answers": "RailDeramp@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "deramp": {
      "status": "deramped"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "deramp": {
      "status": "deramped"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

dwell

rail.dwell · GET /rails/dwell · gate none · sandbox · answers RailDwell@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — rail.dwell
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.dwell({"vin":"1C4AJWAG5GL156169"})
GET /rails/dwell
curl 'https://apis.vin/rails/dwell?vin=1C4AJWAG5GL156169'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.112Z · HTTP 200
{
  "type": "OK",
  "answers": "RailDwell@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "dwell": {
      "days": 1,
      "freeDays": 2,
      "accruing": false
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "dwell": {
      "days": 1,
      "freeDays": 2,
      "accruing": false
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

loadRailcar

rail.loadRailcar · POST /rails/load-railcar · gate offer · sandbox · answers RailLoadRailcar@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.loadRailcarRequested@1 · Rail.railcarLoaded@1.

the SDK — rail.loadRailcar
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.loadRailcar({"vin":"1C4AJWAG5GL156169"})
POST /rails/load-railcar
curl -X POST https://apis.vin/rails/load-railcar \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.116Z · HTTP 200
{
  "type": "OK",
  "answers": "RailLoadRailcar@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcar": {
      "id": "RC-a934eb89",
      "status": "trip-complete"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "railcar": {
      "id": "RC-a934eb89",
      "status": "trip-complete"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

ramp

rail.ramp · POST /rails/ramp · gate offer · sandbox · answers RailRamp@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.rampRequested@1 · Rail.ramped@1.

the SDK — rail.ramp
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.ramp({"vin":"1C4AJWAG5GL156169"})
POST /rails/ramp
curl -X POST https://apis.vin/rails/ramp \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.148Z · HTTP 200
{
  "type": "OK",
  "answers": "RailRamp@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "ramp": {
      "status": "already-deramped"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "ramp": {
      "status": "already-deramped"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

switch

rail.switch · POST /rails/switch · gate offer · sandbox · answers RailSwitch@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.switchRequested@1 · Rail.switched@1.

the SDK — rail.switch
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.switch({"vin":"1C4AJWAG5GL156169"})
POST /rails/switch
curl -X POST https://apis.vin/rails/switch \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.161Z · HTTP 200
{
  "type": "OK",
  "answers": "RailSwitch@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "switching": {
      "id": "SW-504fafed",
      "status": "switched"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "switching": {
      "id": "SW-504fafed",
      "status": "switched"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

tender

rail.tender · POST /rails/tender · gate offer · sandbox · answers RailTender@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG5GL156169 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Rail.completed@1 · Rail.dispatched@1 · Rail.ordered@1 · ServiceOrder.settled@1.

the SDK — rail.tender
import { rail } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await rail.tender({"vin":"1C4AJWAG5GL156169"})
POST /rails/tender
curl -X POST https://apis.vin/rails/tender \
  -H 'content-type: application/json' \
  -d '{"vin":"1C4AJWAG5GL156169"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:16.161Z · HTTP 200
{
  "type": "OK",
  "answers": "RailTender@1",
  "value": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "action": "tender",
      "status": "tendered",
      "rateCents": 61755,
      "currency": "USD"
    }
  },
  "evidence": {
    "vin": "1C4AJWAG5GL156169",
    "noun": "rail",
    "asOf": "2026-08-10",
    "leg": "released",
    "move": {
      "id": "RL-2b276120",
      "action": "tender",
      "status": "tendered",
      "rateCents": 61755,
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "freight-fleet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Data model

The record shape behind this noun — one entity, each property an evidence field. See the whole estate model on the data model page.

Transport

Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.

provenance

The provenance noun — identity, lifecycle, events, and every capability as an anchored section: 7 capabilities, 1 live, 6 sandbox, 0 declared.

rebate

The rebate noun — identity, lifecycle, events, and every capability as an anchored section: 6 capabilities, 0 live, 6 sandbox, 0 declared.

On this page

Identity
Events
Discover & read
eta
capacity
rampLocate
railcarTrack
Quote & price
quote
rate
Apply & book
book
schedule
Pay & settle
pay
settle
demurrageBill
Fulfill & operate
deliver
More actions
deramp
dwell
loadRailcar
ramp
switch
tender
Data model
Transport