Alokai

updateCartItems

Update cart items.

Signature

declare function updateCartItems(
	context: Context,
	input: UpdateCartItemsInput,
	customQuery?: CustomQuery,
	customHeaders?: CustomHeaders
): Promise<FetchResult<UpdateCartItemsMutation>>;

Parameters

NameRequiredTypeDescription
contextRequiredContext
inputRequiredUpdateCartItemsInput
customQueryOptionalCustomQuery
customHeadersOptionalCustomHeaders

Referenced Types

Examples

Simple usage:

import { sdk } from '~/sdk.config.ts';

// update cart items
const result = await sdk.magento.updateCartItems({
  cart_id: 'cart-id',
  cart_items: [
    {
      cart_item_uid: 'item-uid',
      quantity: 2
    }
  ]
});

Creating a custom GraphQL query for updating cart items

module.exports = {
  integrations: {
    magento: {
      customQueries: {
        'update-cart-items-custom-query': ({ variables, metadata }) => ({
           variables,
           query: `
             mutation updateCartItems($input: UpdateCartItemsInput) {
               updateCartItems(input: $input) {
                 cart {
                   ${metadata.fields}
                 }
               }
             }`
        }),
      },
    }
  }
};

Using a custom GraphQL query to update cart items

import { sdk } from '~/sdk.config.ts';
// reduce the amount of fields returned by the query, when compared to the default query
const customQuery = {
  updateCartItems: 'update-cart-items-custom-query',
  metadata: {
    fields: 'id items { uid quantity }'
  }
};

const result = await sdk.magento.updateCartItems({
  cart_id: 'cart-id',
  cart_items: [
    {
      cart_item_uid: 'item-uid',
      quantity: 2
    }
  ]
}, customQuery);

// result will contain only the fields specified in the custom query.

On this page