Problem

An error, as application/problem+json (RFC 9457).

Fields

typestring (uri)required
Identifies the error: collection.id/developers/errors#<code>.
titlestringrequired
A short summary of the status, e.g. "Not Found".
statusintegerrequired
The HTTP status code.
detailstringrequired
What went wrong, for a person to read.
codestringrequired
Stable, machine-readable error code (snake_case). Program against this.
errorsarray of objectoptional
Field-level problems (validation errors).
Fields of errors
- pathstringrequired
  The field, e.g. "body.changes.cover_date" or "query.limit".
- messagestringrequired
requestIdstringrequired
The X-Request-Id of the request; quote it to support.
errorobjectrequireddeprecated
Deprecated: the pre-v1 error shape ({ code, message, details }), kept for existing clients. Use code and detail.
Fields of error
- codestringrequired
- messagestringrequired
- detailsanyoptional

Used by

GETAnnouncements
POSTPublish or schedule an announcement
PATCHEdit an announcement
POSTTake an announcement down now
GETAudit log
GETFind catalog records to edit
GETGet a catalog record
PATCHEdit a catalog record
POSTAdd an imprint to a publisher
POSTLock or unlock a field
POSTChange a series or issue slug
POSTVerify a provisional record
GETAn edition’s overridden fields
POSTRevert an overridden field
GETOverridden fields per edition of an issue
POSTMove issues to another series
POSTUndo an issue move
POSTPreview moving issues to another series
POSTUndo a revert
GETCodes collectors added
POSTApprove or decline a code
GETCollectors’ cover photos
POSTApprove or decline a cover photo
GETCover coverage
GETIncidents, cron jobs and capacity
PATCHResolve or reopen an incident
GETImport jobs
GETImport identity conflicts
GETOne import conflict in full
POSTResolve an import conflict
POSTStart a Metron sync now
GETRecent merges
POSTMerge two records
POSTUndo a merge
GETFind likely duplicates
POSTPreview a merge
GETCatalog change requests
POSTApprove or reject a change request
GETAdmin overview counts
GETPlan grants
POSTGive someone a plan
POSTEnd a plan grant now
GETAbuse reports
POSTDecide a report
POSTUndo “hide content” for a report
GETPlatform settings
PUTChange platform settings
GETStores
PATCHVerify, suspend or set a store’s fee
GETSupport messages
PATCHClose or reopen a support message
GETProduct analytics
GETSearch people
PATCHChange someone’s role or access
GETVariant proposals and import suggestions
POSTApprove or decline a variant proposal
POSTResolve an import suggestion
POSTUndo an assigned import suggestion
GETWhether the assistant can answer
POSTSend a message
POSTPreview a proposed change
GETYour conversations
GETA conversation
DELETEDelete a conversation
PATCHRename or pin a conversation
GETCan paid plans be bought?
GETLook up a barcode
GETList your corrections to a record
POSTSuggest a correction
POSTWithdraw a correction
GETList your cover photos
POSTSend a cover photo
DELETEWithdraw a cover photo
GETYour copies whose issue has no cover
POSTIdentify a book from evidence
GETGet an issue
POSTBring a candidate into the catalog
POSTAdd a book no source knows yet
GETSearch the catalog
GETGo to an issue of a series
GETYour variants with no cover of their own
GETList your variant proposals
POSTPropose a variant
DELETEWithdraw a variant proposal
GETGraders we can look up
POSTLook up a certificate
GETIs a certificate already claimed?
GETExport the collection
POSTUndo an import
GETA copy’s certificate check
POSTCheck a copy’s certificate now
GETA copy’s history
POSTUndo a change to a copy
GETThe codes on a copy
POSTAdd a code to a copy
DELETERemove a code from a copy
POSTCheck a code against a copy
GETSuggest what a copy could be
POSTChange what a copy is
POSTChange many copies at once
GETGet a cover token
GETList my holds
POSTAsk a store to hold a book
POSTCancel a hold
POSTRecord the sale
POSTConfirm the purchase
GETRead a hold’s messages
POSTMessage about a hold
POSTAccept or decline a hold request
GETYour price alerts
POSTCreate a price alert
DELETEDelete a price alert
PATCHChange a price alert
GETPreview a price alert
GETWorth grading?
GETPortfolio history
GETOne copy’s value
GETBiggest movers
GETYour portfolio
GETThe insurance report
GETA cover for a printed label
GETWhat deleting your account does
POSTDelete your account
POSTRequest a full export
DELETEDelete an export’s files
GETDownload an export part
PATCHUpdate your profile
GETThis API’s OpenAPI document
GETThe catalog home
GETShops’ copies of an issue
GETNew releases
GETA publisher or imprint
GETSearch the public catalog
GETA series
GETAn issue
GETA shop’s listing
GETA public collection
GETThe shop directory
GETA shop’s storefront
GETList my questions to stores
POSTAsk a store about a book
POSTClose a question
POSTSet the book aside for the asker
GETRead a question’s thread
POSTReply in a question’s thread
POSTReport something
POSTCreate a scan
DELETEDelete a scan
PATCHUpdate a scan
POSTAdd a scan to the collection
POSTMatch a scan
POSTAdd a missing book for a scan
GETSearch for a scan
POSTStart a scanning session
PATCHUpdate a scanning session
POSTAct on many scans
GETSearch before scanning
POSTGet upload URLs for a scan’s photo
GETList my team invitations
POSTAccept or decline an invitation
POSTCreate a store
GETGet a store’s dashboard context
PATCHUpdate the storefront profile
GETGet the store’s billing
GETList the store’s holds
POSTImport inventory rows
POSTPreview an inventory CSV
GETList the store’s inventory
POSTList a book
GETGet a listing
DELETEDelete a listing
PATCHUpdate a listing
POSTSet many listings’ status
GETList the store’s team
DELETERemove a member, or leave
PATCHChange a member’s role
GETList open invitations
POSTInvite someone to the team
DELETEWithdraw an invitation
GETList questions to the store
GETFind a book to list
GETCheck a store address