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.

Property	Filters	Sort
`_id`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`name`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`description`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`default`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`status`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`locationType`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`fax`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`timeZone`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`email`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`phone`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.country`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.subdivision`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.city`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.postalCode`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.streetAddress.number`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.streetAddress.name`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`address.streetAddress.apt`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`businessSchedule.periods.openDay`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`businessSchedule.periods.openTime`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`businessSchedule.periods.closeDay`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`businessSchedule.periods.closeTime`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`businessSchedule.specialHourPeriod.startDate`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`businessSchedule.specialHourPeriod.endDate`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`businessSchedule.specialHourPeriod.isClosed`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None
`businessSchedule.specialHourPeriod.comment`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`revision`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`	None
`archived`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	None

Permissions

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?