Skip to main content

Class: CartService

Defined in: service/CartService.ts:437

Backwards-compatible class form. New code should call cartService(client).

Constructors​

Constructor​

new CartService(client): CartService

Defined in: service/CartService.ts:439

Parameters​

client​

GraphQLClient

Returns​

CartService

Methods​

acceptPurchaseAuthorizationRequest()​

acceptPurchaseAuthorizationRequest(variables): Promise<Cart>

Defined in: service/CartService.ts:529

Accepts a purchase authorization request for a cart

Parameters​

variables​

CartAcceptPurchaseAuthorizationVariables

Cart ID to accept purchase authorization for

Returns​

Promise<Cart>

addActionCodeToCart()​

addActionCodeToCart(variables): Promise<Cart>

Defined in: service/CartService.ts:509

Adds an action code to a cart

Parameters​

variables​

CartActionCodeVariables

Cart ID to add action code to

Returns​

Promise<Cart>

addBundleToCart()​

addBundleToCart(variables): Promise<Cart>

Defined in: service/CartService.ts:484

Adds a bundle to a cart

Parameters​

variables​

CartAddBundleVariables

Cart ID to add bundle to

Returns​

Promise<Cart>

addItemToCart()​

addItemToCart(variables): Promise<Cart>

Defined in: service/CartService.ts:459

Adds an item to a cart

Parameters​

variables​

CartAddItemVariables

Cart ID to add item to

Returns​

Promise<Cart>

bulkUpdateCartItems()​

bulkUpdateCartItems(variables): Promise<BulkResponseData>

Defined in: service/CartService.ts:519

Bulk updates cart items

Parameters​

variables​

CartItemBulkVariables

Cart item bulk input data

Returns​

Promise<BulkResponseData>

deleteCart()​

deleteCart(variables): Promise<boolean>

Defined in: service/CartService.ts:504

Deletes a cart

Parameters​

variables​

CartDeleteVariables

Cart ID to delete

Returns​

Promise<boolean>

deleteCartItem()​

deleteCartItem(variables): Promise<Cart>

Defined in: service/CartService.ts:469

Deletes an item from a cart

Parameters​

variables​

CartDeleteItemVariables

Cart ID to delete item from

Returns​

Promise<Cart>

getCart()​

getCart(variables): Promise<Cart>

Defined in: service/CartService.ts:444

Fetches a single cart by ID

Parameters​

variables​

CartQueryVariables

Cart ID to fetch

Returns​

Promise<Cart>

getCarts()​

getCarts(input?): Promise<CartResponse>

Defined in: service/CartService.ts:449

Fetches a list of carts with search criteria

Parameters​

input?​

CartSearchInput

Cart search input parameters

Returns​

Promise<CartResponse>

processCart()​

processCart(variables): Promise<CartProcessResponse>

Defined in: service/CartService.ts:499

Processes a cart (checkout)

Parameters​

variables​

CartProcessVariables

Cart ID to process

Returns​

Promise<CartProcessResponse>

removeActionCodeFromCart()​

removeActionCodeFromCart(variables): Promise<Cart>

Defined in: service/CartService.ts:514

Removes an action code from a cart

Parameters​

variables​

CartActionCodeVariables

Cart ID to remove action code from

Returns​

Promise<Cart>

requestPurchaseAuthorization()​

requestPurchaseAuthorization(variables): Promise<Cart>

Defined in: service/CartService.ts:524

Requests purchase authorization for a cart

Parameters​

variables​

CartRequestPurchaseAuthorizationVariables

Cart purchase authorization request input data

Returns​

Promise<Cart>

setCartContact()​

setCartContact(variables): Promise<Cart>

Defined in: service/CartService.ts:494

Sets the contact for a cart

Parameters​

variables​

CartSetContactVariables

Cart set contact input data

Returns​

Promise<Cart>

setCartCustomer()​

setCartCustomer(variables): Promise<Cart>

Defined in: service/CartService.ts:489

Sets the customer for a cart

Parameters​

variables​

CartSetCustomerVariables

Cart set customer input data

Returns​

Promise<Cart>

startCart()​

startCart(variables): Promise<Cart>

Defined in: service/CartService.ts:454

Starts a new cart

Parameters​

variables​

CartStartVariables

Cart start input data

Returns​

Promise<Cart>

updateCart()​

updateCart(variables): Promise<Cart>

Defined in: service/CartService.ts:474

Updates a cart

Parameters​

variables​

CartUpdateVariables

Cart ID to update

Returns​

Promise<Cart>

updateCartAddress()​

updateCartAddress(variables): Promise<Cart>

Defined in: service/CartService.ts:479

Updates a cart address

Parameters​

variables​

CartUpdateAddressVariables

Cart ID to update address for

Returns​

Promise<Cart>

updateCartItem()​

updateCartItem(variables): Promise<Cart>

Defined in: service/CartService.ts:464

Updates an item in a cart

Parameters​

variables​

CartUpdateItemVariables

Cart ID to update item in

Returns​

Promise<Cart>