> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryStoresLocations # Package: catalogV3 # Namespace: StoresLocationService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/stores-locations-v3/query-stores-locations.md ## Permission Scopes: Read Stores Locations in v3 catalog: SCOPE.STORES.LOCATION_READ ## Introduction Retrieves a list of up to 100 Stores locations, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response. Query Stores Locations runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md). --- ## REST API ### Schema ``` Method: queryStoresLocations Description: Retrieves a list of up to 100 Stores locations, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response. Query Stores Locations runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md). URL: https://www.wixapis.com/stores/v3/locations/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Number of items to load. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryStoresLocationsResponse - name: storesLocations | type: array | description: List of Stores locations. - name: id | type: string | description: Stores location GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Stores location is updated. To prevent conflicting changes, the current revision must be passed when updating the Stores location. Ignored when creating a Stores location. - name: createdDate | type: string | description: Date and time the Stores location was created. - name: updatedDate | type: string | description: Date and time the Stores location was last updated. - name: wixLocationId | type: string | description: Wix location GUID. Learn more about the [Locations API](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). - name: locationType | type: LocationType | description: Location type. - enum: - VIRTUAL: Online store. - PHYSICAL: Physical location, for example, POS. - name: name | type: string | description: Stores location name. - name: defaultLocation | type: boolean | description: Whether the location is the site's default location. - name: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Offset that was requested. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query Stores Locations Query Stores Locations and sort by creation date ```curl curl -X POST 'https://www.wixapis.com/stores/v3/locations/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "query": { "filter": { "name": "Main Street" } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.StoresLocationService.queryStoresLocations(query) Description: Retrieves a list of up to 100 Stores locations, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response. Query Stores Locations runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: StoresLocationQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Number of items to load. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` - name: sort | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: storesLocations | type: array | description: List of Stores locations. - name: _id | type: string | description: Stores location GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Stores location is updated. To prevent conflicting changes, the current revision must be passed when updating the Stores location. Ignored when creating a Stores location. - name: _createdDate | type: Date | description: Date and time the Stores location was created. - name: _updatedDate | type: Date | description: Date and time the Stores location was last updated. - name: wixLocationId | type: string | description: Wix location GUID. Learn more about the [Locations API](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). - name: locationType | type: LocationType | description: Location type. - enum: - VIRTUAL: Online store. - PHYSICAL: Physical location, for example, POS. - name: name | type: string | description: Stores location name. - name: defaultLocation | type: boolean | description: Whether the location is the site's default location. - name: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Offset that was requested. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query stores locations Query stores locations filtered by name ```javascript import { storesLocationsV3 } from "@wix/stores"; const options = { query: { filter: { name: "Main Street" } } }; async function queryStoresLocations() { const response = await storesLocationsV3.queryStoresLocations(options); } /* Promise resolves to: * { * "storesLocations": [ * { * "_id": "68892ef3-3715-4ce3-8a6e-0561350f8860", * "_createdDate": "2025-01-01T00:00:00.000Z", * "_updatedDate": "2025-01-01T00:00:00.000Z", * "revision": "1", * "locationType": "VIRTUAL", * "name": "Default Online Stores Location", * "defaultLocation": true * } * ], * "pagingMetadata": { "count": 1, "cursors": {}, "hasNext": false } * } */ ``` ### queryStoresLocations (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { storesLocationsV3 } from '@wix/stores'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { storesLocationsV3 }, // Include the auth strategy and host as relevant }); async function queryStoresLocations(query) { const response = await myWixClient.storesLocationsV3.queryStoresLocations(query); }; ``` ---