> 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

# Method name: archiveLocation(_id: string)

# Method package: wixBusinessToolsV2

# Method menu location: wixBusinessToolsV2 --> locations --> archiveLocation

# Method Link: https://dev.wix.com/docs/velo/apis/wix-business-tools-v2/locations/archive-location.md

# Method Description:

Archives a location.


> **Notes:**
> + Changes the `archived` boolean of a location to `true`.
> + You can't change a location's `status` using this endpoint.
> + Archived locations can't be updated.
> + Currently, it isn't possible to unarchive locations.
> + The `default` location can't be archived.



# Method Code Examples:

*** Note: do not assume any prop names or enum values other than the ones in the example.

## Archive a location (dashboard page code) 

```javascript
import { locations } from 'wix-business-tools.v2';
import { elevate } from 'wix-auth';

/* Sample _id value: '0a965e36-4071-4df0-905b-75458817430a' */

export async function myArchiveLocationFunction(_id) {
  try {
    const elevatedArchiveLocation = elevate(locations.archiveLocation);
    const archivedLocation = await elevatedArchiveLocation(_id);
    console.log('Location has been archived:', archivedLocation);

    return archivedLocation;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
 * {
 *   "_id": "0a965e36-4071-4df0-905b-75458817430a"
 *   "address": {
 *     "streetAddress": {
 *       "apt": "",
 *       "name": "New Road",
 *       "number": "12"
 *     },
 *     "city": "Kolkata",
 *     "postalCode": "70027"
 *   },
 *   "archived": true,
 *   "default": false,
 *   "description": "New store in India!",
 *   "email": "store@example.com",
 *   "name": "India Store",
 *   "phone": "0208 209 9087",
 *   "revision": "2",
 *   "status": "ACTIVE",
 *   "timeZone": "Asia/Calcutta",
 * }
 */

```

## Archive a location (export from backend code) 

```javascript
import { Permissions, webMethod } from 'wix-web-module';
import { locations } from 'wix-business-tools.v2';
import { elevate } from 'wix-auth';

/* Sample _id value: '0a965e36-4071-4df0-905b-75458817430a' */

export const myArchiveLocationFunction = webMethod(Permissions.Anyone, async (_id) => {
  try {
    const elevatedArchiveLocation = elevate(locations.archiveLocation);
    const archivedLocation = await elevatedArchiveLocation(_id);
    console.log('Location has been archived:', archivedLocation);

    return archivedLocation;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to:
 * {
 *   "_id": "0a965e36-4071-4df0-905b-75458817430a"
 *   "address": {
 *     "streetAddress": {
 *       "apt": "",
 *       "name": "New Road",
 *       "number": "12"
 *     },
 *     "city": "Kolkata",
 *     "postalCode": "70027"
 *   },
 *   "archived": true,
 *   "default": false,
 *   "description": "New store in India!",
 *   "email": "store@example.com",
 *   "name": "India Store",
 *   "phone": "0208 209 9087",
 *   "revision": "2",
 *   "status": "ACTIVE",
 *   "timeZone": "Asia/Calcutta",
 * }
 */

```

## Archive a location 

```javascript
/******************************************
 * Backend code - archive-location.web.js *
 *****************************************/

import { Permissions, webMethod } from 'wix-web-module';
import { locations } from 'wix-business-tools.v2';
import { elevate } from 'wix-auth';

export const archiveLocationById = webMethod(Permissions.Anyone, async (locationId) => {
  try {
    const elevatedArchiveLocation = elevate(locations.archiveLocation);
    const archivedLocation = await elevatedArchiveLocation(locationId);

    return archivedLocation;
  } catch (error) {
    console.error(error);
    throw new Error(error);
  }
});

export const listLocations = webMethod(Permissions.Anyone, async () => {
  try {
    const elevatedListLocations = elevate(locations.listLocations);
    const results = await elevatedListLocations();

    return results.locations;
  } catch (error) {
    console.error(error);
    throw new Error(error);
  }
});


/*************
 * Page code *
 ************/

import { archiveLocationById, listLocations } from 'backend/archive-location.web';

$w.onReady(async () => {
  await populateStoresDropdown();

  $w('#archiveLocationBtn').onClick(async () => {
    const locationId = $w('#locationsDropdown').value;
    const archivedLocation = await archiveLocationById(locationId);

    console.log('The following location has been archived', archivedLocation);
    $w('#archivedMessage').show();
  });
});

async function populateStoresDropdown() {
  const locations = await listLocations();
  const dropdownOptions = locations.map((location) => {
    return {
      label: location.name,
      value: location._id
    }
  });

  $w('#locationsDropdown').options = dropdownOptions;
}

```

---