discogs-service/docs/data/documentation/discogsservice/client/addordermessage(path:headers:body:).json

{"metadata":{"externalID":"s:14DiscogsService11APIProtocolPAAE15addOrderMessage4path7headers4bodyAA10OperationsO03AddeF0O6OutputOAK5InputV4PathV_AO7HeadersVAA10ComponentsO13RequestBodiesO0eF0OtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","roleHeading":"Instance Method","title":"addOrderMessage(path:headers:body:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addOrderMessage","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","text":"RequestBodies"},{"kind":"text","text":"."},{"text":"OrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO"}],"role":"symbol","modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addOrderMessage(path:headers:body:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"abstract":[{"text":"Add a message to an order.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addOrderMessage","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"AddOrderMessage","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage","text":"AddOrderMessage"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Headers-swift.struct","text":"Headers"},{"text":" = .init(), ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"RequestBodies","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies"},{"text":".","kind":"text"},{"text":"OrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/OrderMessage"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output"}],"languages":["swift"]}]},{"content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Adds a new message to the order’s message log."}]},{"type":"paragraph","inlineContent":[{"text":"When posting a new message, it is also possible to update the order status. In this case, the message will automatically be prepended with: ","type":"text"},{"inlineContent":[{"type":"text","text":"Seller changed status from Old Status to New Status"}],"type":"emphasis"}]},{"type":"paragraph","inlineContent":[{"text":"While both ","type":"text"},{"type":"codeVoice","code":"message"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"status"},{"type":"text","text":" properties are each optional, one or both must be present."}]},{"inlineContent":[{"type":"text","text":"This endpoint requires authentication as a seller."}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"POST \/marketplace\/orders\/{order_id}\/messages"},{"text":".","type":"text"}]}],"type":"aside","style":"note"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/marketplace\/orders\/{order_id}\/messages\/post(addOrderMessage)","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"Remark","style":"note","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/addordermessage(path:headers:body:)"]}],"sections":[],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Client/addOrderMessage(path:headers:body:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addOrderMessage(path:headers:body:)","abstract":[{"type":"text","text":"Add a message to an order."}],"type":"topic","title":"addOrderMessage(path:headers:body:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"addOrderMessage"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddOrderMessage","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","kind":"typeIdentifier","text":"AddOrderMessage"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"RequestBodies","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO","kind":"typeIdentifier","text":"OrderMessage"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/client\/addordermessage(path:headers:body:)"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/addordermessage\/input\/path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"abstract":[],"title":"Operations.AddOrderMessage.Input.Path","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies":{"url":"\/documentation\/discogsservice\/components\/requestbodies","navigatorTitle":[{"text":"RequestBodies","kind":"identifier"}],"abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/requestBodies"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.RequestBodies","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RequestBodies","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"Operations.AddOrderMessage.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/addordermessage\/output"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies/OrderMessage":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"OrderMessage"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/requestbodies\/ordermessage","title":"Components.RequestBodies.OrderMessage","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"OrderMessage"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/OrderMessage"},"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/AddOrderMessage":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AddOrderMessage"}],"kind":"symbol","role":"symbol","title":"Operations.AddOrderMessage","url":"\/documentation\/discogsservice\/operations\/addordermessage","abstract":[{"text":"Add a message to an order.","type":"text"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"AddOrderMessage"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input":{"url":"\/documentation\/discogsservice\/operations\/addordermessage\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"abstract":[],"title":"Operations.AddOrderMessage.Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input","role":"symbol"},"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/AddOrderMessage/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/addordermessage\/input\/headers-swift.struct","type":"topic","abstract":[],"title":"Operations.AddOrderMessage.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Headers-swift.struct"}}}