docs.vin

allocation

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

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

Identity

Nounallocation
PillarData (facets: 6 data · 6 services · 2 commerce)
Capabilities14 — 0 live · 14 sandbox · 0 declared
EntitiesAllocation
Doorsaggregator.vin
SDKVin.allocation.* from apis.vin
Address/catalog/allocation#{action} — the anchor IS the wire name minus allocation.

Lifecycle

Allocation — AllocationFSM: 7 states, 7 transitions — Allocated · Confirmed · Produced · Shipped · ConstraintHold · Rescheduled · Frontlined. Each transition is a past-tense event on the record.

Events

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

Discover & read

read

allocation.read · GET /allocations/read · gate none · sandbox · answers AllocationRead@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — allocation.read
import { allocation } from 'apis.vin'

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

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:07.413Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationRead@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "allocation": {
      "id": "ALC-9e13c7c1",
      "position": "Allocated",
      "dealerId": "DLR-b9066ade",
      "held": false
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "allocation": {
      "id": "ALC-9e13c7c1",
      "position": "Allocated",
      "dealerId": "DLR-b9066ade",
      "held": false
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

eligibility

allocation.eligibility · GET /allocations/eligibility · gate key · sandbox · answers AllocationEligibility@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — allocation.eligibility
import { allocation } from 'apis.vin'

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

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:07.395Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationEligibility@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "eligibility": {
      "dealerId": "DLR-b9066ade",
      "eligible": true,
      "basis": "turn-and-earn",
      "turnDays": 49,
      "targetDays": 45
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "eligibility": {
      "dealerId": "DLR-b9066ade",
      "eligible": true,
      "basis": "turn-and-earn",
      "turnDays": 49,
      "targetDays": 45
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

allocate

allocation.allocate · POST /allocations/allocate · gate offer · sandbox · answers AllocationAllocate@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) · /WP1AB2XA6SL150782 (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 — Allocation.allocated@1.

the SDK — allocation.allocate
import { allocation } from 'apis.vin'

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

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:07.383Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationAllocate@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "allocation": {
      "status": "allocated",
      "id": "ALC-9e13c7c1",
      "position": "Allocated",
      "dealerId": "DLR-b9066ade"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "allocation": {
      "status": "allocated",
      "id": "ALC-9e13c7c1",
      "position": "Allocated",
      "dealerId": "DLR-b9066ade"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reallocate

allocation.reallocate · POST /allocations/reallocate · gate offer · sandbox · answers AllocationReallocate@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) · /WP1AB2XA6SL150782 (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 — Allocation.reallocated@1.

the SDK — allocation.reallocate
import { allocation } from 'apis.vin'

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

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:07.415Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationReallocate@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "reallocation": {
      "status": "reallocated",
      "id": "ALC-9e13c7c1",
      "toDealerId": "DLR-b9066ade"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "reallocation": {
      "status": "reallocated",
      "id": "ALC-9e13c7c1",
      "toDealerId": "DLR-b9066ade"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

request

allocation.request · POST /allocations/request · gate offer · sandbox · answers AllocationRequest@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) · /WP1AB2XA6SL150782 (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 — Allocation.requested@1.

the SDK — allocation.request
import { allocation } from 'apis.vin'

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

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:07.423Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationRequest@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "request": {
      "status": "requested",
      "id": "ALC-9e13c7c1",
      "dealerId": "DLR-b9066ade"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "request": {
      "status": "requested",
      "id": "ALC-9e13c7c1",
      "dealerId": "DLR-b9066ade"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

allocation.pay · POST /allocations/pay · gate offer · sandbox · answers AllocationPay@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) · /WP1AB2XA6SL150782 (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 — Allocation.failed@1 · Allocation.paid@1.

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

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

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:07.397Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationPay@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-75a143a7",
      "amountCents": 3733091,
      "currency": "USD",
      "status": "settled"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-75a143a7",
      "amountCents": 3733091,
      "currency": "USD",
      "status": "settled"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

wholesaleInvoice

allocation.wholesaleInvoice · POST /allocations/wholesale-invoice · gate offer · sandbox · answers AllocationWholesaleInvoice@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) · /WP1AB2XA6SL150782 (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 — Allocation.failed@1 · Allocation.wholesaleInvoiced@1.

the SDK — allocation.wholesaleInvoice
import { allocation } from 'apis.vin'

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

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:07.430Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationWholesaleInvoice@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "invoice": {
      "id": "WI-33e501c8",
      "amountCents": 3733091,
      "msrpCents": 3990100,
      "destinationCents": 102100,
      "holdbackCents": 119703,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "invoice": {
      "id": "WI-33e501c8",
      "amountCents": 3733091,
      "msrpCents": 3990100,
      "destinationCents": 102100,
      "holdbackCents": 119703,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

accept

allocation.accept · POST /allocations/accept · gate offer · sandbox · answers AllocationAccept@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) · /WP1AB2XA6SL150782 (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 — Allocation.accepted@1.

the SDK — allocation.accept
import { allocation } from 'apis.vin'

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

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:07.378Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationAccept@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "acceptance": {
      "status": "accepted",
      "id": "ALC-9e13c7c1",
      "orderId": "FO-9edfc23f"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "acceptance": {
      "status": "accepted",
      "id": "ALC-9e13c7c1",
      "orderId": "FO-9edfc23f"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

constraint

allocation.constraint · GET /allocations/constraint · gate key · sandbox · answers AllocationConstraint@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — Allocation.constraintHeld@1 · Allocation.rescheduled@1.

the SDK — allocation.constraint
import { allocation } from 'apis.vin'

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

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:07.391Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationConstraint@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "constraint": {
      "status": "no-constraint",
      "id": "ALC-9e13c7c1",
      "position": "Allocated"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "constraint": {
      "status": "no-constraint",
      "id": "ALC-9e13c7c1",
      "position": "Allocated"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

orderBank

allocation.orderBank · POST /allocations/order-bank · gate offer · sandbox · answers AllocationOrderBank@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) · /WP1AB2XA6SL150782 (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 — Allocation.orderBanked@1.

the SDK — allocation.orderBank
import { allocation } from 'apis.vin'

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

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:07.395Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationOrderBank@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "orderBank": {
      "orders": 5,
      "byPosition": {
        "Shipped": 1,
        "Confirmed": 1,
        "Produced": 1,
        "ConstraintHold": 1,
        "Rescheduled": 1
      }
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "orderBank": {
      "orders": 5,
      "byPosition": {
        "Shipped": 1,
        "Confirmed": 1,
        "Produced": 1,
        "ConstraintHold": 1,
        "Rescheduled": 1
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

pipeline

allocation.pipeline · GET /allocations/pipeline · gate key · sandbox · answers AllocationPipeline@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — Allocation.produced@1 · Allocation.shipped@1.

the SDK — allocation.pipeline
import { allocation } from 'apis.vin'

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

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:07.402Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationPipeline@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "pipeline": {
      "allocations": 7,
      "byPosition": {
        "Shipped": 1,
        "Frontlined": 1,
        "Allocated": 1,
        "Confirmed": 1,
        "Produced": 1,
        "ConstraintHold": 1,
        "Rescheduled": 1
      }
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "pipeline": {
      "allocations": 7,
      "byPosition": {
        "Shipped": 1,
        "Frontlined": 1,
        "Allocated": 1,
        "Confirmed": 1,
        "Produced": 1,
        "ConstraintHold": 1,
        "Rescheduled": 1
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

pool

allocation.pool · GET /allocations/pool · gate key · sandbox · answers AllocationPool@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — allocation.pool
import { allocation } from 'apis.vin'

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

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:07.403Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationPool@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "pool": {
      "unclaimed": 1,
      "allocations": 7
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "pool": {
      "unclaimed": 1,
      "allocations": 7
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

swap

allocation.swap · POST /allocations/swap · gate offer · sandbox · answers AllocationSwap@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) · /WP1AB2XA6SL150782 (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 — Allocation.swapped@1.

the SDK — allocation.swap
import { allocation } from 'apis.vin'

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

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:07.424Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationSwap@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "swap": {
      "status": "swapped",
      "id": "ALC-9e13c7c1",
      "toDealerId": "DLR-b9066ade"
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "swap": {
      "status": "swapped",
      "id": "ALC-9e13c7c1",
      "toDealerId": "DLR-b9066ade"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

turnAndEarn

allocation.turnAndEarn · GET /allocations/turn-and-earn · gate key · sandbox · answers AllocationTurnAndEarn@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /WP1AB2XA6SL150782 (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 — allocation.turnAndEarn
import { allocation } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await allocation.turnAndEarn({"vin":"WP1AB2XA6SL150782"})
GET /allocations/turn-and-earn
curl 'https://apis.vin/allocations/turn-and-earn?vin=WP1AB2XA6SL150782'

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:07.424Z · HTTP 200
{
  "type": "OK",
  "answers": "AllocationTurnAndEarn@1",
  "value": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "turnAndEarn": {
      "dealerId": "DLR-b9066ade",
      "turnDays": 49,
      "targetDays": 45,
      "earning": false
    }
  },
  "evidence": {
    "vin": "WP1AB2XA6SL150782",
    "noun": "allocation",
    "asOf": "2026-08-10",
    "turnAndEarn": {
      "dealerId": "DLR-b9066ade",
      "turnDays": 49,
      "targetDays": 45,
      "earning": false
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "oem-factory-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.

Allocation

Schema

PropertyType
idid
oemIdref→Party
dealerIdref→Dealer
statusAllocationFSM

Relationships

FromToCardinalityAs
allocationoem*:1from
allocationdealer*:1to

Modeled

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

Allocation · Class model

Allocation · State machine

Allocation · State machine

Allocation · Sequence

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

alignment

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

appraisal

The appraisal noun — identity, lifecycle, events, and every capability as an anchored section: 16 capabilities, 1 live, 15 sandbox, 0 declared.

On this page

Identity
Lifecycle
Events
Discover & read
read
eligibility
allocate
reallocate
Apply & book
request
Pay & settle
pay
wholesaleInvoice
Authorize & resolve
accept
More actions
constraint
orderBank
pipeline
pool
swap
turnAndEarn
Data model
Allocation
Modeled