Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Retrieves site properties


The `getSiteProperties()` function returns a promise that resolves to the site properties.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getSiteProperties(options) {
  const response = await wixClient.siteProperties.getSiteProperties(options);
}

getSiteProperties() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function getSiteProperties(options) {
  const response = await wixClient.siteProperties.getSiteProperties(options);
}

getSiteProperties() with Dashboard app access

getSiteProperties

PropertiesReadResponse

The resulting properties for the requested site.

businessContact

BusinessContactData

Updates a site's business contact information.


The `updateBusinessContact()` function returns a Promise that resolves when the site's contact information is updated.

**Note:**
> + Only the fields included in the `fields` parameter will be updated, even if they are included in the `businessContact` parameter.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateBusinessContact(businessContact, options) {
  const response = await wixClient.siteProperties.updateBusinessContact(businessContact, options);
}

updateBusinessContact() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateBusinessContact(businessContact, options) {
  const response = await wixClient.siteProperties.updateBusinessContact(businessContact, options);
}

updateBusinessContact() with Dashboard app access

updateBusinessContact

void

businessProfile

BusinessProfileData

Updates a site's business profile information.


The `updateBusinessProfile()` function returns a Promise that resolves when the site's business profile information is updated.

**Note:**
> + Only the fields included in the `fields` parameter are updated, even if they are included in the `businessProfile` parameter.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateBusinessProfile(businessProfile, options) {
  const response = await wixClient.siteProperties.updateBusinessProfile(businessProfile, options);
}

updateBusinessProfile() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateBusinessProfile(businessProfile, options) {
  const response = await wixClient.siteProperties.updateBusinessProfile(businessProfile, options);
}

updateBusinessProfile() with Dashboard app access

updateBusinessProfile

The site's business schedule in the site time zone.

businessSchedule

BusinessSchedule

Updates the default location's business schedule.


The `updateBusinessSchedule()` function returns a Promise that resolves when the site's business schedule is updated.

**Note:**
> + The `updateBusinessSchedule()` function overwrites the current business schedule. `businessSchedule` is an array, so it must be written in its entirety. Therefore, you must modify the existing array and pass it in the function call.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateBusinessSchedule(businessSchedule) {
  const response = await wixClient.siteProperties.updateBusinessSchedule(businessSchedule);
}

updateBusinessSchedule() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateBusinessSchedule(businessSchedule) {
  const response = await wixClient.siteProperties.updateBusinessSchedule(businessSchedule);
}

updateBusinessSchedule() with Dashboard app access

updateBusinessSchedule

Default consent policy defined by the site owner. Can be further limited by site visitors.

consentPolicy

ConsentPolicy

Updates a site's consent policy.


The `updateConsentPolicy()` function returns a Promise that resolves when the site's consent policy is updated.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateConsentPolicy(consentPolicy) {
  const response = await wixClient.siteProperties.updateConsentPolicy(consentPolicy);
}

updateConsentPolicy() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  modules: { siteProperties },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateConsentPolicy(consentPolicy) {
  const response = await wixClient.siteProperties.updateConsentPolicy(consentPolicy);
}

updateConsentPolicy() with Dashboard app access

updateConsentPolicy

To use the SiteProperties API, install the `@wix/business-tools` package using npm or Yarn:
  ```console
npm install @wix/business-tools
```

or

```console
yarn add @wix/business-tools
```

Then import `{ siteProperties }` from `@wix/business-tools`:

```js
import { siteProperties } from '@wix/business-tools'
```
  

business-tools_site-properties

Address

apartmentNumber

string

city

coordinates

GeoCoordinates

Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

country

Google-formatted version of this address.

googleFormattedAddress

Extra information to be displayed in the address.

hint

AddressHint

Whether this address represents a physical location.

isPhysical

boolean

state

street

streetNumber

Where the extra text should be displayed.

placement

PlacementType

Extra text displayed next to, or instead of, the actual address.

text

BaseEventMetadata

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

address

Publicly-available business email address.

email

Publicly-available business phone number.

phone

businessName

description

Path to the site's logo in Wix Media (without Wix Media base URL).

logo

siteDisplayName

Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.

periods

Exceptions to the business's regular hours. The business can be open or closed during the exception.

specialHourPeriod

Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor.

advertising

Whether the site uses cookies that collect analytics about how the site is used (in order to improve it).

analytics

dataToThirdParty

Whether the site uses cookies that are essential to site operation.

essential

Whether the site uses cookies that affect site performance and other functional measurements.

functional

DayOfWeek

Latitude of the location. Must be between -90 and 90.

latitude

number

Longitude of the location. Must be between -180 and 180.

longitude

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

Multilingual

autoRedirect

supportedLanguages

OnPropertiesSitePropertiesUpdatedHandler

event

PropertiesSitePropertiesUpdatedEnvelope

Properties

Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.

Site business type.

businessConfig

Business schedule. Regular and exceptional time periods when the business is open or the service is available.

__Note:__ Not supported by Wix Bookings.

externalSiteUrl

Site language.

Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

language

locale

Locale

Supported languages of a site and the primary language.

multilingual

Site currency format used to bill customers.

Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.

paymentCurrency

timeZone

trackClicksAnalytics

properties

Current version of the stored property site. For internal use.

version

data

SitePropertiesUpdated

metadata

ResolutionMethod

SitePropertiesEvent

Version of the site's properties represented by this update.

ID of the Wix site that has been updated.

metasiteId

SpecialHourPeriod

Additional info about the exception. For example, "We close earlier on New Year's Eve."

comment

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).

endDate

Whether the business is closed (or the service is not available) during the exception.

Default: `true`.

isClosed

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).

startDate

SupportedLanguage

countryCode

Whether the supported language is the primary language for the site.

isPrimary

Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

languageCode

How the language will be resolved. For internal use.

resolutionMethod

TimePeriod

closeDay

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`.

closeTime

openDay

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.

openTime

handler

Triggered when site properties are updated

import { createClient, AppStrategy } from '@wix/sdk';
import { siteProperties } from '@wix/business-tools';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      siteProperties,
    },
});

wixClient.siteProperties.onPropertiesSitePropertiesUpdated((event) => {
    // handle your event here
});

updateBusinessProfile( )

Permission Scopes