Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

createCategory() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { categories } from '@wix/bookings';

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

async function createCategory(category) {
  const response = await wixClient.categories.createCategory(category);
}

createCategory() with Dashboard app access

createCategory

string

options

DeleteCategoryOptions

Deletes a category.
When deleting a category, you have the option to delete all the associated services within this category using the `deleteServices` field in the request.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { categories } from '@wix/bookings';

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

async function deleteCategory(id, options) {
  const response = await wixClient.categories.deleteCategory(id, options);
}

deleteCategory() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { categories } from '@wix/bookings';

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

async function deleteCategory(id, options) {
  const response = await wixClient.categories.deleteCategory(id, options);
}

deleteCategory() with Dashboard app access

deleteCategory

DeleteCategoryResponse

ListCategoriesOptions

import { createClient, OAuthStrategy } from '@wix/sdk';
import { categories } from '@wix/bookings';

const wixClient = createClient({
  modules: { categories } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function listCategories(options) {
  const response = await wixClient.categories.listCategories(options);
}

listCategories() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { categories } from '@wix/bookings';

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

async function listCategories(options) {
  const response = await wixClient.categories.listCategories(options);
}

listCategories() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { categories } from '@wix/bookings';

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

async function listCategories(options) {
  const response = await wixClient.categories.listCategories(options);
}

listCategories() with Dashboard app access

listCategories

ListCategoryResponse

UpdateCategory

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { categories } from '@wix/bookings';

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

async function updateCategory(id, category) {
  const response = await wixClient.categories.updateCategory(id, category);
}

updateCategory() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { categories } from '@wix/bookings';

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

async function updateCategory(id, category) {
  const response = await wixClient.categories.updateCategory(id, category);
}

updateCategory() with Dashboard app access

updateCategory

UpdateCategoryResponse

To use the Categories API, install the `@wix/bookings` package using npm or Yarn:
  ```console
npm install @wix/bookings
```

or

```console
yarn add @wix/bookings
```

Then import `{ categories }` from `@wix/bookings`:

```js
import { categories } from '@wix/bookings'
```
  

bookings_categories

BaseEventMetadata

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

CategoryNotification

event

Event

CategoryNotificationEnvelope

data

metadata

Cascade delete all the services in this category. Defaults to false (when false, the services will still exist but will not be accessible in the dashboard).

deleteServices

boolean

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

categoryIds

OnCategoryNotificationHandler

void

Status

name

handler

import { createClient, AppStrategy } from '@wix/sdk';
import { categories } from '@wix/bookings';

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

wixClient.categories.onCategoryNotification((event) => {
    // handle your event here
});

deleteCategory( )

Permission Scopes