removeCartItem

Removes a product from the cart.

It receives data from the removeCartItem endpoint exposed by the BigCommerce API

Signature

declare function removeCartItem(
	context: BigcommerceIntegrationContext,
	params: RemoveLineItemParameters
): Promise<AddLineItemsResponse>;

Parameters

Name	Required	Type	Description
`context`	Required	`BigcommerceIntegrationContext`
`params`	Required	`RemoveLineItemParameters`

Returns

Returns a response of a cart that contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

Referenced Types

BigcommerceIntegrationContext
RemoveLineItemParameters
AddLineItemsResponse

Examples

Removiing a line item from the cart

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

const removeCartItemResponse = await sdk.bigcommerce.removeCartItem({
  data: {
    cartId: '7c3ab631-782c-4747-8ccc-873e87de5152',
    itemId: 'bd64d491-a4ac-4839-9fc2-5fc9f95a3bfd'
  }
})