POST

Query Locations

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves locations, given the specified filters, sorting, and paging.

PropertyFiltersSort
_id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
name$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
description$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
default$eq, $ne, $in, $existsNone
status$eq, $ne, $in, $existsNone
locationType$eq, $ne, $in, $existsNone
fax$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
timeZone$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
email$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
phone$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
address.subdivision$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
address.city$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
address.postalCode$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
address.streetAddress.number$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
address.streetAddress.name$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
businessSchedule.periods.openDay$eq, $ne, $in, $existsNone
businessSchedule.periods.openTime$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
businessSchedule.periods.closeDay$eq, $ne, $in, $existsNone
businessSchedule.periods.closeTime$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
businessSchedule.specialHourPeriod.startDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
businessSchedule.specialHourPeriod.endDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
businessSchedule.specialHourPeriod.isClosed$eq, $ne, $in, $existsNone
businessSchedule.specialHourPeriod.comment$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
revision$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteNone
archived$eq, $ne, $in, $existsNone
Permissions
Read Locations
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?