# useDeliveryGroups

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

```jsx
import React from 'react';
import {
  render,
  Banner,
  useDeliveryGroups,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::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<
  ID extends RenderExtensionPoint = RenderExtensionPoint,
>(): DeliveryGroup[] {
  const {deliveryGroups} = useApi<ID>();

  return useSubscription(deliveryGroups);
}


### DeliveryGroup

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

### targetedCartLines

value: `CartLineReference[]`

  - CartLineReference: export interface CartLineReference {
  /**
   * The unique identifier of the referenced cart line.
   */
  id: string;
}
The cart line references associated to the delivery group.

### deliveryOptions

value: `DeliveryOption[]`

  - DeliveryOption: export interface DeliveryOption {
  /**
   * The unique identifier of the delivery option.
   */
  handle: string;

  /**
   * The title of the delivery option.
   */
  title?: string;

  /**
   * The description of the delivery option.
   */
  description?: string;
}
The delivery options available for the delivery group.

### selectedDeliveryOption

value: `DeliveryOptionReference`

  - DeliveryOption: export interface DeliveryOption {
  /**
   * The unique identifier of the delivery option.
   */
  handle: string;

  /**
   * The title of the delivery option.
   */
  title?: string;

  /**
   * The description of the delivery option.
   */
  description?: string;
}
  - DeliveryOptionReference: export interface DeliveryOptionReference {
  /**
   * The unique identifier of the referenced delivery option.
   */
  handle: string;
}
The selected delivery option for the delivery group.

### groupType

value: `DeliveryGroupType`

  - DeliveryGroup: export interface DeliveryGroup {
  /**
   * The cart line references associated to the delivery group.
   */
  targetedCartLines: CartLineReference[];

  /**
   * The delivery options available for the delivery group.
   */
  deliveryOptions: DeliveryOption[];

  /**
   * The selected delivery option for the delivery group.
   */
  selectedDeliveryOption?: DeliveryOptionReference;

  /**
   * The type of the delivery group.
   */
  groupType: DeliveryGroupType;

  /**
   * Whether delivery is required for the delivery group.
   */
  isDeliveryRequired: boolean;
}
  - DeliveryGroupType: 'oneTimePurchase' | 'subscription'
The type of the delivery group.

### isDeliveryRequired

value: `boolean`

Whether delivery is required for the delivery group.

### CartLineReference

Represents a reference to a cart line.

### id

value: `string`

The unique identifier of the referenced cart line.

### DeliveryOption

Represents a base interface for a single delivery option.

### handle

value: `string`

The unique identifier of the delivery option.

### title

value: `string`

The title of the delivery option.

### description

value: `string`

The description of the delivery option.

### DeliveryOptionReference

Represents a reference to a delivery option.

### handle

value: `string`

The unique identifier of the referenced delivery option.

## Related

- [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)
- [CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)
- [OrderStatusApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)
- [CartLineDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi)
- [PickupPointsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointsapi)
- [PickupLocationsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationsapi)
- [ShippingMethodDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingmethoddetailsapi)
- [ExtensionPoints](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensionpoints)