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

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

# Interface: SitesBackend

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:52](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts#L52)

Backend contract for site read operations.

Cartridge-path methods model the SCAPI v1.3 custom-cartridges resource and
the equivalent OCAPI Data API resource.

## Extends

- [`BackendBase`](../../../clients/interfaces/BackendBase.md)

## Properties

### name

> `readonly` **name**: `"ocapi"` \| `"scapi"`

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:36](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts#L36)

#### Inherited from

[`BackendBase`](../../../clients/interfaces/BackendBase.md).[`name`](../../../clients/interfaces/BackendBase.md#name)

## Methods

### addCartridge()

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

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:57](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts#L57)

#### Parameters

##### siteId

`string`

##### name

`string`

##### position

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

##### target?

`string`

#### Returns

`Promise`\<`string`\>

***

### getCartridgePath()

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

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

#### Parameters

##### siteId

`string`

#### Returns

`Promise`\<`string`\>

***

### getSite()

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

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

#### Parameters

##### siteId

`string`

#### Returns

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

***

### listSites()

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

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:53](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts#L53)

#### Parameters

##### options?

[`ListSitesOptions`](ListSitesOptions.md)

#### Returns

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

***

### removeCartridge()

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

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:58](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts#L58)

#### Parameters

##### siteId

`string`

##### name

`string`

#### Returns

`Promise`\<`string`\>

***

### setCartridgePath()

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

Defined in: [packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:56](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts#L56)

#### Parameters

##### siteId

`string`

##### cartridges

`string`

#### Returns

`Promise`\<`string`\>