Developer docs · Schemas
Schemas
The 169 named types requests and responses share. Each operation in the reference links the ones it uses.
- AccountDeletionPreview
What deleting the account removes, keeps and hands over.
- AccountDeletionResult
The account is gone.
- AccountExport
A requested full export of the account.
- AccountExportDownload
A short-lived link to one ZIP part of a ready export.
- AdminAnnouncement
- AdminAuditEntry
- AdminAuditPage
- AdminCapacity
- AdminCatalogRecord
- AdminCatalogSearchHit
- AdminChangeRequest
- AdminChangeRequestPage
- AdminCodeEdition
- AdminCodeProposal
- AdminCodeProposalPage
- AdminConflictAlignedIssue
- AdminConflictMergeImpact
- AdminConflictSeriesFacts
- AdminCoverContribution
- AdminCoverContributionPage
- AdminCoverCoverage
- AdminCoverMatch
- AdminCronJob
- AdminCronRun
- AdminFieldDiff
- AdminFieldLock
- AdminHealthView
- AdminImportConflict
- AdminImportConflictDetail
- AdminImportConflictPage
- AdminImportJob
- AdminImportPage
- AdminIncident
- AdminIssueMove
- AdminMergeRecord
- AdminOverview
- AdminPlanGrant
- AdminPlanGrantPage
- AdminReport
- AdminReportPage
- AdminStore
- AdminStorePage
- AdminSupportMessage
- AdminSupportPage
- AdminUsage
- AdminUser
- AdminUserLabel
- AdminUserPage
- AdminVariantProposal
- AdminVariantProposalPage
- AiCreditsCapacity
- AnnouncementAudience
- AnnouncementRow
An announcement as stored (snake_case columns).
- AnnouncementSeverity
- AssistantThread
A conversation with the assistant.
- AssistantThreadDetail
A conversation with its messages.
- AssistantWritePreview
Exactly what a proposed change would do, from live data, by the code that runs it after approval.
- BandEstimate
A community estimate for one grade band, with its evidence.
- BuyListing
A shop’s copy of an issue ("Buy a copy").
- CapacityUnavailable
- CatalogCandidate
A possible match for what the caller described, with the evidence for it.
- CatalogEntityKind
- CatalogFieldSpecView
- CatalogOverride
- CatalogOverrideRevert
- CatalogOverridesResponse
- CatalogOverrideVersion
- CatalogPick
A catalog book a store can list.
- CatalogQuery
How free text was read: "X-Men (1991) 1" is title X-Men, year 1991, number 1.
- CertRecord
A grading company’s record for one certificate, normalized across graders. “…Text” fields are the grader’s own wording.
- ChangeRequestStatus
- CodeProposalStatus
- ConflictMergeOutcome
- ConflictProviderLookup
- CopyChange
A change to what a copy is (issue, edition or variant), from its history.
- CopyCode
A barcode, ISBN, ISSN or distributor code a collector added to a copy, with its review.
- CopyTargetOption
An issue (and edition) a copy can be changed to.
- CoverBarcodeOutcome
- CoverContributionStatus
- CoverWanted
A copy the caller owns whose issue has no cover yet.
- CronRunStatus
- DatabaseCapacity
- DuplicateGroup
- EditableCatalogEntity
- ExternalLookup
- Grading
Raw copies with their raw and likely-slabbed estimates, and the graders’ fees.
- Hold
A request for a store to set a book aside, and how it went.
- HoldMessage
- ImportConflictStatus
- ImportPreview
An inventory CSV, parsed and matched against the catalog. Nothing is saved.
- IncidentKind
- InsightsEntitlements
What the collector’s plan unlocks.
- InsuranceReport
Every owned copy with what identifies it, what was paid and its value. Estimates are never appraisals.
- IssueDetail
An issue as the catalog stores it, with its series, editions (variants), other editions (releases), credits and characters. Columns are snake_case; more may be added.
- IssueRelease
- ItemValueDetail
One copy’s value with the evidence behind it.
- JsonValue
Any JSON value (here: opening hours as the shop entered them).
- MaterializeResult
The catalog records a book now has (created from a provider, or new and provisional).
- MergeChildOption
- MergeChildPlan
- MergeEntity
- MergePlan
- MergePreview
- MergeRecordSummary
- MetronCapacity
- MyCorrection
One of the caller’s suggested corrections.
- MyCoverContribution
A cover photo the caller sent for review.
- MyHold
A hold as the collector who asked sees it.
- MyQuestion
A question as the collector who asked sees it.
- MyStoreInvite
A team invitation as the invited collector sees it.
- MyVariantProposal
A variant the caller proposed (new, or a change to a listed one), private until reviewed.
- OverrideVersionSource
- PageSpeedCapacity
- ParsedBarcode
A barcode read as printed: UPC-A with its add-on, EAN-13, ISBN or ISSN.
- PlanGrantState
- PlatformSettingsView
- Portfolio
Counts and cost basis for every plan; values, gains, breakdowns and the sales log with insights.
- PortfolioHistory
Daily portfolio snapshots, plus today.
- PortfolioMovers
Copies whose estimate moved most over the period.
- PriceAlert
A price alert with the estimate it watches.
- PriceAlertPreview
What an alert would watch right now.
- PriceAlerts
The collector’s price alerts, and their wishlist targets.
- Problem
An error, as application/problem+json (RFC 9457).
- Profile
The collector’s profile and privacy settings.
- ProposalEditionFacts
- ProposedRelease
- PublicCatalogHome
- PublicCatalogSearch
- PublicIssueCard
- PublicIssueView
- PublicListingCard
- PublicListingView
- PublicNewReleases
- PublicProfilePageView
- PublicPublisherView
- PublicReleaseCard
- PublicSeriesCard
- PublicSeriesView
- PublicStorefrontView
- PublicStoresView
- Question
A collector’s question to a store about a listed book.
- QuestionMessage
- Redirect
The record moved (merged or renamed): read it at this path instead.
- ReportAction
- ReportReason
- ReportStatus
- ReportTargetKind
- ScanBatch
A scanning session: the scans of one sitting, with copy defaults.
- ScanCandidate
A ranked match for a scan: a catalog candidate with the scan’s own context.
- ScanExtraction
Everything read from a scan: the barcode, a slab QR code, and the AI reads of a photo.
- ScanItem
One scan: what was captured, what it matched, and the copy it became.
- Store
A store as its team and the public may read it (billing columns are server-only).
- StoreBillingSummary
How seller fees are billed: the payment method, recent invoices and the fee rate.
- StoreCatalogSearch
- StoreContext
A store, the caller’s role in it and the dashboard’s counters.
- StoreHold
A hold as the store’s staff see it.
- StoreInvite
An open team invitation as the owner sees it: the invited email only.
- StoreListing
A listing as the store’s staff see it, with staff-only fields.
- StoreMember
- StoreQuestion
A question as the store’s staff see it.
- SubmittedCorrection
- UndoResult
Journal entries put back, and ones skipped because the data changed since.
- VariantCoverBarcode
- VariantCoverWanted
A variant the caller owns that has no cover of its own (it borrows the main cover).
- VariantFields
- VariantProposalKind
- VariantProposalSource
- VariantProposalStatus
- WorkersCapacity