useDeliveryGroups

Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.

import {
  reactExtension,
  Banner,
  useDeliveryGroups,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  const deliveryGroups = useDeliveryGroups();
  const deliveryOptions =
    deliveryGroups[0].deliveryOptions;

  return (
    <Banner>
      First delivery option:{' '}
      {deliveryOptions[0].title}
    </Banner>
  );
}

UseDeliveryGroupsGeneratedType

Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.

Returns: DeliveryGroup[]

export function useDeliveryGroups< Target extends RenderExtensionTarget = RenderExtensionTarget, >(): DeliveryGroup[] { const api = useApi<Target>(); if (!('deliveryGroups' in api)) { throw new ExtensionHasNoMethodError('deliveryGroups', api.extension.target); } return useSubscription(api.deliveryGroups); }

DeliveryGroup

Represents the delivery information and options available for one or more cart lines.

targetedCartLines

The cart line references associated to the delivery group.

deliveryOptions

The delivery options available for the delivery group.

selectedDeliveryOption

The selected delivery option for the delivery group.

groupType

The type of the delivery group.

isDeliveryRequired

Whether delivery is required for the delivery group.

CartLineReference

Represents a reference to a cart line.

id

The unique identifier of the referenced cart line.

DeliveryOption

Represents a base interface for a single delivery option.

handle

The unique identifier of the delivery option.

title

The title of the delivery option.

description

The description of the delivery option.

DeliveryOptionReference

Represents a reference to a delivery option.

handle

The unique identifier of the referenced delivery option.

DeliveryGroupType

The possible types of a delivery group.

'oneTimePurchase' | 'subscription'

Related

• StandardApi
• CheckoutApi
• OrderStatusApi
• CartLineItemApi
• PickupPointListApi
• PickupLocationListApi
• ShippingOptionItemApi
• ExtensionTargets