Class CartSessionClient

Index

Constructors

Accessors

Methods

addItem applyDiscount checkout clearShipping create get removeDiscount removeItem resume selectShipping updateItem

Constructors

constructor

new CartSessionClient(opts: CartSessionClientOptions): CartSessionClient
Parameters
- opts: CartSessionClientOptions
Returns CartSessionClient
- Defined in cart-session.ts:76

Accessors

cartSessionId

get cartSessionId(): string | null
The current bound session id (after create()/resume()), or null.

Returns string | null
- Defined in cart-session.ts:92

Methods

addItem

addItem(input: AddLineItemInput): Promise<Cart>
Parameters
- input: AddLineItemInput
Returns Promise<Cart>
- Defined in cart-session.ts:119

applyDiscount

applyDiscount(code: string): Promise<Cart>
Parameters
- code: string
Returns Promise<Cart>
- Defined in cart-session.ts:141

checkout

checkout(input: CheckoutHandoffInput): Promise<CheckoutHandoff>
Hand off to hosted/embedded checkout. Marks the session converted (no more edits).
Parameters
- input: CheckoutHandoffInput
Returns Promise<CheckoutHandoff>
- Defined in cart-session.ts:150

clearShipping

clearShipping(): Promise<Cart>
Returns Promise<Cart>
- Defined in cart-session.ts:137

create

create(input?: CreateCartSessionInput): Promise<CartSession>
Create a new cart session and bind this client to it.
Parameters
- input: CreateCartSessionInput = {}
Returns Promise<CartSession>
- Defined in cart-session.ts:103

get

get(): Promise<CartSession>
Read the current session + cart snapshot.

Returns Promise<CartSession>
- Defined in cart-session.ts:115

removeDiscount

removeDiscount(): Promise<Cart>
Returns Promise<Cart>
- Defined in cart-session.ts:145

removeItem

removeItem(itemId: string): Promise<Cart>
Parameters
- itemId: string
Returns Promise<Cart>
- Defined in cart-session.ts:129

resume

resume(cartSessionId: string): this
Bind to an existing session id — e.g. one restored from localStorage.
Parameters
- cartSessionId: string
Returns this
- Defined in cart-session.ts:97

selectShipping

selectShipping(input: SelectShippingInput): Promise<Cart>
Parameters
- input: SelectShippingInput
Returns Promise<Cart>
- Defined in cart-session.ts:133

updateItem

updateItem(itemId: string, input: UpdateLineItemInput): Promise<Cart>
Parameters
- itemId: string
- input: UpdateLineItemInput
Returns Promise<Cart>
- Defined in cart-session.ts:123