{
    "componentChunkName": "component---src-templates-article-page-template-js",
    "path": "/references/extended-data/",
    "result": {"data":{"markdownRemark":{"frontmatter":{"title":"Extended data","slug":"extended-data","updated":"2021-12-15T00:00:00.000Z","category":"references","ingress":"Reference documentation providing information on all the different types of extended data.","skills":null},"htmlAst":{"type":"root","children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Extended data"}]},{"type":"text","value":" is a set of arbitrary keys and values stored with the\nAPI resources. The values for the keys can be any valid JSON values,\nincluding a JSON object (hash). This provides API clients with the\ncapability to store arbitrary structured data for the supported resource\ntypes. Via search schema we also support querying, filtering, and\nsorting by extended data for some value types."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"types-of-extended-data","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#types-of-extended-data","ariaLabel":"types of extended data permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Types of extended data"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"Note:"}]},{"type":"text","value":" Extended data support in API resources is work in progress.\nSee the "},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/concepts/api/"},"children":[{"type":"text","value":"API reference"}]},{"type":"text","value":" for each resource for\ninformation on supported extended data."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"There are four types of extended data: "},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"metadata"}]},{"type":"text","value":", "},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"private data"}]},{"type":"text","value":",\n"},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"protected data"}]},{"type":"text","value":" and "},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"public data"}]},{"type":"text","value":". Each type has different access\nsemantics (i.e. who is allowed to read or write the data)."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"public-data","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#public-data","ariaLabel":"public data permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Public data"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Public data"}]},{"type":"text","value":" is writable by whoever has write access to a given\nresource (e.g. listing's author can write public data about the listing,\na user can write public data in their profile). Public data is readable\nvia all API endpoints that return the resource and by marketplace\noperators."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Public data can be used, for instance, to store additional information\nabout listings and users in order to help customers make buying\ndecisions."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"protected-data","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#protected-data","ariaLabel":"protected data permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Protected data"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Protected data"}]},{"type":"text","value":" is writable and readable by whoever has write access to\na resource. It is also readable by marketplace operators. Protected data\ncan be revealed to all transaction parties via the marketplace\n"},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/concepts/transaction-process/"},"children":[{"type":"text","value":"transaction process"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Protected data can be used to store information about listings or users\nthat is only made visible to a customer at a specific point in the\n"},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/concepts/transaction-process/"},"children":[{"type":"text","value":"transaction process"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"private-data","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#private-data","ariaLabel":"private data permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Private data"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Private data"}]},{"type":"text","value":" is similar to protected data, but is not intended to be\nrevealed via the transaction process. For instance, it can be used to\ncollect and store information about users or listings for marketplace\noperators."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"metadata","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#metadata","ariaLabel":"metadata permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Metadata"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Metadata"}]},{"type":"text","value":" is writable by marketplace operators and can be read via all\nAPI endpoints returning the corresponding resource. Metadata is\nsupported for users and listings. It can also be used as filters when\nsearching via\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/marketplace.html#query-listings","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"/listings/query in Marketplace API"}]},{"type":"text","value":",\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/integration.html#query-listings","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"/listings/query in Integration API"}]},{"type":"text","value":"\nor\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/integration.html#query-users","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"/users/query in Integration API"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Metadata can be used to store data about listings and users that must\nonly be writable by marketplace operators or through integrations to\nother systems built around the Integration API and that the users\nthemselves must not be able to modify."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"search-schema","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#search-schema","ariaLabel":"search schema permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Search schema"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Extended data is available out of the box and can be written and read\nvia the Marketplace API, Integration API and Console without any prior\nconfiguration. "},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"Search schema"}]},{"type":"text","value":" may optionally be defined for some value\ntypes of extended data. When a schema is provided for a given extended\ndata key, the API can use this information to make querying the extended\ndata possible via some API endpoints. For instance\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/marketplace.html#query-listings","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"/listings/query"}]},{"type":"text","value":"\nsupports querying listings by public data or metadata."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Search schemas can be managed with\n"},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/introduction/getting-started-with-flex-cli/"},"children":[{"type":"text","value":"Flex CLI"}]},{"type":"text","value":". With the CLI,\nyou can list, set and unset search schemas for listing's public data and\nmetadata as well as for user profile's metadata, private, protected and\npublic data. The commands to manage search schemas are:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"flex-cli search"}]},{"type":"text","value":" List all defined data schemas"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"flex-cli search set"}]},{"type":"text","value":" Set (create or update) data schema"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"flex-cli search unset"}]},{"type":"text","value":" Unset data schema"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"You can also check out our tutorial for\n"},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/how-to/manage-search-schemas-with-flex-cli/"},"children":[{"type":"text","value":"managing search schemas with Flex CLI"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"blockquote","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"Note:"}]},{"type":"text","value":" Only top-level values in extended data can have a schema."}]},{"type":"text","value":"\n"}]}],"data":{"quirksMode":false}},"headings":[{"value":"Types of extended data","depth":2},{"value":"Public data","depth":3},{"value":"Protected data","depth":3},{"value":"Private data","depth":3},{"value":"Metadata","depth":3},{"value":"Search schema","depth":2}]}},"pageContext":{"slug":"extended-data","category":"references"}},
    "staticQueryHashes": ["3794076007","439097193","717698143"]}