createLocation( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a location.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Locations
Learn more about app permissions.
Method Declaration
Copy
function createLocation(location: Location): Promise<Location>;
Method Parameters
locationLocationRequired

Location to create.

Returns
Return Type:Promise<Location>
JavaScript
import { locations } from "wix-business-tools.v2"; import { elevate } from "wix-auth"; /* Sample location value: * { * address: { * formatted: '12 5th Street, New York' * }, * name: 'New York Store', * timeZone: 'America/New_York' * } */ export async function myCreateLocationFunction(location) { try { const elevatedCreateLocation = elevate(locations.createLocation); const newLocation = await elevatedCreateLocation(location); console.log("Created new location:", newLocation); return newLocation; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to: * { * "_id": "125e9107-2d4b-4790-bb49-37e7983ff9b1", * "address": { * "formatted": "12 5th Street, New York" * }, * "archived": false, * "default": false, * "name": "New York Store", * "revision": "1", * "status": "ACTIVE", * "timeZone": "America/New_York" * } */
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?