docs.vin

buyersGuide

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

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

Identity

NounbuyersGuide
PillarServices (facets: 5 services)
Capabilities5 — 0 live · 5 sandbox · 0 declared
EntitiesListing
Doorsaggregator.vin
SDKVin.buyersGuide.* from apis.vin
Address/catalog/buyersGuide#{action} — the anchor IS the wire name minus buyersGuide.

Events

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

Fulfill & operate

generate

buyersGuide.generate · POST /buyers-guides/generate · gate offer · sandbox · answers BuyersGuideGenerate@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) · /5GAERDKWXRJ132583 (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 — BuyersGuide.generated@1.

the SDK — buyersGuide.generate
import { buyersGuide } from 'apis.vin'

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

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:08.582Z · HTTP 200
{
  "type": "OK",
  "answers": "BuyersGuideGenerate@1",
  "value": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "guide": {
      "id": "BG-eb4e5215",
      "language": "en",
      "dealer": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "warranty": {
        "box": "warranty",
        "standing": "active",
        "kind": "factory-warranty",
        "bumperMiles": 36000,
        "powertrainMiles": 60000
      },
      "status": "generated"
    }
  },
  "evidence": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "guide": {
      "id": "BG-eb4e5215",
      "language": "en",
      "dealer": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "warranty": {
        "box": "warranty",
        "standing": "active",
        "kind": "factory-warranty",
        "bumperMiles": 36000,
        "powertrainMiles": 60000
      },
      "status": "generated"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "window-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

affix

buyersGuide.affix · POST /buyers-guides/affix · gate offer · sandbox · answers BuyersGuideAffix@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) · /5GAERDKWXRJ132583 (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 — BuyersGuide.affixed@1.

the SDK — buyersGuide.affix
import { buyersGuide } from 'apis.vin'

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

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:08.580Z · HTTP 200
{
  "type": "OK",
  "answers": "BuyersGuideAffix@1",
  "value": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "affixture": {
      "id": "BG-eb4e5215",
      "status": "affixed",
      "location": "vehicle-window"
    }
  },
  "evidence": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "affixture": {
      "id": "BG-eb4e5215",
      "status": "affixed",
      "location": "vehicle-window"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "window-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

asIs

buyersGuide.asIs · POST /buyers-guides/as-is · gate offer · sandbox · answers BuyersGuideAsIs@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) · /5GAERDKWXRJ132583 (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 — BuyersGuide.asIsDesignated@1.

the SDK — buyersGuide.asIs
import { buyersGuide } from 'apis.vin'

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

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:08.580Z · HTTP 200
{
  "type": "OK",
  "answers": "BuyersGuideAsIs@1",
  "value": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "designation": {
      "id": "BG-eb4e5215",
      "status": "not-as-is",
      "basis": "factory-warranty-active"
    }
  },
  "evidence": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "designation": {
      "id": "BG-eb4e5215",
      "status": "not-as-is",
      "basis": "factory-warranty-active"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "window-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

retain

buyersGuide.retain · POST /buyers-guides/retain · gate offer · sandbox · answers BuyersGuideRetain@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) · /5GAERDKWXRJ132583 (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 — BuyersGuide.retained@1.

the SDK — buyersGuide.retain
import { buyersGuide } from 'apis.vin'

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

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:08.582Z · HTTP 200
{
  "type": "OK",
  "answers": "BuyersGuideRetain@1",
  "value": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "retention": {
      "id": "BG-eb4e5215",
      "status": "retained",
      "custodian": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store"
      },
      "retainedOn": "2026-08-10"
    }
  },
  "evidence": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "retention": {
      "id": "BG-eb4e5215",
      "status": "retained",
      "custodian": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store"
      },
      "retainedOn": "2026-08-10"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "window-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

spanish

buyersGuide.spanish · POST /buyers-guides/spanish · gate offer · sandbox · answers BuyersGuideSpanish@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) · /5GAERDKWXRJ132583 (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 — BuyersGuide.bilingualIssued@1.

the SDK — buyersGuide.spanish
import { buyersGuide } from 'apis.vin'

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

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:08.583Z · HTTP 200
{
  "type": "OK",
  "answers": "BuyersGuideSpanish@1",
  "value": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "guide": {
      "id": "BG-eb4e5215",
      "languages": [
        "en",
        "es"
      ],
      "dealer": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "warranty": {
        "box": "warranty",
        "standing": "active",
        "kind": "factory-warranty",
        "bumperMiles": 36000,
        "powertrainMiles": 60000
      },
      "status": "issued-bilingual"
    }
  },
  "evidence": {
    "vin": "5GAERDKWXRJ132583",
    "noun": "buyersGuide",
    "asOf": "2026-08-10",
    "listingId": "LST-0cee2505",
    "venue": "estate-storefront",
    "price": 2300000,
    "odometer": 53200,
    "photos": [
      {
        "setId": "PH-bca043f7",
        "kind": "exterior",
        "shots": 8
      },
      {
        "setId": "PH-bca043f7",
        "kind": "interior",
        "shots": 4
      }
    ],
    "daysOnLot": 34,
    "commercialState": "retail",
    "status": "Draft",
    "guide": {
      "id": "BG-eb4e5215",
      "languages": [
        "en",
        "es"
      ],
      "dealer": {
        "id": "DLR-b9066ade",
        "name": "The Estate Store",
        "licenseId": "DL-7bcdd2ef"
      },
      "warranty": {
        "box": "warranty",
        "standing": "active",
        "kind": "factory-warranty",
        "bumperMiles": 36000,
        "powertrainMiles": 60000
      },
      "status": "issued-bilingual"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "window-papers-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.

Listing

Modeled

The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. One diagram, rendered from the estate model.

BuyersGuide · Class model

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

buyback

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

catastrophe

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

On this page

Identity
Events
Fulfill & operate
generate
More actions
affix
asIs
retain
spanish
Data model
Listing
Modeled