createLocation( )


Creates a location.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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"; /* 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 newLocation = await locations.createLocation(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?