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

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

# Interface: CreateRedirectBackendOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1068](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1068)

Options for [createRedirectWithBackend](../functions/createRedirectWithBackend.md).

## Extends

- [`RedirectBackendOptions`](RedirectBackendOptions.md)

## Properties

### destination

> **destination**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1072](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1072)

The destination path or URL.

***

### environment

> **environment**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:937](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L937)

Target/environment slug (= SCAPI environment ID).

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`environment`](RedirectBackendOptions.md#environment)

***

### forwardQuerystring?

> `optional` **forwardQuerystring**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1076](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1076)

Forward the incoming query string.

***

### forwardWildcard?

> `optional` **forwardWildcard**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1078](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1078)

Forward a trailing wildcard match.

***

### httpStatusCode?

> `optional` **httpStatusCode**: [`RedirectHttpStatusCode`](../type-aliases/RedirectHttpStatusCode.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1074](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1074)

HTTP status code (301 or 302).

***

### legacyAuth?

> `optional` **legacyAuth**: [`AuthStrategy`](../../../auth/interfaces/AuthStrategy.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:933](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L933)

Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`legacyAuth`](RedirectBackendOptions.md#legacyauth)

***

### onFallback()?

> `optional` **onFallback**: (`reason`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:941](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L941)

Invoked when `auto` falls back from SCAPI to legacy.

#### Parameters

##### reason

`string`

#### Returns

`void`

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`onFallback`](RedirectBackendOptions.md#onfallback)

***

### onResolve()?

> `optional` **onResolve**: (`backend`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:943](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L943)

Invoked with the backend that serves the call (for `-D` debug).

#### Parameters

##### backend

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

#### Returns

`void`

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`onResolve`](RedirectBackendOptions.md#onresolve)

***

### origin?

> `optional` **origin**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:939](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L939)

Legacy MRT API origin.

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`origin`](RedirectBackendOptions.md#origin)

***

### preference

> **preference**: [`MrtBackendPreference`](../type-aliases/MrtBackendPreference.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:929](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L929)

Resolved `--mrt-backend` preference.

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`preference`](RedirectBackendOptions.md#preference)

***

### projectSlug

> **projectSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:935](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L935)

Project slug (= SCAPI storefront ID).

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`projectSlug`](RedirectBackendOptions.md#projectslug)

***

### scapiConnection?

> `optional` **scapiConnection**: [`ScapiMrtConnection`](ScapiMrtConnection.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:931](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L931)

SCAPI connection; when absent, `auto` uses legacy and `scapi` throws.

#### Inherited from

[`RedirectBackendOptions`](RedirectBackendOptions.md).[`scapiConnection`](RedirectBackendOptions.md#scapiconnection)

***

### source

> **source**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1070](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts#L1070)

The source path to redirect from.