{"id":"3e0ae80e-1786-4c5b-b4ee-0a34d3578644","createdDate":"2023-07-30T12:43:05.072Z","updatedDate":"2023-07-30T12:43:05.072Z","resourceId":"1a7dfd1e-acc2-42cb-bf24-298cbb9858c5","api":{"schema":{"object":{"displayName":"Location Object","description":"","slug":"location-object","$ref":"#/components/schemas/com.wixpress.locations.Location","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/wixos.git"},"methods":[{"summary":"List Locations","description":"Retrieves locations, given the provided filters, sorting, and paging.","operationId":"com.wixpress.locations.LocationsService.ListLocations","parameters":[{"name":"sort","in":"query","description":"Sort order.","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Sort order.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paging","in":"query","description":"Pagination.\n\nDefault values:\n`offset`: 0\n`limit`: 50 (Max: 1000)","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination.\n\nDefault values:\n`offset`: 0\n`limit`: 50 (Max: 1000)","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"includeArchived","in":"query","description":"Whether to include `archived` locations in the response.\n\nDefault: `false`","required":false,"schema":{"title":"includeArchived","description":"Whether to include `archived` locations in the response.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.ListLocationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.ListLocationsRequest","responseMessage":"com.wixpress.locations.ListLocationsResponse"},"legacyExamples":[{"name":"ListLocations","type":"METHOD","content":{"title":"List Locations","request":"curl -X GET \\\n 'https://www.wixapis.com/locations/v1/locations/' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"locations\":[\n {\n \"id\":\"3c707097-0d3c-4fd6-b5e5-b8aeb4d8ddd2\",\n \"name\":\"4th Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Brooklyn\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"4th Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"4th Avenue, Brooklyn, NY, USA\",\n \"geocode\":{\n \"latitude\":40.6490336,\n \"longitude\":-74.0097993\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"8341511b-4e89-4a6d-bbac-bac72f421c41\",\n \"name\":\"West 13th Street\",\n \"default\":true,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"owner-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10011\",\n \"streetAddress\":{\n \"number\":\"47\",\n \"name\":\"West 13th Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"47 W 13th St, New York, NY 10011, USA\",\n \"hint\":\"Near the school\",\n \"geocode\":{\n \"latitude\":40.736545,\n \"longitude\":-73.9961841\n }\n },\n \"businessSchedule\":{\n \"periods\":[],\n \"specialHourPeriod\":[]\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"f67e9ba1-a40f-4b2a-82de-5a67b2622125\",\n \"name\":\"Broadway\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Yonkers\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"Broadway\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Broadway, Yonkers, NY, USA\",\n \"geocode\":{\n \"latitude\":40.944635,\n \"longitude\":-73.8942072\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n ],\n \"pagingMetadata\": {\n \"count\":5,\n \"hasNext\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"get","path":"/v1/locations","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.ListLocationsRequest","responseMessage":"com.wixpress.locations.ListLocationsResponse"},"legacyExamples":[{"name":"ListLocations","type":"METHOD","content":{"title":"List Locations","request":"curl -X GET \\\n 'https://www.wixapis.com/locations/v1/locations/' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"locations\":[\n {\n \"id\":\"3c707097-0d3c-4fd6-b5e5-b8aeb4d8ddd2\",\n \"name\":\"4th Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Brooklyn\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"4th Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"4th Avenue, Brooklyn, NY, USA\",\n \"geocode\":{\n \"latitude\":40.6490336,\n \"longitude\":-74.0097993\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"8341511b-4e89-4a6d-bbac-bac72f421c41\",\n \"name\":\"West 13th Street\",\n \"default\":true,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"owner-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10011\",\n \"streetAddress\":{\n \"number\":\"47\",\n \"name\":\"West 13th Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"47 W 13th St, New York, NY 10011, USA\",\n \"hint\":\"Near the school\",\n \"geocode\":{\n \"latitude\":40.736545,\n \"longitude\":-73.9961841\n }\n },\n \"businessSchedule\":{\n \"periods\":[],\n \"specialHourPeriod\":[]\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"f67e9ba1-a40f-4b2a-82de-5a67b2622125\",\n \"name\":\"Broadway\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Yonkers\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"Broadway\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Broadway, Yonkers, NY, USA\",\n \"geocode\":{\n \"latitude\":40.944635,\n \"longitude\":-73.8942072\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n ],\n \"pagingMetadata\": {\n \"count\":5,\n \"hasNext\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"List Locations","slugifiedName":"list-locations"}},{"summary":"Create Location","description":"Creates a location.","operationId":"com.wixpress.locations.LocationsService.CreateLocation","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.CreateLocationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateLocationRequest","description":"","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Location to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["location","location.name","location.address","location.timeZone"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Location Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.CreateLocationRequest","responseMessage":"com.wixpress.locations.CreateLocationResponse"},"legacyExamples":[{"name":"CreateLocation","type":"METHOD","content":{"title":"Create Location","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"location\": {\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n }\n }\n }'","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v1/locations","rpcOnly":false,"triggeredEvents":[{"title":"Location Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.CreateLocationRequest","responseMessage":"com.wixpress.locations.CreateLocationResponse"},"legacyExamples":[{"name":"CreateLocation","type":"METHOD","content":{"title":"Create Location","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"location\": {\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n }\n }\n }'","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Create Location","slugifiedName":"create-location"}},{"summary":"Get Location","description":"Retrieves a location.","operationId":"com.wixpress.locations.LocationsService.GetLocation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the location to retrieve.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.GetLocationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.GetLocationRequest","responseMessage":"com.wixpress.locations.GetLocationResponse"},"legacyExamples":[{"name":"GetLocation","type":"METHOD","content":{"title":"Get Location","request":"curl -X GET \\\n 'https://www.wixapis.com/locations/v1/locations/ea50573e-35fa-47ca-bba7-3e45a935d9bc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"get","path":"/v1/locations/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.GetLocationRequest","responseMessage":"com.wixpress.locations.GetLocationResponse"},"legacyExamples":[{"name":"GetLocation","type":"METHOD","content":{"title":"Get Location","request":"curl -X GET \\\n 'https://www.wixapis.com/locations/v1/locations/ea50573e-35fa-47ca-bba7-3e45a935d9bc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Get Location","slugifiedName":"get-location"}},{"summary":"Update Location","description":"Replaces a location.\n\n\n> **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.","operationId":"com.wixpress.locations.LocationsService.UpdateLocation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"location.id","description":"Location ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.UpdateLocationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateLocationRequest","description":"","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Location to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["location","location.id","location.name","location.address","location.timeZone"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Location Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_ARCHIVE_DEFAULT"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"LOCATION_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.UpdateLocationRequest","responseMessage":"com.wixpress.locations.UpdateLocationResponse"},"legacyExamples":[{"name":"UpdateLocation","type":"METHOD","content":{"title":"Update Location","request":"curl -X PUT \\\n 'https://www.wixapis.com/locations/v1/locations/ea50573e-35fa-47ca-bba7-3e45a935d9bc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"New Location Name\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"4\",\n \"archived\":false\n }\n }'","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"New Location Name\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"5\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"put","path":"/v1/locations/{location.id}","rpcOnly":false,"triggeredEvents":[{"title":"Location Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_ARCHIVE_DEFAULT"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"LOCATION_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.UpdateLocationRequest","responseMessage":"com.wixpress.locations.UpdateLocationResponse"},"legacyExamples":[{"name":"UpdateLocation","type":"METHOD","content":{"title":"Update Location","request":"curl -X PUT \\\n 'https://www.wixapis.com/locations/v1/locations/ea50573e-35fa-47ca-bba7-3e45a935d9bc' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"New Location Name\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"4\",\n \"archived\":false\n }\n }'","response":"{\n \"location\": {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"New Location Name\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/Los_Angeles\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"5\",\n \"archived\":false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update Location","slugifiedName":"update-location"}},{"summary":"Query Locations","description":"Retrieves locations, given the provided filters, sorting, and paging.","operationId":"com.wixpress.locations.LocationsService.QueryLocations","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.QueryLocationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryLocationsRequest","description":"","properties":{"query":{"$ref":"#/components/schemas/wix.common.Query","summary":"query","description":"Information about the filters, sorting, and paging.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.QueryLocationsRequest","responseMessage":"com.wixpress.locations.QueryLocationsResponse"},"legacyExamples":[{"name":"QueryLocations","type":"METHOD","content":{"title":"Query Locations","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"archived\": false\n },\n \"sort\":[{\"fieldName\":\"name\",\"order\":\"ASC\"}]\n }\n }'","response":"{\n \"locations\":[\n {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"3c707097-0d3c-4fd6-b5e5-b8aeb4d8ddd2\",\n \"name\":\"4th Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Brooklyn\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"4th Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"4th Avenue, Brooklyn, NY, USA\",\n \"geocode\":{\n \"latitude\":40.6490336,\n \"longitude\":-74.0097993\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"f67e9ba1-a40f-4b2a-82de-5a67b2622125\",\n \"name\":\"Broadway\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Yonkers\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"Broadway\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Broadway, Yonkers, NY, USA\",\n \"geocode\":{\n \"latitude\":40.944635,\n \"longitude\":-73.8942072\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"8341511b-4e89-4a6d-bbac-bac72f421c41\",\n \"name\":\"West 13th Street\",\n \"default\":true,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"owner-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10011\",\n \"streetAddress\":{\n \"number\":\"47\",\n \"name\":\"West 13th Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"47 W 13th St, New York, NY 10011, USA\",\n \"hint\":\"Near the school\",\n \"geocode\":{\n \"latitude\":40.736545,\n \"longitude\":-73.9961841\n }\n },\n \"businessSchedule\":{\n \"periods\":["}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v1/locations/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.locations.LocationsService","errors":[],"exposure":"PUBLIC","permissions":["LOCATIONS.READ"],"externalPermissionScopes":[{"name":"Read bookings calendar - including participants","scopeId":"SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS"},{"name":"Read Locations","scopeId":"SCOPE.DC-MULTILOCATION.READ-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.QueryLocationsRequest","responseMessage":"com.wixpress.locations.QueryLocationsResponse"},"legacyExamples":[{"name":"QueryLocations","type":"METHOD","content":{"title":"Query Locations","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"archived\": false\n },\n \"sort\":[{\"fieldName\":\"name\",\"order\":\"ASC\"}]\n }\n }'","response":"{\n \"locations\":[\n {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"2\",\n \"archived\":false\n },\n {\n \"id\":\"3c707097-0d3c-4fd6-b5e5-b8aeb4d8ddd2\",\n \"name\":\"4th Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Brooklyn\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"4th Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"4th Avenue, Brooklyn, NY, USA\",\n \"geocode\":{\n \"latitude\":40.6490336,\n \"longitude\":-74.0097993\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"f67e9ba1-a40f-4b2a-82de-5a67b2622125\",\n \"name\":\"Broadway\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"Yonkers\",\n \"streetAddress\":{\n \"number\":\"\",\n \"name\":\"Broadway\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Broadway, Yonkers, NY, USA\",\n \"geocode\":{\n \"latitude\":40.944635,\n \"longitude\":-73.8942072\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"ea50573e-35fa-47ca-bba7-3e45a935d9bc\",\n \"name\":\"South Figueroa Street\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"timeZone\":\"America/New_York\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"CA\",\n \"city\":\"Los Angeles\",\n \"postalCode\":\"90015\",\n \"streetAddress\":{\n \"number\":\"1111\",\n \"name\":\"South Figueroa Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"STAPLES Center, South Figueroa Street, Los Angeles, CA, USA\",\n \"geocode\":{\n \"latitude\":34.0430175,\n \"longitude\":-118.2672541\n }\n },\n \"revision\":\"1\",\n \"archived\":false\n },\n {\n \"id\":\"8341511b-4e89-4a6d-bbac-bac72f421c41\",\n \"name\":\"West 13th Street\",\n \"default\":true,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"owner-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10011\",\n \"streetAddress\":{\n \"number\":\"47\",\n \"name\":\"West 13th Street\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"47 W 13th St, New York, NY 10011, USA\",\n \"hint\":\"Near the school\",\n \"geocode\":{\n \"latitude\":40.736545,\n \"longitude\":-73.9961841\n }\n },\n \"businessSchedule\":{\n \"periods\":["}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Query Locations","slugifiedName":"query-locations"}},{"summary":"Archive Location","description":"Archives a location.\n\n\n> **Notes:**\n> + Changes the `archived` boolean of a location to `true`.\n> + You can't change a location's `status` using this endpoint.\n> + Archived locations can't be updated.\n> + Currently, it isn't possible to unarchive locations.\n> + The `default` location can't be archived.","operationId":"com.wixpress.locations.LocationsService.ArchiveLocation","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the location to archive.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.locations.ArchiveLocationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/locations/v1/locations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/locations/v1/locations","destinationPath":"/v1/locations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ArchiveLocationRequest","description":"","properties":{},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Location Archive Status","description":"","permissions":[],"payload":{"schemaName":"com.wixpress.locations.ArchiveLocation"},"exposure":"PUBLIC","maturity":"BETA","slug":"archive_status","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_ARCHIVE_DEFAULT"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.ArchiveLocationRequest","responseMessage":"com.wixpress.locations.ArchiveLocationResponse"},"legacyExamples":[{"name":"ArchiveLocation","type":"METHOD","content":{"title":"Archive Location","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations/97dc43b5-521b-48e9-8710-a3543f00f0ca/archive' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{}'","response":"{\n \"location\": {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"3\",\n \"archived\":true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v1/locations/{id}/archive","rpcOnly":false,"triggeredEvents":[{"title":"Location Archive Status","description":"","permissions":[],"payload":{"schemaName":"com.wixpress.locations.ArchiveLocation"},"exposure":"PUBLIC","maturity":"BETA","slug":"archive_status","eventTopic":"domain_events_wix.locations.v1.location","serviceName":"com.wixpress.locations.LocationsService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"com.wixpress.locations.LocationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_ARCHIVE_DEFAULT"}],"exposure":"PUBLIC","permissions":["LOCATIONS.MANAGE"],"externalPermissionScopes":[{"name":"Manage Locations","scopeId":"SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS"}],"protoArtifactId":"com.wixpress.wixos:locations-web","serviceArtifactId":"com.wixpress.wixos.locations-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.locations.ArchiveLocationRequest","responseMessage":"com.wixpress.locations.ArchiveLocationResponse"},"legacyExamples":[{"name":"ArchiveLocation","type":"METHOD","content":{"title":"Archive Location","request":"curl -X POST \\\n 'https://www.wixapis.com/locations/v1/locations/97dc43b5-521b-48e9-8710-a3543f00f0ca/archive' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{}'","response":"{\n \"location\": {\n \"id\":\"97dc43b5-521b-48e9-8710-a3543f00f0ca\",\n \"name\":\"3rd Avenue\",\n \"default\":false,\n \"status\":\"ACTIVE\",\n \"locationType\":\"UNKNOWN\",\n \"fax\":\"1800-555-XXX\",\n \"timeZone\":\"America/New_York\",\n \"email\":\"employee-email@domain.com\",\n \"phone\":\"1800-555-XXX\",\n \"address\":{\n \"country\":\"US\",\n \"subdivision\":\"NY\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"33\",\n \"name\":\"3rd Avenue\",\n \"apt\":\"\"\n },\n \"formattedAddress\":\"Alumni Hall, 33 3rd Ave, New York, NY 10003, USA\",\n \"geocode\":{\n \"latitude\":40.7302968,\n \"longitude\":-73.98899449999999\n }\n },\n \"revision\":\"3\",\n \"archived\":true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Archive Location","slugifiedName":"archive-location"}}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Locations API\n\n\n\nWith Locations, site owners can define multiple physical locations for their business. This allows them to set individual opening hours for each location.\n\nThe Locations API allows your app to:\n\n* List existing locations\n* Create, update, and archive locations\n* Set a default location that is reflected in the site properties\n\nRead more about how site owners can manage their [location specific bookings](https://support.wix.com/en/article/wix-bookings-offering-services-at-multiple-locations). You can also read more about how to retrieve the [site properties](https://dev.wix.com/api/rest/business-info/site-properties/properties/get-site-properties).\n\n\n## Terminology\n\n\n+ **Default location:** Location reflected in the [site properties](https://dev.wix.com/api/rest/business-info/site-properties/introduction). This location is used on invoices.\n+ **Type:** Describes whether a location is an office, reception, branch or the headquarters.\n+ **Status:** Indicates whether a location is `ACTIVE` or `INACTIVE`.\n+ **Business Schedule:** Describes the location's regular and exceptional opening hours.\n - **Period:** Regular, weekly recurring opening hours of the location.\n - **Special Hour Period:** Exception to the location's regular hours. The location can be either open or closed during the **Special Hour Period**.\n\n\n## Limitations\n\n+ The [Wix Bookings API](https://dev.wix.com/api/rest/wix-bookings/about-wix-bookings) doesn't support the `businessSchedule` object.\n+ You can't delete a location. Instead, you can archive a location using the [Archive Location](https://dev.wix.com/api/rest/business-info/locations/archive-location) endpoint.\n+ You can't archive the default location.\n+ Archived locations can't be unarchived.\n+ The [Update Location](https://dev.wix.com/api/rest/business-info/locations/update-location) endpoint replaces a location. Currently, you can't partially update a location.\n+ Currently, the location type is just informational and doesn't affect a location's functionality.\n+ The status `INACTIVE` isn't currently supported.\n\n","sourceRepo":"git@github.com:wix-private/wixos.git","path":"proto/docs/README-External.md"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Sample use cases & flows: Locations\n\n\nThis article shares a possible use case for your app, as well as an example flow that supports it.\nYou're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n\n## Set Up a New Main Business Location\n\n\nYour app can help the site owners create a new business location, set it as default, and update the opening hours for a location.\n\n\n1. Call the [Create Location](https://dev.wix.com/api/rest/business-info/locations/create-location) endpoint.\n\n2. Set the new location as **default** via the [Set Default Location](https://dev.wix.com/api/rest/business-info/locations/set-default-location) endpoint.\n\n3. List all existing locations by calling the [List Locations](https://dev.wix.com/api/rest/business-info/locations/list-locations) endpoint.\n\n > **Note:** Make sure to extract the relevant locations’ IDs from the response and save it for future calls.\n\n\n4. Update a location's opening hours via the [Update Location](https://dev.wix.com/api/rest/business-info/locations/update-location) endpoint.\n\n > **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.","sourceRepo":"git@github.com:wix-private/wixos.git","path":"proto/docs/flow.md"}],"components":{"schemas":{"com.wixpress.locations.Location":{"type":"object","properties":{"id":{"title":"id","description":"Location ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Location name.","maxLength":150,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Location description.","maxLength":500,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"default":{"title":"default","description":"Whether this is the default location. There can only be one default location per site. The default location can't be archived.","readOnly":true,"type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Location status. Defaults to `ACTIVE`.\n__Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\ndoesn't affect the location's status. `INACTIVE` is currently not supported.","type":"string","$ref":"#/components/schemas/com.wixpress.locations.LocationStatus","x-wix-docs":{"exposure":"PUBLIC"}},"locationType":{"title":"locationType","description":"Location type.\n\n**Note:** Currently not supported.","type":"string","$ref":"#/components/schemas/com.wixpress.locations.LocationType","x-wix-docs":{"exposure":"PUBLIC"}},"fax":{"title":"fax","description":"Fax number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"timeZone":{"title":"timeZone","description":"Timezone in `America/New_York` format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Email address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Phone number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"address":{"$ref":"#/components/schemas/com.wixpress.locations.Address","summary":"address","description":"Address.","x-wix-docs":{"exposure":"PUBLIC"}},"businessSchedule":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","description":"Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n\n__Note:__ Not supported by Wix Bookings.","x-wix-docs":{"exposure":"PUBLIC"}},"revision":{"title":"revision","description":"Revision number, which increments by 1 each time the location is updated.\nTo prevent conflicting changes, the existing revision must be used when updating a location.","$ref":"#/components/schemas/google.protobuf.Int64Value","x-wix-docs":{"exposure":"PUBLIC"}},"archived":{"title":"archived","description":"Whether the location is archived. Archived locations can't be updated.\n__Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\ndoesn't affect its `status`.","readOnly":true,"type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Location","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.locations.LocationStatus":{"type":"string","description":"For future use","title":"LocationStatus","enum":["ACTIVE","INACTIVE"]},"com.wixpress.locations.LocationType":{"type":"string","description":"For future use","title":"LocationType","enum":["UNKNOWN","BRANCH","OFFICES","RECEPTION","HEADQUARTERS"]},"com.wixpress.locations.Address":{"type":"object","properties":{"country":{"title":"country","description":"2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","format":"COUNTRY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"title":"subdivision","description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"title":"city","description":"City name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"postalCode":{"title":"postalCode","description":"Postal or zip code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"streetAddress":{"$ref":"#/components/schemas/com.wixpress.locations.StreetAddress","summary":"streetAddress","description":"Street address. Includes street name, number, and apartment number in separate fields.","x-wix-docs":{"exposure":"PUBLIC"}},"formattedAddress":{"title":"formattedAddress","description":"Full address of the location.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"hint":{"title":"hint","description":"Extra information that helps finding the location.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"geocode":{"$ref":"#/components/schemas/com.wixpress.locations.AddressLocation","summary":"geocode","description":"Geographic coordinates of location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":""},"com.wixpress.locations.StreetAddress":{"type":"object","properties":{"number":{"title":"number","description":"Street number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Street name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"apt":{"title":"apt","description":"Apartment number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StreetAddress","description":"Street address. Includes street name, number, and apartment number in separate fields."},"com.wixpress.locations.AddressLocation":{"type":"object","properties":{"latitude":{"title":"latitude","description":"Latitude of the location. Must be between -90 and 90.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"title":"longitude","description":"Longitude of the location. Must be between -180 and 180.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressLocation","description":"Address Geolocation"},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DoubleValue","description":""},"com.wixpress.siteproperties.api.v4.BusinessSchedule":{"type":"object","properties":{"periods":{"title":"periods","description":"Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.TimePeriod"},"x-wix-docs":{"exposure":"PUBLIC"}},"specialHourPeriod":{"title":"specialHourPeriod","description":"Exceptions to the business's regular hours. The business can be open or closed during the exception.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SpecialHourPeriod"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BusinessSchedule","description":"Business schedule. Regular and exceptional time periods when the business is open or the service is available."},"com.wixpress.siteproperties.api.v4.TimePeriod":{"type":"object","properties":{"openDay":{"title":"openDay","description":"Day of the week the period starts on.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC"}},"openTime":{"title":"openTime","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\nmidnight at the end of the specified day.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"closeDay":{"title":"closeDay","description":"Day of the week the period ends on.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC"}},"closeTime":{"title":"closeTime","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\nmidnight at the end of the specified day.\n\n__Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TimePeriod","description":"Weekly recurring time periods when the business is regularly open or the service is available."},"com.wixpress.siteproperties.api.v4.DayOfWeek":{"type":"string","description":"Enumerates the days of the week.","title":"DayOfWeek","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"com.wixpress.siteproperties.api.v4.SpecialHourPeriod":{"type":"object","properties":{"startDate":{"title":"startDate","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).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"title":"endDate","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).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"isClosed":{"title":"isClosed","description":"Whether the business is closed (or the service is not available) during the exception.\n\nDefault: `true`.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"comment":{"title":"comment","description":"Additional info about the exception. For example, \"We close earlier on New Year's Eve.\"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SpecialHourPeriod","description":"Exception to the business's regular hours. The business can be open or closed during the exception."},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""},"com.wixpress.locations.CreateLocationRequest":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Location to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateLocationRequest","description":""},"com.wixpress.locations.CreateLocationResponse":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Created location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateLocationResponse","description":""},"com.wixpress.locations.BulkCreateLocationRequest":{"type":"object","properties":{"locations":{"title":"locations","description":"Locations to create.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateLocationRequest","description":""},"com.wixpress.locations.BulkCreateLocationResponse":{"type":"object","properties":{"successfulLocations":{"title":"successfulLocations","description":"Locations that were created.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}},"failedLocations":{"title":"failedLocations","description":"Locations that failed.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.FailedCreateLocation"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateLocationResponse","description":""},"com.wixpress.locations.FailedCreateLocation":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Location that couldn't be created.","x-wix-docs":{"exposure":"PUBLIC"}},"errorMessage":{"title":"errorMessage","description":"Error message.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FailedCreateLocation","description":""},"com.wixpress.locations.GetLocationRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the location to retrieve.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLocationRequest","description":""},"com.wixpress.locations.GetLocationResponse":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Retrieved location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLocationResponse","description":""},"com.wixpress.locations.ListLocationsRequest":{"type":"object","properties":{"sort":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Sort order.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination.\n\nDefault values:\n`offset`: 0\n`limit`: 50 (Max: 1000)","x-wix-docs":{"exposure":"PUBLIC"}},"includeArchived":{"title":"includeArchived","description":"Whether to include `archived` locations in the response.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLocationsRequest","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.locations.ListLocationsResponse":{"type":"object","properties":{"locations":{"title":"locations","description":"Retrieved locations.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/com.wixpress.locations.PagingMetadata","summary":"pagingMetadata","description":"Paging info.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLocationsResponse","description":""},"com.wixpress.locations.PagingMetadata":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"hasNext":{"title":"hasNext","description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadata","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.locations.UpdateLocationRequest":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Location to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateLocationRequest","description":""},"com.wixpress.locations.UpdateLocationResponse":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Updated location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateLocationResponse","description":""},"com.wixpress.locations.BulkUpdateLocationRequest":{"type":"object","properties":{"locations":{"title":"locations","description":"Locations to update.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkUpdateLocationRequest","description":""},"com.wixpress.locations.BulkUpdateLocationResponse":{"type":"object","properties":{"successfulLocations":{"title":"successfulLocations","description":"Locations that were updated.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}},"failedLocations":{"title":"failedLocations","description":"Locations that failed.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.FailedUpdateLocation"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkUpdateLocationResponse","description":""},"com.wixpress.locations.FailedUpdateLocation":{"type":"object","properties":{"id":{"title":"id","description":"Location that couldn't be updated.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"errorMessage":{"title":"errorMessage","description":"Error message.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FailedUpdateLocation","description":""},"com.wixpress.locations.QueryLocationsRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/wix.common.Query","summary":"query","description":"Information about the filters, sorting, and paging.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryLocationsRequest","description":""},"wix.common.Query":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging options to limit and skip the number of items.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"fieldsets":{"title":"fieldsets","description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Query","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"com.wixpress.locations.QueryLocationsResponse":{"type":"object","properties":{"locations":{"title":"locations","description":"Retrieved locations.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.locations.Location"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/com.wixpress.locations.PagingMetadata","summary":"pagingMetadata","description":"Paging info.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryLocationsResponse","description":""},"com.wixpress.locations.SetDefaultLocationRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the location to set as the default location.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetDefaultLocationRequest","description":""},"com.wixpress.locations.SetDefaultLocationResponse":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"New default location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetDefaultLocationResponse","description":""},"com.wixpress.locations.SetDefaultLocation":{"type":"object","properties":{"prevDefaultLocationId":{"title":"prevDefaultLocationId","description":"Previous default location id.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currDefaultLocationId":{"title":"currDefaultLocationId","description":"Current default location id.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetDefaultLocation","description":""},"com.wixpress.locations.ArchiveLocationRequest":{"type":"object","properties":{"id":{"title":"id","description":"ID of the location to archive.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchiveLocationRequest","description":""},"com.wixpress.locations.ArchiveLocationResponse":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/com.wixpress.locations.Location","summary":"location","description":"Archived location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchiveLocationResponse","description":""},"com.wixpress.locations.ArchiveLocation":{"type":"object","properties":{"id":{"title":"id","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchiveLocation","description":""}}},"title":"Location","description":"","fqdn":"wix.locations.v1.location"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Locations API\n\n\n\nWith Locations, site owners can define multiple physical locations for their business. This allows them to set individual opening hours for each location.\n\nThe Locations API allows your app to:\n\n* List existing locations\n* Create, update, and archive locations\n* Set a default location that is reflected in the site properties\n\nRead more about how site owners can manage their [location specific bookings](https://support.wix.com/en/article/wix-bookings-offering-services-at-multiple-locations). You can also read more about how to retrieve the [site properties](https://dev.wix.com/api/rest/business-info/site-properties/properties/get-site-properties).\n\n\n## Terminology\n\n\n+ **Default location:** Location reflected in the [site properties](https://dev.wix.com/api/rest/business-info/site-properties/introduction). This location is used on invoices.\n+ **Type:** Describes whether a location is an office, reception, branch or the headquarters.\n+ **Status:** Indicates whether a location is `ACTIVE` or `INACTIVE`.\n+ **Business Schedule:** Describes the location's regular and exceptional opening hours.\n - **Period:** Regular, weekly recurring opening hours of the location.\n - **Special Hour Period:** Exception to the location's regular hours. The location can be either open or closed during the **Special Hour Period**.\n\n\n## Limitations\n\n+ The [Wix Bookings API](https://dev.wix.com/api/rest/wix-bookings/about-wix-bookings) doesn't support the `businessSchedule` object.\n+ You can't delete a location. Instead, you can archive a location using the [Archive Location](https://dev.wix.com/api/rest/business-info/locations/archive-location) endpoint.\n+ You can't archive the default location.\n+ Archived locations can't be unarchived.\n+ The [Update Location](https://dev.wix.com/api/rest/business-info/locations/update-location) endpoint replaces a location. Currently, you can't partially update a location.\n+ Currently, the location type is just informational and doesn't affect a location's functionality.\n+ The status `INACTIVE` isn't currently supported.\n\n"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Sample use cases & flows: Locations\n\n\nThis article shares a possible use case for your app, as well as an example flow that supports it.\nYou're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n\n## Set Up a New Main Business Location\n\n\nYour app can help the site owners create a new business location, set it as default, and update the opening hours for a location.\n\n\n1. Call the [Create Location](https://dev.wix.com/api/rest/business-info/locations/create-location) endpoint.\n\n2. Set the new location as **default** via the [Set Default Location](https://dev.wix.com/api/rest/business-info/locations/set-default-location) endpoint.\n\n3. List all existing locations by calling the [List Locations](https://dev.wix.com/api/rest/business-info/locations/list-locations) endpoint.\n\n > **Note:** Make sure to extract the relevant locations’ IDs from the response and save it for future calls.\n\n\n4. Update a location's opening hours via the [Update Location](https://dev.wix.com/api/rest/business-info/locations/update-location) endpoint.\n\n > **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call."}]},"reviewStatus":"APPROVED","isLocked":true}

Create Location

Permission Scopes