Public stores

The shop directory, storefronts and listings.

GET/api/v1/public/listings/{id}

A shop’s listing

Public

A listing of an active shop (active or sold out), with more from the same shop.

SDK: collector.getPublicListing()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Responses

200The listing.
PublicListingView
- listingobjectrequired
  Fields of listing
  idstring (uuid)required
  storeIdstring (uuid)required
  priceCentsintegerrequired
  currencystringrequired
  quantityintegerrequired
  gradenumber or nullrequired
  gradingCompanyenum or nullrequired
  One ofcgccbcspsapgxegshgaother
  labelTypestring or nullrequired
  isSignedbooleanrequired
  signaturesarray of stringrequired
  coverUrlstring (uri) or nullrequired
  editionNamestring or nullrequired
  issueobjectrequired
  Fields of issue
  numberstringrequired
  titlestring or nullrequired
  isKeybooleanrequired
  pathstringrequired
  A path on collection.id, e.g. /catalog/series/saga-2012/1.
  seriesTitlestringrequired
  seriesStartYearinteger or nullrequired
  publisherstring or nullrequired
  pageQualitystring or nullrequired
  certNumberstring or nullrequired
  conditionNotesstring or nullrequired
  photoUrlsarray of string (uri)required
  The shop’s photos of this copy.
  statusstringrequired
  'active', or 'sold_out' (still shown).
  createdAtstring (date-time)required
- storeobjectrequired
  Fields of store
  idstring (uuid)required
  namestringrequired
  slugstringrequired
  taglinestring or nullrequired
  phonestring or nullrequired
  logoUrlstring (uri) or nullrequired
  citystring or nullrequired
  regionstring or nullrequired
  countrystring or nullrequired
  acceptsHoldsbooleanrequired
  holdDaysinteger or nullrequired
  shipsbooleanrequired
  isVerifiedbooleanrequired
- morearray of PublicListingCardrequired
  More from the same shop.
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (404, 429, 500)

404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/listings/<id>'

TypeScript SDK

await collector.getPublicListing({ path: { id } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/stores

The shop directory

Public

Shops matching a name or city; nearest first when a position is given (rounded to about a kilometre).

SDK: collector.listPublicStores()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`q`optional	query	string
`lat`optional	query	string	Latitude, with lng.
`lng`optional	query	string	Longitude, with lat.

Responses

200Totals and shops.
PublicStoresView
- totalsobjectrequired
  Fields of totals
  storesintegerrequired
  listingsintegerrequired
- storesarray of objectrequired
  Fields of stores
  idstring (uuid)required
  namestringrequired
  slugstringrequired
  taglinestringrequired
  citystringrequired
  regionstringrequired
  countrystringrequired
  latitudenumberrequired
  longitudenumberrequired
  distance_kmnumberrequired
  active_listingsintegerrequired
  is_verifiedbooleanrequired
  shipsbooleanrequired
  logo_pathstringrequired
  logoUrlstring (uri) or nullrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 429, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/stores'

TypeScript SDK

await collector.listPublicStores({ query: { … } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/stores/{slug}

A shop’s storefront

PublicPaginated (page)

An active shop and one page of what’s on its shelves (filters as on the page).

SDK: collector.getPublicStorefront()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`slug`required	path	string	1–200 characters
`q`optional	query	string
`publisher`optional	query	string
`condition`optional	query	string
`min`optional	query	string	Minimum price in cents.
`max`optional	query	string	Maximum price in cents.
`sort`optional	query	string
`page`optional	query	string

Responses

200The shop and a page of its listings.
PublicStorefrontView
- storeobjectrequired
  Fields of store
  idstring (uuid)required
  namestringrequired
  slugstringrequired
  taglinestring or nullrequired
  descriptionstring or nullrequired
  logo_pathstring or nullrequired
  banner_pathstring or nullrequired
  websitestring or nullrequired
  phonestring or nullrequired
  emailstring or nullrequired
  address_line1string or nullrequired
  address_line2string or nullrequired
  citystring or nullrequired
  regionstring or nullrequired
  postal_codestring or nullrequired
  countrystring or nullrequired
  latitudenumber or nullrequired
  longitudenumber or nullrequired
  hoursJsonValuerequired
  specialtiesarray of stringrequired
  shipsbooleanrequired
  accepts_holdsbooleanrequired
  hold_daysintegerrequired
  statusstringrequired
  is_verifiedbooleanrequired
  created_atstring (date-time)required
  updated_atstring (date-time)required
  logoUrlstring (uri) or nullrequired
  bannerUrlstring (uri) or nullrequired
- inventoryobjectrequired
  Fields of inventory
  listingsarray of PublicListingCardrequired
  countintegerrequired
  pageintegerrequired
  pageSizeintegerrequired
- publishersarray of objectrequired
  Fields of publishers
  idstring (uuid)required
  namestringrequired
  countintegerrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 429, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/stores/<slug>'

TypeScript SDK

await collector.getPublicStorefront({ path: { slug }, query: { … } });

Try it· sends a real request to collection.id from this page