Skip to main content

Function: cartService()

cartService(client): object

Defined in: service/CartService.ts:200

Service class for Cart-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

acceptPurchaseAuthorizationRequest()​

acceptPurchaseAuthorizationRequest(variables): Promise<Cart>

Accepts a purchase authorization request for a cart *

Parameters​

variables​

CartAcceptPurchaseAuthorizationVariables

    • id: string - Cart ID to accept purchase authorization for
    • input: CartAcceptPurchaseAuthorizationRequestInput - Cart accept purchase authorization input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise<Cart>

Promise<Cart> The updated cart

addActionCodeToCart()​

addActionCodeToCart(variables): Promise&lt;Cart>

Adds an action code to a cart *

Parameters​

variables​

CartActionCodeVariables

    • id: string - Cart ID to add action code to
    • input: CartActionCodeInput - Cart action code input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

addBundleToCart()​

addBundleToCart(variables): Promise&lt;Cart>

Adds a bundle to a cart *

Parameters​

variables​

CartAddBundleVariables

    • id: string - Cart ID to add bundle to
    • input: CartAddBundleInput - Cart add bundle input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

addItemToCart()​

addItemToCart(variables): Promise&lt;Cart>

Adds an item to a cart *

Parameters​

variables​

CartAddItemVariables

    • id: string - Cart ID to add item to
    • input: CartAddItemInput - Cart add item input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

bulkUpdateCartItems()​

bulkUpdateCartItems(variables): Promise&lt;BulkResponseData>

Bulk updates cart items *

Parameters​

variables​

CartItemBulkVariables

    • input: CartItemBulkInput - Cart item bulk input data

Returns​

Promise&lt;BulkResponseData>

Promise<Cart> The updated cart

deleteCart()​

deleteCart(variables): Promise&lt;boolean>

Deletes a cart *

Parameters​

variables​

CartDeleteVariables

    • id: string - Cart ID to delete

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

deleteCartItem()​

deleteCartItem(variables): Promise&lt;Cart>

Deletes an item from a cart *

Parameters​

variables​

CartDeleteItemVariables

    • id: string - Cart ID to delete item from
    • input: CartDeleteItemInput - Cart delete item input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

getCart()​

getCart(variables): Promise&lt;Cart>

Fetches a single cart by ID *

Parameters​

variables​

CartQueryVariables

    • id: string - Cart ID to fetch
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The cart data

getCarts()​

getCarts(input?): Promise&lt;CartResponse>

Fetches a list of carts with search criteria *

Parameters​

input?​

CartSearchInput

Cart search input parameters *

Returns​

Promise&lt;CartResponse>

Promise<CartResponse> The carts response data

processCart()​

processCart(variables): Promise&lt;CartProcessResponse>

Processes a cart (checkout) *

Parameters​

variables​

CartProcessVariables

    • id: string - Cart ID to process
    • input: CartProcessInput - Cart process input data

Returns​

Promise&lt;CartProcessResponse>

Promise<CartProcessResponse> The processed cart

removeActionCodeFromCart()​

removeActionCodeFromCart(variables): Promise&lt;Cart>

Removes an action code from a cart *

Parameters​

variables​

CartActionCodeVariables

    • id: string - Cart ID to remove action code from
    • input: CartActionCodeInput - Cart action code input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

requestPurchaseAuthorization()​

requestPurchaseAuthorization(variables): Promise&lt;Cart>

Requests purchase authorization for a cart *

Parameters​

variables​

CartRequestPurchaseAuthorizationVariables

    • input: CartPurchaseAuthorizationRequestInput - Cart purchase authorization request input data

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

setCartContact()​

setCartContact(variables): Promise&lt;Cart>

Sets the contact for a cart *

Parameters​

variables​

CartSetContactVariables

Cart set contact input data *

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

setCartCustomer()​

setCartCustomer(variables): Promise&lt;Cart>

Sets the customer for a cart *

Parameters​

variables​

CartSetCustomerVariables

Cart set customer input data *

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

setCartUser()​

setCartUser(variables): Promise&lt;Cart>

Sets the user for a cart *

Parameters​

variables​

CartSetUserVariables

Cart set user input data *

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

Deprecated​

The upstream cartSetUser mutation is deprecated. Use setCartContact or setCartCustomer instead. *

startCart()​

startCart(variables): Promise&lt;Cart>

Starts a new cart *

Parameters​

variables​

CartStartVariables

    • input: CartStartInput - Cart start input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The started cart

updateCart()​

updateCart(variables): Promise&lt;Cart>

Updates a cart *

Parameters​

variables​

CartUpdateVariables

    • id: string - Cart ID to update
    • input: CartUpdateInput - Cart update input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

updateCartAddress()​

updateCartAddress(variables): Promise&lt;Cart>

Updates a cart address *

Parameters​

variables​

CartUpdateAddressVariables

    • id: string - Cart ID to update address for
    • input: CartUpdateAddressInput - Cart update address input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart

updateCartItem()​

updateCartItem(variables): Promise&lt;Cart>

Updates an item in a cart *

Parameters​

variables​

CartUpdateItemVariables

    • id: string - Cart ID to update item in
    • itemId: string - Item ID to update in the cart
    • input: CartUpdateItemInput - Cart update item input data
    • language: string - Language for localized content
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;Cart>

Promise<Cart> The updated cart