> 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

# ArchiveLocation

# Package: locations

# Namespace: LocationsService

# Method link: https://dev.wix.com/docs/api-reference/business-management/locations/archive-location.md

## Permission Scopes:
Manage Locations: SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS

## Introduction

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.
> + The `default` location can't be archived.

---

## REST API

### Schema

```
 Method: archiveLocation
 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. > + The `default` location can't be archived.
 URL: https://www.wixapis.com/locations/v1/locations/{id}/archive
 Method: POST
 Return type: ArchiveLocationResponse
  - name: location | type: Location | description: Archived location. 
     - name: id | type: string | description: Location GUID. 
     - name: name | type: string | description: Location name. 
     - name: description | type: string | description: Location description. 
     - name: default | type: boolean | description: Whether this is the default location. There can only be one default location per site. The default location can't be archived. 
     - name: status | type: LocationStatus | description: Location status. Defaults to `ACTIVE`. __Notes:__ - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location) doesn't affect the location's status. - `INACTIVE` status is currently not supported. 
         - enum: ACTIVE, INACTIVE
     - name: fax | type: string | description: Fax number. 
     - name: timeZone | type: string | description: Timezone in `America/New_York` format. 
     - name: email | type: string | description: Email address. 
     - name: phone | type: string | description: Phone number. 
     - name: address | type: Address | description: Address. 
        - name: country | type: string | description: 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. 
        - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. 
        - name: city | type: string | description: City name. 
        - name: postalCode | type: string | description: Postal or zip code. 
        - name: streetAddress | type: StreetAddress | description: Street address. Includes street name, number, and apartment number in separate fields. 
           - name: number | type: string | description: Street number. 
           - name: name | type: string | description: Street name. 
           - name: apt | type: string | description: Apartment number. 
        - name: formattedAddress | type: string | description: Full address of the location. 
        - name: hint | type: string | description: Extra information that helps finding the location. 
        - name: geocode | type: AddressLocation | description: Geographic coordinates of location. 
           - name: latitude | type: number | description: Latitude of the location. Must be between -90 and 90. 
           - name: longitude | type: number | description: Longitude of the location. Must be between -180 and 180. 
     - name: businessSchedule | type: BusinessSchedule | description: Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.  __Note:__ Not supported by Wix Bookings. 
        - name: periods | type: array<TimePeriod> | description: Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. 
           - name: openDay | type: DayOfWeek | description: Day of the week the period starts on. 
                 - enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
           - name: openTime | type: string | description: Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents midnight at the end of the specified day. 
           - name: closeDay | type: DayOfWeek | description: Day of the week the period ends on. 
           - name: closeTime | type: string | description: Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents midnight at the end of the specified day.  __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`. 
        - name: specialHourPeriod | type: array<SpecialHourPeriod> | description: Exceptions to the business's regular hours. The business can be open or closed during the exception. 
           - name: startDate | type: string | description: Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). 
           - name: endDate | type: string | description: End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). 
           - name: isClosed | type: boolean | description: Whether the business is closed (or the service is not available) during the exception.  Default: `true`. 
           - name: comment | type: string | description: Additional info about the exception. For example, "We close earlier on New Year's Eve." 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the location is updated. To prevent conflicting changes, the existing revision must be used when updating a location. 
     - name: archived | type: boolean | description: Whether the location is archived. Archived locations can't be updated. __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location) doesn't affect its `status`. 
     - name: locationTypes | type: array<LocationType> | description: Location types. 
         - enum: UNKNOWN, BRANCH, OFFICES, RECEPTION, HEADQUARTERS, INVENTORY
     - name: extendedFields | type: ExtendedFields | description: Extended fields for data extensions. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: CANNOT_ARCHIVE_DEFAULT | Description: Can't archive the default location.


```

### Examples

### Archive Location
```curl
curl -X POST \
  'https://www.wixapis.com/locations/v1/locations/97dc43b5-521b-48e9-8710-a3543f00f0ca/archive' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>' \
  --data-binary '{}'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.locations.LocationsService.archiveLocation(_id)
 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. > + The `default` location can't be archived.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  _id
 Method parameters: 
   param name: _id | type: string | description: GUID of the location to archive. | required: true
 Return type: PROMISE<ArchiveLocationResponse>
  - name: location | type: Location | description: Archived location. 
     - name: _id | type: string | description: Location GUID. 
     - name: name | type: string | description: Location name. 
     - name: description | type: string | description: Location description. 
     - name: default | type: boolean | description: Whether this is the default location. There can only be one default location per site. The default location can't be archived. 
     - name: status | type: LocationStatus | description: Location status. Defaults to `ACTIVE`. __Notes:__ - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location) doesn't affect the location's status. - `INACTIVE` status is currently not supported. 
         - enum: ACTIVE, INACTIVE
     - name: fax | type: string | description: Fax number. 
     - name: timeZone | type: string | description: Timezone in `America/New_York` format. 
     - name: email | type: string | description: Email address. 
     - name: phone | type: string | description: Phone number. 
     - name: address | type: Address | description: Address. 
        - name: streetAddress | type: StreetAddress | description: none 
           - name: name | type: string | description: none 
           - name: number | type: string | description: none 
        - name: city | type: string | description: none 
        - name: subdivision | type: string | description: none 
        - name: country | type: string | description: none 
        - name: postalCode | type: string | description: none 
     - name: businessSchedule | type: BusinessSchedule | description: Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.  __Note:__ Not supported by Wix Bookings. 
        - name: periods | type: array<TimePeriod> | description: Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. 
           - name: openDay | type: DayOfWeek | description: Day of the week the period starts on. 
                 - enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
           - name: openTime | type: string | description: Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents midnight at the end of the specified day. 
           - name: closeDay | type: DayOfWeek | description: Day of the week the period ends on. 
           - name: closeTime | type: string | description: Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents midnight at the end of the specified day.  __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`. 
        - name: specialHourPeriod | type: array<SpecialHourPeriod> | description: Exceptions to the business's regular hours. The business can be open or closed during the exception. 
           - name: startDate | type: string | description: Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). 
           - name: endDate | type: string | description: End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). 
           - name: isClosed | type: boolean | description: Whether the business is closed (or the service is not available) during the exception.  Default: `true`. 
           - name: comment | type: string | description: Additional info about the exception. For example, "We close earlier on New Year's Eve." 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the location is updated. To prevent conflicting changes, the existing revision must be used when updating a location. 
     - name: archived | type: boolean | description: Whether the location is archived. Archived locations can't be updated. __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location) doesn't affect its `status`. 
     - name: locationTypes | type: array<LocationType> | description: Location types. 
         - enum: UNKNOWN, BRANCH, OFFICES, RECEPTION, HEADQUARTERS, INVENTORY
     - name: extendedFields | type: ExtendedFields | description: Extended fields for data extensions. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: CANNOT_ARCHIVE_DEFAULT | Description: Can't archive the default location.


```

### Examples

### Archive a location (with elevated permissions)
```javascript
import { locations } from '@wix/business-tools';
import { auth } from '@wix/essentials';

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

export async function myArchiveLocationFunction(_id) {
  try {
    const elevatedArchiveLocation = auth.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
import { locations } from '@wix/business-tools';

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

export async function myArchiveLocationFunction(_id) {
  try {
    const archivedLocation = await locations.archiveLocation(_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",
 * }
 */
```

### archiveLocation (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 { locations } from '@wix/business-tools';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { locations },
  // Include the auth strategy and host as relevant
});


async function archiveLocation(_id) {
  const response = await myWixClient.locations.archiveLocation(_id);
};
```

---