ShippingInitializeOptions.md

@bigcommerce/checkout-sdk / 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	{}

Hierarchy

• ShippingRequestOptions<T>

  ↳ ShippingInitializeOptions

Table of contents

Properties

• amazonpay
• methodId
• params
• stripeupe
• timeout

Properties

amazonpay

• Optional amazonpay: AmazonPayV2ShippingInitializeOptions

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

---

methodId

• Optional methodId: string

Inherited from

ShippingRequestOptions.methodId

---

params

• Optional params: T

The parameters of the request, if required.

Inherited from

ShippingRequestOptions.params

---

stripeupe

• Optional stripeupe: StripeUPEShippingInitializeOptions

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.timeout