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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [scapi](../index.md) / ResolveScapiDocumentsOptions

# Interface: ResolveScapiDocumentsOptions

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:37](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L37)

## Properties

### api?

> `optional` **api**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:39](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L39)

Limit to an API family, family/name or family/name/version.

***

### bundled?

> `optional` **bundled**: readonly [`ScapiSchemaDocument`](ScapiSchemaDocument.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:47](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L47)

Bundled contracts. Defaults to [loadScapiSchemas](../functions/loadScapiSchemas.md).

***

### live?

> `optional` **live**: [`ScapiLiveSchemaSource`](ScapiLiveSchemaSource.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:41](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L41)

Fetch the tenant's contracts (custom APIs, `c_*` properties); falls back to bundled ones on failure.

***

### local?

> `optional` **local**: readonly [`ScapiSchemaDocument`](ScapiSchemaDocument.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:45](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L45)

Developer contracts; replace bundled and live contracts with the same ID.

***

### refresh?

> `optional` **refresh**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:43](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L43)

With `live`, refetch instead of using the cache.

***

### signal?

> `optional` **signal**: `AbortSignal`

Defined in: [packages/b2c-tooling-sdk/src/scapi/documents.ts:48](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/scapi/documents.ts#L48)
