# @scayle/omnichannel-nuxt

> Collection of essential utilities to work with omnichannel

Latest version **4.6.2** (published 2026-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @scayle/omnichannel-nuxt
pnpm add @scayle/omnichannel-nuxt
yarn add @scayle/omnichannel-nuxt
bun add @scayle/omnichannel-nuxt
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 4.6.2 |
| Published | 2026-07-20 |
| First published | 2023-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 22.0.0 |
| Dependencies | 3 |
| Unpacked size | 33 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | SCAYLE Commerce Engine |
| Maintainers | scayle-automation, lukas-matejka-scayle, ay-henribeck |

## Links

- npm: https://www.npmjs.com/package/@scayle/omnichannel-nuxt
- npm.io page: https://npm.io/package/@scayle/omnichannel-nuxt

## Dependencies (3)

- [qs](https://npm.io/package/qs.md) ^6.15.3
- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^3.13.0 || ^4.2.0
- [utility-types](https://npm.io/package/utility-types.md) ^3.11.0

## Recent versions

- 4.6.2 (latest) — 2026-07-20
- 4.6.1 — 2026-06-19
- 4.6.0 — 2026-04-29
- 4.5.0 — 2026-04-10
- 4.4.0 — 2026-01-13
- 4.3.5 — 2026-01-02
- 4.3.4 — 2025-10-20
- 4.3.3 — 2025-09-15
- 4.3.2 — 2025-05-29
- 4.3.1 — 2025-04-22
- 4.3.0 — 2025-04-17
- 4.2.0 — 2025-02-17
- 4.1.0 — 2025-02-14
- 4.0.4 — 2025-01-09
- 4.0.3 — 2024-12-16
- … 17 more at https://npm.io/package/@scayle/omnichannel-nuxt/versions

## README

# Omnichannel

This is the basis for setting up a new Omnichannel Add-On integration using Nuxt.
It provides a reusable composables, that can be used in the actual storefront project.

## Getting started

To start working with `@scayle/omnichannel-nuxt`, make sure to
register it as a module in your nuxt.config.ts file:

Nuxt 3

```typescript
export default defineNuxtConfig({
  modules: ['@scayle/omnichannel-nuxt/module'],
  runtimeConfig: {
    /** Omnichannel runtime configuration */
    omnichannel: {
      apiHost: '', // Override: NUXT_OMNICHANNEL_API_HOST
      apiToken: '', // Override: NUXT_OMNICHANNEL_API_TOKEN
    },
  },
})
```

## Architecture

The Omnichannel Add-On package provides `useStoreLocator` composable,
which can be used to call the following methods:

- `refreshStores` to get `storesData` based on provided address
- `refreshVariantStores` to get `variantStoresData` based on provided store ID
- `refreshStoreVariant` to get `storeVariantData` based on provided store ID and variant ID

## List of composables

When using Nuxt 3, composables are automatically registered and do not need to be imported explicitly.
The Nuxt 3 composables can optionally be imported using the import alias `#omnichannel/composables`.

### [useStoreLocator](./src/composables/useStoreLocator.ts)

Getting `storesData` based on a provided address

Example:

```typescript
import { useStoreLocator } from '#omnichannel/composables'

const { storesData, refreshStores } = useStoreLocator('useStoreLocator', [
  'openingTimes',
])
const address = 'Hamburg'
await refreshStores(address)
```

Getting `variantStoresData` based on a provided address

Example:

```typescript
import { useStoreLocator } from '#omnichannel/composables'

const { variantStoresData, refreshVariantStores } = useStoreLocator(
  'useStoreLocator',
  ['openingTimes'],
)
const address = 'Hamburg'
const storeId = 12
await refreshVariantStores(storeId, { address: address })
```

Getting `storeVariantData` based on a provided store ID and variant ID

Example:

```typescript
import { useStoreLocator } from '#omnichannel/composables'

const { storeVariantData, refreshStoreVariant } = useStoreLocator(
  'useStoreLocator',
  ['openingTimes'],
)
const variantId = 1
const storeId = 12
await refreshStoreVariant(variantId, storeId)
```

## What is SCAYLE?

[SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs.
Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.

Learn more about [SCAYLE’s architecture](https://scayle.dev/en/core-documentation/welcome-to-scayle/getting-started) and commerce modules in the docs.

## Other channels

- [LinkedIn](https://www.linkedin.com/company/scaylecommerce/)
- [Jobs](https://careers.smartrecruiters.com/ABOUTYOUGmbH/scayle)

## License

Licensed under the [MIT License](https://opensource.org/license/mit/)

---
_Source: https://npm.io/package/@scayle/omnichannel-nuxt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._