Choose a version:

Cart API
APIs

The Cart API enables UI Extensions to manage and interact with POS cart contents, such as discounts, line items, and customer details. It provides a comprehensive set of functions for adding and removing items, alongside a subscribable object that keeps the UI Extension updated with real-time changes to the cart.

Supporting targets

Anchor to cartapiCartApi

addAddress

(address: ) => Promise<void>

required

Add an address to the customer (Customer must be present)

addCartCodeDiscount

(code: string) => Promise<void>

required

Add a code discount to the cart

addCartProperties

(properties: Record<string, string>) => Promise<void>

required

Adds custom properties to the cart

addCustomSale

(customSale: ) => Promise<string>

required

Add a custom sale to the cart

addLineItem

(variantId: number, quantity: number) => Promise<string>

required

Add a line item by variant ID to the cart

addLineItemProperties

(uuid: string, properties: Record<string, string>) => Promise<void>

required

Adds custom properties to the specified line item

applyCartDiscount

(type: , title: string, amount?: string) => Promise<void>

required

Apply a cart level discount

bulkAddLineItemProperties

(lineItemProperties: []) => Promise<void>

required

Adds custom properties to multiple line items at the same time.

bulkCartUpdate

(cartState: ) => Promise<>

required

Bulk update the cart

bulkSetLineItemDiscounts

(lineItemDiscounts: []) => Promise<void>

required

Set line item discounts to multiple line items at the same time.

clearCart

() => Promise<void>

required

Clear the cart

deleteAddress

(addressId: number) => Promise<void>

required

Delete an address from the customer (Customer must be present)

removeAllDiscounts

(disableAutomaticDiscounts: boolean) => Promise<void>

required

Remove all cart and line item discounts

removeCartDiscount

() => Promise<void>

required

Remove the cart discount

removeCartProperties

(keys: string[]) => Promise<void>

required

Removes the specified cart properties

removeCustomer

() => Promise<void>

required

Remove the current customer from the cart

removeLineItem

(uuid: string) => Promise<void>

required

Remove the line item at this uuid from the cart

removeLineItemDiscount

(uuid: string) => Promise<void>

required

Remove all discounts from a line item

removeLineItemProperties

(uuid: string, keys: string[]) => Promise<void>

required

Removes the specified line item properties

setAttributedStaff

(staffId: number) => Promise<void>

required

Sets an attributed staff to all line items in the cart.

setAttributedStaffToLineItem

(staffId: number, lineItemUuid: string) => Promise<void>

required

Sets an attributed staff to a specific line items in the cart.

setCustomer

(customer: ) => Promise<void>

required

Set the customer in the cart

setLineItemDiscount

(uuid: string, type: , title: string, amount: string) => Promise<void>

required

Add a discount on a line item to the cart

subscribable

RemoteSubscribable<>

required

Provides a subscription to POS cart changes. Provides an initial value and a callback to subscribe to value changes. Currently supports only one subscription. You can utilize makeStatefulSubscribable on a RemoteSubscribable to implement multiple subscriptions. Using makeStatefulSubscribable or the corresponding hooks counts as a subscription.

updateDefaultAddress

(addressId: number) => Promise<void>

required

Update the default address for the customer (Customer must be present)

Was this section helpful?

Anchor to examplesExamples

Examples of using the Cart API

Check editable state of the cart

Apply a cart level discount

Apply a cart level discount code

Remove all the discounts on the cart and line items

Set a custom discount on a line item

Set a custom discount on multiple line items

Remove a discount on a line item

Clear the entire cart

Set the customer in the cart

Remove the customer in the cart

Add a custom sale to the cart

Add a line item to the cart

Remove a line item from the cart

Add custom properties to the cart

Remove custom properties from the cart

Add custom properties to a line item

Add custom properties to multiple line items

Remove custom properties from a line item

Set an attributed staff member on the cart

Set an attributed staff member on a line item

Add an address to the customer in the cart

Delete an address corresponding to an ID

Set the default address of the customer in the cart

Was this section helpful?

Subscribe to cart changes.

import React from 'react';

import {

reactExtension,

useApi,

Tile,

useCartSubscription

} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridTile = () => {

const cart = useCartSubscription();

return (

<Tile

title='My App'

subtitle={`${cart.lineItems.length} line items in cart`}

enabled

);

};

export default reactExtension(

'pos.home.tile.render',

() => <SmartGridTile />

);

Cart APIAPIs

Supporting targets

Anchor to cartapiCartApi

Anchor to examplesExamples

Cart API
APIs