A MappedinCategory is a collection of similar Locations.

A Category can have more properties such as 'name', or 'parents' (for hierarchical categories) as well. For example, you may have a Fashion category, which has a Men's Fashion and Women's Fashion category. A Men's clothing store would belong to the Men’s Fashion category, but not necessarily be present in the Fashion category's list of Locations.

The Mappedin 'things' object is where you would specify what properties you want to download for Categories. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.

See below for an example a 'things' object with available Category properties specified:

things: {
    venue: [],
    locations: [],
    categories: ['venue', 'name', 'language', 'externalId', 'parents'],
    maps: []
}
Show:

Properties

id

String

Category ID.

This is the internal Mappedin ID, and can be used for the lifetime of the data you get back from getVenue, but it may not be present in future calls, even if there is another Category with otherwise similar properties. An ID can never be reused if it's, say, accidentally deleted. If something more durable is required, or if the data in the Mappedin CMS is being synced from somewhere else, you should finding things using the externalId property.

locations

[MappedinLocation]

Locations in this Category.