---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/sites](../index.md) / ScapiSitesBackend

# Class: ScapiSitesBackend

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:54](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L54)

SCAPI Sites backend. Reads sites and manages custom cartridge paths via the
`site/sites/v1` Admin API.

## Implements

- [`SitesBackend`](../interfaces/SitesBackend.md)

## Constructors

### Constructor

> **new ScapiSitesBackend**(`config`): `ScapiSitesBackend`

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:60](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L60)

#### Parameters

##### config

`ScapiSitesBackendConfig`

#### Returns

`ScapiSitesBackend`

## Properties

### name

> `readonly` **name**: `"scapi"`

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:55](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L55)

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`name`](../interfaces/SitesBackend.md#name)

## Methods

### addCartridge()

> **addCartridge**(`siteId`, `name`, `position`, `target?`): `Promise`\<`string`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:178](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L178)

#### Parameters

##### siteId

`string`

##### name

`string`

##### position

[`CartridgePosition`](../type-aliases/CartridgePosition.md)

##### target?

`string`

#### Returns

`Promise`\<`string`\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`addCartridge`](../interfaces/SitesBackend.md#addcartridge)

***

### getCartridgePath()

> **getCartridgePath**(`siteId`): `Promise`\<`string`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:149](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L149)

#### Parameters

##### siteId

`string`

#### Returns

`Promise`\<`string`\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`getCartridgePath`](../interfaces/SitesBackend.md#getcartridgepath)

***

### getSite()

> **getSite**(`siteId`): `Promise`\<[`SiteInfo`](../interfaces/SiteInfo.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:138](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L138)

#### Parameters

##### siteId

`string`

#### Returns

`Promise`\<[`SiteInfo`](../interfaces/SiteInfo.md)\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`getSite`](../interfaces/SitesBackend.md#getsite)

***

### listSites()

> **listSites**(`options`): `Promise`\<[`SiteInfo`](../interfaces/SiteInfo.md)[]\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:66](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L66)

#### Parameters

##### options

[`ListSitesOptions`](../interfaces/ListSitesOptions.md) = `{}`

#### Returns

`Promise`\<[`SiteInfo`](../interfaces/SiteInfo.md)[]\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`listSites`](../interfaces/SitesBackend.md#listsites)

***

### removeCartridge()

> **removeCartridge**(`siteId`, `name`): `Promise`\<`string`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:188](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L188)

#### Parameters

##### siteId

`string`

##### name

`string`

#### Returns

`Promise`\<`string`\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`removeCartridge`](../interfaces/SitesBackend.md#removecartridge)

***

### setCartridgePath()

> **setCartridgePath**(`siteId`, `cartridges`): `Promise`\<`string`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:163](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts#L163)

#### Parameters

##### siteId

`string`

##### cartridges

`string`

#### Returns

`Promise`\<`string`\>

#### Implementation of

[`SitesBackend`](../interfaces/SitesBackend.md).[`setCartridgePath`](../interfaces/SitesBackend.md#setcartridgepath)