Files
discogs-service/docs/data/documentation/discogsservice/operations/getlisting.json
T

1 line
7.4 KiB
JSON

{"abstract":[{"text":"Get information about a listing in the marketplace.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getlisting"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetListing","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"GetListing"}],"title":"Operations.GetListing","symbolKind":"enum","externalID":"s:14DiscogsService10OperationsO10GetListingO","roleHeading":"Enumeration"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetListing","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"text":"Overview","anchor":"overview","type":"heading"},{"inlineContent":[{"type":"text","text":"Views the data associated with a listing in the marketplace."}],"type":"paragraph"},{"inlineContent":[{"text":"In case of authenticated as an inventory owner, items that not only have the ","type":"text"},{"code":"For Sale","type":"codeVoice"},{"text":" state will be shown as well as other extra fields in those items such as ","type":"text"},{"code":"weight","type":"codeVoice"},{"text":", ","type":"text"},{"code":"format_quality","type":"codeVoice"},{"text":", ","type":"text"},{"code":"external_id","type":"codeVoice"},{"text":", ","type":"text"},{"code":"location","type":"codeVoice"},{"text":", and ","type":"text"},{"code":"quantity_keys","type":"codeVoice"},{"text":". Note that the ","type":"text"},{"code":"quantity","type":"codeVoice"},{"text":" field is read-only for ","type":"text"},{"inlineContent":[{"type":"text","text":"NearMint"}],"type":"emphasis"},{"text":" users, who will see ","type":"text"},{"inlineContent":[{"text":"1","type":"text"}],"type":"emphasis"},{"text":" for all quantity values, regardless of their actual count.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"In case the user is authorized, the listing will contain a "},{"code":"in_cart","type":"codeVoice"},{"type":"text","text":" boolean field indicating whether or not this listing is in their cart."}],"type":"paragraph"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/marketplace\/listings\/{listing_id}","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside","name":"Remark"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/marketplace\/listings\/{listing_id}\/get(getListing)","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"Remark"}]}],"kind":"symbol","sections":[],"topicSections":[{"anchor":"Structures","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input"],"title":"Structures"},{"anchor":"Type-Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/id"],"title":"Type Properties"},{"anchor":"Enumerations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Output"],"title":"Enumerations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Output":{"title":"Operations.GetListing.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlisting\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Output","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/AcceptableContentType":{"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/AcceptableContentType","abstract":[],"title":"Operations.GetListing.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getlisting\/acceptablecontenttype"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/id":{"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/id","title":"id","url":"\/documentation\/discogsservice\/operations\/getlisting\/id"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing":{"title":"Operations.GetListing","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlisting","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetListing"}],"navigatorTitle":[{"kind":"identifier","text":"GetListing"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","kind":"symbol","abstract":[{"type":"text","text":"Get information about a listing in the marketplace."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Input":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getlisting\/input","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","title":"Operations.GetListing.Input","type":"topic"}}}