docs.vin

consumables

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

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

Identity

Nounconsumables
PillarData (facets: 4 data · 3 services · 4 commerce)
Capabilities11 — 0 live · 11 sandbox · 0 declared
EntitiesPart
Doorsaggregator.vin
SDKVin.consumables.* from apis.vin
Address/catalog/consumables#{action} — the anchor IS the wire name minus consumables.

Events

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

Discover & read

spec

consumables.spec · GET /consumables/spec · gate none · sandbox · answers ConsumablesSpec@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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 — consumables.spec
import { consumables } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await consumables.spec({"vin":"5FPYK3F79NB039267"})
GET /consumables/spec
curl 'https://apis.vin/consumables/spec?vin=5FPYK3F79NB039267'

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:09.432Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesSpec@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "spec": {
      "oilGrade": "0W-20",
      "oilCapacityTenthsQt": 48,
      "coolant": "long-life",
      "intervalMiles": 7500
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "spec": {
      "oilGrade": "0W-20",
      "oilCapacityTenthsQt": 48,
      "coolant": "long-life",
      "intervalMiles": 7500
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

availability

consumables.availability · GET /consumables/availability · gate none · sandbox · answers ConsumablesAvailability@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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 — consumables.availability
import { consumables } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await consumables.availability({"vin":"5FPYK3F79NB039267"})
GET /consumables/availability
curl 'https://apis.vin/consumables/availability?vin=5FPYK3F79NB039267'

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:09.423Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesAvailability@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shelf": {
      "standing": "on-order",
      "position": "Ordered",
      "unitCents": 2400
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shelf": {
      "standing": "on-order",
      "position": "Ordered",
      "unitCents": 2400
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

usageRead

consumables.usageRead · GET /consumables/usage-read · gate none · sandbox · answers ConsumablesUsageRead@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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 — consumables.usageRead
import { consumables } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await consumables.usageRead({"vin":"5FPYK3F79NB039267"})
GET /consumables/usage-read
curl 'https://apis.vin/consumables/usage-read?vin=5FPYK3F79NB039267'

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:09.438Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesUsageRead@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "usage": {
      "oilLifePct": 14,
      "usedPct": 86,
      "basis": "oem-interval"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "usage": {
      "oilLifePct": 14,
      "usedPct": 86,
      "basis": "oem-interval"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Quote & price

shopSupplyFee

consumables.shopSupplyFee · POST /consumables/shop-supply-fee · gate offer · sandbox · answers ConsumablesShopSupplyFee@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.shopSupplyFeeCharged@1 · Consumables.shopSupplyFeeRequested@1.

the SDK — consumables.shopSupplyFee
import { consumables } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await consumables.shopSupplyFee({"vin":"5FPYK3F79NB039267"})
POST /consumables/shop-supply-fee
curl -X POST https://apis.vin/consumables/shop-supply-fee \
  -H 'content-type: application/json' \
  -d '{"vin":"5FPYK3F79NB039267"}'

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:09.431Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesShopSupplyFee@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shopSupplyFee": {
      "feeCents": 1650,
      "basis": "labor-rate-tenth",
      "status": "billed",
      "invoiceId": "INV-fe891956"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shopSupplyFee": {
      "feeCents": 1650,
      "basis": "labor-rate-tenth",
      "status": "billed",
      "invoiceId": "INV-fe891956"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

order

consumables.order · POST /consumables/order · gate offer · sandbox · answers ConsumablesOrder@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.completed@1 · Consumables.dispatched@1 · Consumables.ordered@1 · Order.placed@1 · ServiceOrder.settled@1.

the SDK — consumables.order
import { consumables } from 'apis.vin'

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

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:09.425Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesOrder@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "order": {
      "status": "ordered",
      "amountCents": 2400,
      "position": "Ordered"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "order": {
      "status": "ordered",
      "amountCents": 2400,
      "position": "Ordered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

consumables.pay · POST /consumables/pay · gate offer · sandbox · answers ConsumablesPay@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.charged@1 · ServiceOrder.settled@1.

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

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

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:09.426Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesPay@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "payment": {
      "status": "invoiced-awaiting-settlement",
      "amountCents": 2400,
      "invoiceId": "INV-fe891956",
      "payer": {
        "name": "Ava Good",
        "castRow": "super-prime",
        "creditTier": "super-prime"
      }
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "payment": {
      "status": "invoiced-awaiting-settlement",
      "amountCents": 2400,
      "invoiceId": "INV-fe891956",
      "payer": {
        "name": "Ava Good",
        "castRow": "super-prime",
        "creditTier": "super-prime"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

bill

consumables.bill · POST /consumables/bill · gate offer · sandbox · answers ConsumablesBill@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.billRequested@1 · Consumables.billed@1.

the SDK — consumables.bill
import { consumables } from 'apis.vin'

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

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:09.424Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesBill@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "bill": {
      "status": "billed",
      "lineCents": 2400,
      "invoiceId": "INV-fe891956"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "bill": {
      "status": "billed",
      "lineCents": 2400,
      "invoiceId": "INV-fe891956"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

dispense

consumables.dispense · POST /consumables/dispense · gate offer · sandbox · answers ConsumablesDispense@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.dispenseRequested@1 · Consumables.dispensed@1.

the SDK — consumables.dispense
import { consumables } from 'apis.vin'

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

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:09.424Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesDispense@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "dispense": {
      "status": "not-yet-received",
      "position": "Ordered"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "dispense": {
      "status": "not-yet-received",
      "position": "Ordered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

replenish

consumables.replenish · POST /consumables/replenish · gate offer · sandbox · answers ConsumablesReplenish@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.replenishRequested@1 · Consumables.replenished@1.

the SDK — consumables.replenish
import { consumables } from 'apis.vin'

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

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:09.427Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesReplenish@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "replenishment": {
      "status": "inbound",
      "position": "Ordered"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "replenishment": {
      "status": "inbound",
      "position": "Ordered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

stock

consumables.stock · POST /consumables/stock · gate offer · sandbox · answers ConsumablesStock@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.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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.

EmitsConsumables.stockRequested@1 · Consumables.stocked@1.

the SDK — consumables.stock
import { consumables } from 'apis.vin'

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

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:09.432Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesStock@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shelfStock": {
      "onHandUnits": 0,
      "standing": "on-order",
      "position": "Ordered"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "shelfStock": {
      "onHandUnits": 0,
      "standing": "on-order",
      "position": "Ordered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

usage

consumables.usage · GET /consumables/usage · gate none · sandbox · answers ConsumablesUsage@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5FPYK3F79NB039267 (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 — consumables.usage
import { consumables } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await consumables.usage({"vin":"5FPYK3F79NB039267"})
GET /consumables/usage
curl 'https://apis.vin/consumables/usage?vin=5FPYK3F79NB039267'

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:09.434Z · HTTP 200
{
  "type": "OK",
  "answers": "ConsumablesUsage@1",
  "value": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "usage": {
      "oilLifePct": 14,
      "usedPct": 86,
      "basis": "oem-interval"
    }
  },
  "evidence": {
    "vin": "5FPYK3F79NB039267",
    "noun": "consumables",
    "asOf": "2026-08-10",
    "id": "PRT-fc5bcc8d",
    "partNumber": "P-7cf3befc",
    "repairOrderId": "RO-38a2910a",
    "price": 24000,
    "status": "Ordered",
    "usage": {
      "oilLifePct": 14,
      "usedPct": 86,
      "basis": "oem-interval"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "parts-shelf-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.

Part


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