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

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

# Interface: ScapiRequestOptions

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:44](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L44)

## Properties

### auth

> **auth**: [`AuthStrategy`](../../auth/interfaces/AuthStrategy.md) \| () => [`AuthStrategy`](../../auth/interfaces/AuthStrategy.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:49](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L49)

Account Manager auth for operations declaring AmOAuth2.

***

### confirm()?

> `optional` **confirm**: (`request`, `signal`) => `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:56](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L56)

Resolve only after user approval; reject on decline/cancellation. Omit to block confirmations.

#### Parameters

##### request

[`ScapiConfirmation`](ScapiConfirmation.md)

##### signal

`AbortSignal`

#### Returns

`Promise`\<`void`\>

***

### documents

> **documents**: [`ScapiSchemaDocument`](ScapiSchemaDocument.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:53](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L53)

***

### middlewareRegistry?

> `optional` **middlewareRegistry**: [`MiddlewareRegistry`](../../clients/classes/MiddlewareRegistry.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:54](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L54)

***

### onDispatch()?

> `optional` **onDispatch**: () => `void`

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:58](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L58)

Called immediately before network dispatch, for tracking potentially applied writes.

#### Returns

`void`

***

### onSchema()?

> `optional` **onSchema**: (`document`, `full`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:60](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L60)

Called with each contract fetched from the Schemas API; `full` reports tenant custom properties and operation prose (expand=all).

#### Parameters

##### document

[`ScapiSchemaDocument`](ScapiSchemaDocument.md)

##### full

`boolean`

#### Returns

`void`

***

### safety

> **safety**: [`SafetyConfig`](../../safety/interfaces/SafetyConfig.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:52](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L52)

***

### shopperAuth?

> `optional` **shopperAuth**: [`ScapiShopperAuth`](ScapiShopperAuth.md)

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:51](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L51)

Guest shopper auth for operations declaring ShopperToken. Omit to reject Shopper operations.

***

### shortCode

> **shortCode**: `string`

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

***

### siteId?

> `optional` **siteId**: `string`

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

***

### tenantId

> **tenantId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scapi/request.ts:46](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/scapi/request.ts#L46)