[@bigcommerce/checkout-sdk](../README.md) / ShippingInitializeOptions

# Interface: ShippingInitializeOptions\<T\>

A set of options that are required to initialize the shipping step of the
current checkout flow.

Some payment methods have specific requirements for setting the shipping
details for checkout. For example, Amazon Pay requires the customer to enter
their shipping address using their address book widget. As a result, you may
need to provide additional information in order to initialize the shipping
step of checkout.

## Type parameters

| Name | Type |
| :------ | :------ |
| `T` | `object` |

## Hierarchy

- [`ShippingRequestOptions`](ShippingRequestOptions.md)\<`T`\>

  ↳ **`ShippingInitializeOptions`**

## Table of contents

### Properties

- [amazonpay](ShippingInitializeOptions.md#amazonpay)
- [bigcommerce\_payments\_fastlane](ShippingInitializeOptions.md#bigcommerce_payments_fastlane)
- [braintreefastlane](ShippingInitializeOptions.md#braintreefastlane)
- [fastlane](ShippingInitializeOptions.md#fastlane)
- [methodId](ShippingInitializeOptions.md#methodid)
- [params](ShippingInitializeOptions.md#params)
- [paypalcommercefastlane](ShippingInitializeOptions.md#paypalcommercefastlane)
- [stripeupe](ShippingInitializeOptions.md#stripeupe)
- [timeout](ShippingInitializeOptions.md#timeout)
- [version](ShippingInitializeOptions.md#version)

## Properties

### amazonpay

• `Optional` **amazonpay**: [`AmazonPayV2ShippingInitializeOptions`](AmazonPayV2ShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using AmazonPayV2.

___

### bigcommerce\_payments\_fastlane

• `Optional` **bigcommerce\_payments\_fastlane**: [`BigCommercePaymentsFastlaneShippingInitializeOptions`](BigCommercePaymentsFastlaneShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using BigCommercePayments Fastlane.

___

### braintreefastlane

• `Optional` **braintreefastlane**: [`BraintreeFastlaneShippingInitializeOptions`](BraintreeFastlaneShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using Braintree Fastlane.

___

### fastlane

• `Optional` **fastlane**: [`FastlaneShippingInitializeOptions`](FastlaneShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using Fastlane (PayPal Commerce, BigCommerce Payments, or Braintree).

This is a unified option that works across all Fastlane implementations,
simplifying integration and avoiding provider-specific checks.

___

### methodId

• `Optional` **methodId**: `string`

#### Inherited from

[ShippingRequestOptions](ShippingRequestOptions.md).[methodId](ShippingRequestOptions.md#methodid)

___

### params

• `Optional` **params**: `T`

The parameters of the request, if required.

#### Inherited from

[ShippingRequestOptions](ShippingRequestOptions.md).[params](ShippingRequestOptions.md#params)

___

### paypalcommercefastlane

• `Optional` **paypalcommercefastlane**: [`PayPalCommerceFastlaneShippingInitializeOptions`](PayPalCommerceFastlaneShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using PayPal Commerce Fastlane.

___

### stripeupe

• `Optional` **stripeupe**: [`StripeUPEShippingInitializeOptions`](StripeUPEShippingInitializeOptions.md)

The options that are required to initialize the shipping step of checkout
when using Stripe Upe Link.

___

### timeout

• `Optional` **timeout**: `default`

Provide this option if you want to cancel or time out the request. If the
timeout object completes before the request, the request will be
cancelled.

#### Inherited from

[ShippingRequestOptions](ShippingRequestOptions.md).[timeout](ShippingRequestOptions.md#timeout)

___

### version

• `Optional` **version**: `number`

The version of the checkout, used for optimistic concurrency control.

#### Inherited from

[ShippingRequestOptions](ShippingRequestOptions.md).[version](ShippingRequestOptions.md#version)
