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

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

# Interface: PushMrtBundleBackendOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:972](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L972)

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

## Properties

### buildDirectory?

> `optional` **buildDirectory**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:992](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L992)

Build output directory.

***

### configPath?

> `optional` **configPath**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:998](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L998)

v2 in-archive config path (v2 uploads only).

***

### legacyAuth?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:978](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L978)

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

***

### matchMode?

> `optional` **matchMode**: [`BundleV2MatchMode`](../type-aliases/BundleV2MatchMode.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1000](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L1000)

v2 match mode (v2 uploads only).

***

### message?

> `optional` **message**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:984](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L984)

Bundle message/description.

***

### onFallback()?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1011](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L1011)

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

#### Parameters

##### reason

`string`

#### Returns

`void`

***

### onResolve()?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1013](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L1013)

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

#### Parameters

##### backend

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

#### Returns

`void`

***

### origin?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1009](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L1009)

Legacy MRT API origin.

***

### preference

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:974](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L974)

Resolved `--mrt-backend` preference.

***

### projectDirectory?

> `optional` **projectDirectory**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:994](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L994)

Directory to read `config.server.{ts,js}` from.

***

### projectSlug

> **projectSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:980](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L980)

Project slug (= SCAPI storefront ID).

***

### rootDir?

> `optional` **rootDir**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:996](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L996)

v2 archive root directory (v2 uploads only).

***

### scapiConnection?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:976](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L976)

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

***

### ssrOnly?

> `optional` **ssrOnly**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:988](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L988)

Glob patterns for server-only files.

***

### ssrParameters?

> `optional` **ssrParameters**: `Record`\<`string`, `unknown`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:986](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L986)

SSR runtime parameters.

***

### ssrShared?

> `optional` **ssrShared**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:990](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L990)

Glob patterns for files shared between server and client.

***

### targetSlug?

> `optional` **targetSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:982](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L982)

Target/environment slug (= SCAPI environment ID). When omitted, the bundle is uploaded but not deployed.

***

### v2?

> `optional` **v2**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1007](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d2e58e4f1db44e0a640eb7f21c14a77b6380b451/packages/b2c-tooling-sdk/src/operations/mrt/push.ts#L1007)

Use the v2 bundle format/endpoint. SCAPI is always v2 (this flag is
redundant there). Legacy defaults to v1; set this to route the legacy push
through the v2 endpoint so the `rootDir`/`configPath`/`matchMode` options
take effect.