---
title: Delivery API
description: |2-

    The APIs for interacting with delivery and shipping options.

    > > Tip: Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.
    
api_version: 2025-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/checkout-apis/delivery-api
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/checkout-apis/delivery-api.md
---

Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use [web components](https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components), native UI elements with built-in accessibility, better performance, and consistent styling with [Shopify's design system](https://shopify.dev/docs/apps/design). Check out the [migration guide](https://shopify.dev/docs/api/checkout-ui-extensions/2026-04-rc/upgrading-to-2026-04) to upgrade your extension.

# Delivery API

The APIs for interacting with delivery and shipping options.

**Tip:** \<div data-markdown="remove">\<div class="MinorTheme-Info \_Framed\_i9sw8\_48 \_Notice\_i9sw8\_1" data-testid="notice-Info" data-markdown="remove">\<div class="\_Heading\_i9sw8\_71">\<div class="\_Icon\_i9sw8\_52">\<span class="DefaultIcon">\<svg width="20" height="20" aria-hidden="true">\<use href="#InfoMedium">\</use>\</svg>\</span>\</div>\<div class="markdown \_MarkdownRenderer\_1wwby\_4 \_Label\_i9sw8\_56">Tip\</div>\</div>\<div class="\_Body\_i9sw8\_66">\<p>Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.\</p>\</div>\</div>\<div hidden="">\<strong>\</strong> \<p>Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.\</p>\</div>\</div>\<p class="hidden">\<strong>Tip:\</strong> Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.

## StandardApi

The base API object provided to `purchase` extension targets.

* **deliveryGroups**

  **StatefulRemoteSubscribable\<DeliveryGroup\[]>**

  **required**

  A list of delivery groups containing information about the delivery of the items the customer intends to purchase.

### DeliveryGroup

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

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOptionReference
  ```

* targetedCartLines

  The cart line references associated to the delivery group.

  ```ts
  CartLineReference[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### CartLineReference

Represents a reference to a cart line.

* id

  The unique identifier of the referenced cart line.

  ```ts
  string
  ```

## use​Delivery​Group(**[deliveryGroup](#usedeliverygroup-propertydetail-deliverygroup)**​)

Returns the full expanded details of a delivery group and automatically re-renders your component when that delivery group changes.

### Parameters

* **deliveryGroup**

  **any**

  **required**

### Returns

* **DeliveryGroupDetails | undefined**

### DeliveryGroupDetails

Represents a DeliveryGroup with expanded reference fields and full details.

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOption
  ```

* targetedCartLines

  The cart lines associated to the delivery group.

  ```ts
  CartLine[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### CartLine

* attributes

  The line item additional custom attributes.

  ```ts
  Attribute[]
  ```

* cost

  The details about the cost components attributed to the cart line.

  ```ts
  CartLineCost
  ```

* discountAllocations

  Discounts applied to the cart line.

  ```ts
  CartDiscountAllocation[]
  ```

* id

  These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to \`applyCartLinesChange\` because you'll need the ID to create a \`CartLineChange\` object.

  ```ts
  string
  ```

* lineComponents

  Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.

  ```ts
  CartBundleLineComponent[]
  ```

* merchandise

  The merchandise being purchased.

  ```ts
  Merchandise
  ```

* quantity

  The quantity of the merchandise being purchased.

  ```ts
  number
  ```

### Attribute

* key

  The key for the attribute.

  ```ts
  string
  ```

* value

  The value for the attribute.

  ```ts
  string
  ```

### CartLineCost

* totalAmount

  The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line.

  ```ts
  Money
  ```

### CartDiscountAllocation

```ts
CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation
```

### CartCodeDiscountAllocation

* code

  The code for the discount

  ```ts
  string
  ```

* discountedAmount

  The money amount that has been discounted from the order

  ```ts
  Money
  ```

* type

  The type of the code discount

  ```ts
  'code'
  ```

### CartAutomaticDiscountAllocation

* discountedAmount

  The money amount that has been discounted from the order

  ```ts
  Money
  ```

* title

  The title of the automatic discount

  ```ts
  string
  ```

* type

  The type of the automatic discount

  ```ts
  'automatic'
  ```

### CartCustomDiscountAllocation

* discountedAmount

  The money amount that has been discounted from the order

  ```ts
  Money
  ```

* title

  The title of the custom discount

  ```ts
  string
  ```

* type

  The type of the custom discount

  ```ts
  'custom'
  ```

### CartBundleLineComponent

* attributes

  Additional custom attributes for the bundle line component.

  ```ts
  Attribute[]
  ```

* cost

  The cost attributed to this bundle line component.

  ```ts
  CartLineCost
  ```

* id

  A unique identifier for the bundle line component. This ID is not stable. If an operation updates the line items in any way, all IDs could change.

  ```ts
  string
  ```

* merchandise

  The merchandise of this bundle line component.

  ```ts
  Merchandise
  ```

* quantity

  The quantity of merchandise being purchased.

  ```ts
  number
  ```

* type

  ```ts
  'bundle'
  ```

### Merchandise

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* image

  Image associated with the product variant. This field falls back to the product image if no image is available.

  ```ts
  ImageDetails
  ```

* product

  The product object that the product variant belongs to.

  ```ts
  Product
  ```

* requiresShipping

  Whether or not the product requires shipping.

  ```ts
  boolean
  ```

* selectedOptions

  List of product options applied to the variant.

  ```ts
  SelectedOption[]
  ```

* sellingPlan

  The selling plan associated with the merchandise.

  ```ts
  SellingPlan
  ```

* sku

  The product variant's sku.

  ```ts
  string
  ```

* subtitle

  The product variant's subtitle.

  ```ts
  string
  ```

* title

  The product variant’s title.

  ```ts
  string
  ```

* type

  ```ts
  'variant'
  ```

### ImageDetails

* altText

  The alternative text for the image.

  ```ts
  string
  ```

* url

  The image URL.

  ```ts
  string
  ```

### Product

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* productType

  A categorization that a product can be tagged with, commonly used for filtering and searching.

  ```ts
  string
  ```

* vendor

  The product’s vendor name.

  ```ts
  string
  ```

### SelectedOption

* name

  The name of the merchandise option.

  ```ts
  string
  ```

* value

  The value of the merchandise option.

  ```ts
  string
  ```

### SellingPlan

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* recurringDeliveries

  Whether purchasing the selling plan will result in multiple deliveries.

  ```ts
  boolean
  ```

## use​Delivery​Groups()

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

### Returns

* **DeliveryGroup\[]**

### DeliveryGroup

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

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOptionReference
  ```

* targetedCartLines

  The cart line references associated to the delivery group.

  ```ts
  CartLineReference[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### CartLineReference

Represents a reference to a cart line.

* id

  The unique identifier of the referenced cart line.

  ```ts
  string
  ```

## Shipping Option

This API object is provided to extensions registered for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` extension targets.

* **isTargetSelected**

  **StatefulRemoteSubscribable\<boolean>**

  **required**

  Whether the shipping option the extension is attached to is currently selected in the UI.

* **renderMode**

  **ShippingOptionItemRenderMode**

  **required**

  The render mode of the shipping option.

* **target**

  **StatefulRemoteSubscribable\<ShippingOption>**

  **required**

  The shipping option the extension is attached to.

### ShippingOptionItemRenderMode

The render mode of a shipping option.

* overlay

  Whether the shipping option is rendered in an overlay.

  ```ts
  boolean
  ```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

## use​Shipping​Option​Target()

Returns the shipping option for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` attached extensions.

### Returns

* **{ shippingOptionTarget: ShippingOption; isTargetSelected: boolean; renderMode: ShippingOptionItemRenderMode; }**

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### ShippingOptionItemRenderMode

The render mode of a shipping option.

* overlay

  Whether the shipping option is rendered in an overlay.

  ```ts
  boolean
  ```

## ShippingOptionListApi

This API object is provided to extensions registered for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` extension targets.

* **deliverySelectionGroups**

  **StatefulRemoteSubscribable< DeliverySelectionGroup\[] | undefined >**

  **required**

  The list of selection groups available to the buyers. The property will be undefined when no such groups are available.

* **target**

  **StatefulRemoteSubscribable\<DeliveryGroupList | undefined>**

  **required**

  The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.

### DeliverySelectionGroup

A selection group for delivery options.

* associatedDeliveryOptions

  The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.

  ```ts
  DeliveryOptionReference[]
  ```

* cost

  The sum of each delivery option's cost.

  ```ts
  Money
  ```

* costAfterDiscounts

  The sum of each delivery option's cost after discounts.

  ```ts
  Money
  ```

* handle

  The handle of the selection group.

  ```ts
  string
  ```

* selected

  If the selection group is selected.

  ```ts
  boolean
  ```

* title

  The localized title of the selection group.

  ```ts
  string
  ```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryGroupList

The delivery group list the extension is associated to.

* deliveryGroups

  The delivery groups that compose this list.

  ```ts
  DeliveryGroup[]
  ```

* groupType

  The group type of the delivery group list.

  ```ts
  DeliveryGroupType
  ```

### DeliveryGroup

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

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOptionReference
  ```

* targetedCartLines

  The cart line references associated to the delivery group.

  ```ts
  CartLineReference[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### CartLineReference

Represents a reference to a cart line.

* id

  The unique identifier of the referenced cart line.

  ```ts
  string
  ```

## use​Delivery​Group​Target()

Returns the delivery group for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions. This is deprecated, use `useDeliveryGroupListTarget()` instead.

### Returns

* **DeliveryGroup | undefined**

### DeliveryGroup

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

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOptionReference
  ```

* targetedCartLines

  The cart line references associated to the delivery group.

  ```ts
  CartLineReference[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### CartLineReference

Represents a reference to a cart line.

* id

  The unique identifier of the referenced cart line.

  ```ts
  string
  ```

## use​Delivery​Group​List​Target()

Returns the delivery group list for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.

### Returns

* **DeliveryGroupList | undefined**

### DeliveryGroupList

The delivery group list the extension is associated to.

* deliveryGroups

  The delivery groups that compose this list.

  ```ts
  DeliveryGroup[]
  ```

* groupType

  The group type of the delivery group list.

  ```ts
  DeliveryGroupType
  ```

### DeliveryGroup

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

* deliveryOptions

  The delivery options available for the delivery group.

  ```ts
  DeliveryOption[]
  ```

* groupType

  The type of the delivery group.

  ```ts
  DeliveryGroupType
  ```

* id

  The unique identifier of the delivery group. On the Thank You page this value is undefined.

  ```ts
  string
  ```

* isDeliveryRequired

  Whether delivery is required for the delivery group.

  ```ts
  boolean
  ```

* selectedDeliveryOption

  The selected delivery option for the delivery group.

  ```ts
  DeliveryOptionReference
  ```

* targetedCartLines

  The cart line references associated to the delivery group.

  ```ts
  CartLineReference[]
  ```

### DeliveryOption

```ts
ShippingOption | PickupPointOption | PickupLocationOption
```

### ShippingOption

Represents a delivery option that is a shipping option.

* carrier

  Information about the carrier.

  ```ts
  ShippingOptionCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost of the delivery.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost of the delivery including discounts.

  ```ts
  Money
  ```

* deliveryEstimate

  Information about the estimated delivery time.

  ```ts
  DeliveryEstimate
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'shipping' | 'local'
  ```

### ShippingOptionCarrier

* name

  The name of the carrier.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

### DeliveryEstimate

* timeInTransit

  The estimated time in transit for the delivery in seconds.

  ```ts
  NumberRange
  ```

### NumberRange

* lower

  The lower bound of the number range.

  ```ts
  number
  ```

* upper

  The upper bound of the number range.

  ```ts
  number
  ```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

### PickupPointOption

* carrier

  Information about the carrier that ships to the pickup point.

  ```ts
  PickupPointCarrier
  ```

* code

  The code of the delivery option.

  ```ts
  string
  ```

* cost

  The cost to ship to this pickup point.

  ```ts
  Money
  ```

* costAfterDiscounts

  The cost to ship to this pickup point including discounts.

  ```ts
  Money
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup point.

  ```ts
  PickupPointLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickupPoint'
  ```

### PickupPointCarrier

* code

  The code identifying the carrier.

  ```ts
  string
  ```

* name

  The name of the carrier.

  ```ts
  string
  ```

### PickupPointLocation

* address

  The address of the pickup point.

  ```ts
  MailingAddress
  ```

* handle

  The unique identifier of the pickup point.

  ```ts
  string
  ```

* name

  The name of the pickup point.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### DeliveryGroupType

The possible types of a delivery group.

```ts
'oneTimePurchase' | 'subscription'
```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### CartLineReference

Represents a reference to a cart line.

* id

  The unique identifier of the referenced cart line.

  ```ts
  string
  ```

## use​Delivery​Selection​Groups()

Returns the delivery selection groups for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.

### Returns

* **| DeliverySelectionGroup\[] | undefined**

### DeliverySelectionGroup

A selection group for delivery options.

* associatedDeliveryOptions

  The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.

  ```ts
  DeliveryOptionReference[]
  ```

* cost

  The sum of each delivery option's cost.

  ```ts
  Money
  ```

* costAfterDiscounts

  The sum of each delivery option's cost after discounts.

  ```ts
  Money
  ```

* handle

  The handle of the selection group.

  ```ts
  string
  ```

* selected

  If the selection group is selected.

  ```ts
  boolean
  ```

* title

  The localized title of the selection group.

  ```ts
  string
  ```

### DeliveryOptionReference

Represents a reference to a delivery option.

* handle

  The unique identifier of the referenced delivery option.

  ```ts
  string
  ```

### Money

* amount

  The price amount.

  ```ts
  number
  ```

* currencyCode

  The ISO 4217 format for the currency.

  ```ts
  CurrencyCode
  ```

### CurrencyCode

```ts
'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
```

## PickupPointListApi

This API object is provided to extensions registered for the `purchase.checkout.pickup-point-list.render-after` and `purchase.checkout.pickup-point-list.render-after` extension target.

* **isLocationFormVisible**

  **StatefulRemoteSubscribable\<boolean>**

  **required**

  Whether the customer location input form is shown to the buyer.

## PickupLocationListApi

This API object is provided to extensions registered for the `purchase.checkout.pickup-location-list.render-after` and `purchase.checkout.pickup-location-list.render-after` extension target.

* **isLocationFormVisible**

  **StatefulRemoteSubscribable\<boolean>**

  **required**

  Whether the customer location input form is shown to the buyer.

## PickupLocationItemApi

The API object provided to the `purchase.checkout.pickup-location-option-item.render-after` extension target.

* **isTargetSelected**

  **StatefulRemoteSubscribable\<boolean>**

  **required**

  Whether the pickup location is currently selected.

* **target**

  **StatefulRemoteSubscribable\<PickupLocationOption>**

  **required**

  The pickup location the extension is attached to.

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

## use​Pickup​Location​Option​Target()

Returns the pickup location option for `purchase.checkout.pickup-location-option-item.render-after` attached extensions.

### Returns

* **{ pickupLocationOptionTarget: PickupLocationOption; isTargetSelected: boolean; }**

### PickupLocationOption

* code

  The code of the delivery option.

  ```ts
  string
  ```

* description

  The description of the delivery option.

  ```ts
  string
  ```

* handle

  The unique identifier of the delivery option.

  ```ts
  string
  ```

* location

  The location details of the pickup location.

  ```ts
  PickupLocation
  ```

* metafields

  The metafields associated with this delivery option.

  ```ts
  Metafield[]
  ```

* title

  The title of the delivery option.

  ```ts
  string
  ```

* type

  The type of this delivery option.

  ```ts
  'pickup'
  ```

### PickupLocation

* address

  The address of the pickup location.

  ```ts
  MailingAddress
  ```

* name

  The name of the pickup location.

  ```ts
  string
  ```

### MailingAddress

* address1

  The first line of the buyer's address, including street name and number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* address2

  The second line of the buyer's address, like apartment number, suite, etc. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* city

  The buyer's city. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* company

  The buyer's company name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* countryCode

  The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www\.iso.org/iso-3166-country-codes.html. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  CountryCode
  ```

* firstName

  The buyer's first name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* lastName

  The buyer's last name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* name

  The buyer's full name. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* phone

  The buyer's phone number. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* provinceCode

  The buyer's province code, such as state, province, prefecture, or region. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

* zip

  The buyer's postal or ZIP code. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data).

  ```ts
  string
  ```

### CountryCode

```ts
'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'
```

### Metafield

Metadata associated with the checkout.

* key

  The name of the metafield. It must be between 3 and 30 characters in length (inclusive).

  ```ts
  string
  ```

* namespace

  A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive).

  ```ts
  string
  ```

* value

  The information to be stored as metadata.

  ```ts
  string | number
  ```

* valueType

  The metafield’s information type.

  ```ts
  'integer' | 'string' | 'json_string'
  ```

Examples

### Examples

* #### Delivery group

  ##### React

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

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

  function Extension() {
    const deliveryGroups = useDeliveryGroups();
    const firstDeliveryGroup = useDeliveryGroup(
      deliveryGroups[0],
    );

    if (!firstDeliveryGroup) {
      return null;
    }

    const selectedDeliveryOption =
      firstDeliveryGroup?.selectedDeliveryOption;

    return (
      <Banner>
        Selected delivery option:{' '}
        {selectedDeliveryOption?.title}
      </Banner>
    );
  }
  ```

* #### Reading the selected shipping option

  ##### React

  ```jsx
  import {
    reactExtension,
    Text,
    useShippingOptionTarget,
  } from '@shopify/ui-extensions-react/checkout';

  export default reactExtension(
    'purchase.checkout.shipping-option-item.render-after',
    () => <Extension />,
  );

  function Extension() {
    const {shippingOptionTarget, isTargetSelected} =
      useShippingOptionTarget();
    const title = shippingOptionTarget.title;

    return (
      <Text>
        Shipping method: {title} is{' '}
        {isTargetSelected ? '' : 'not'} selected.
      </Text>
    );
  }
  ```

  ##### JavaScript

  ```js
  import {extension} from '@shopify/ui-extensions/checkout';

  export default extension(
    'purchase.checkout.shipping-option-item.render-after',
    (root, {target, isTargetSelected}) => {
      const titleText = root.createText(
        `Shipping method title: ${target.current.title}`,
      );
      root.appendChild(titleText);

      target.subscribe((updatedTarget) => {
        titleText.updateText(
          `Shipping method title: ${updatedTarget.title}`,
        );
      });

      const selectedText = root.createText(
        getSelectedText(isTargetSelected),
      );
      root.appendChild(selectedText);

      isTargetSelected.subscribe(
        (updatedSelected) => {
          selectedText.updateText(
            getSelectedText(updatedSelected),
          );
        },
      );

      function getSelectedText(selected) {
        return selected
          ? 'Selected'
          : 'Not selected';
      }
    },
  );
  ```

* #### Reading the selected pickup location option

  ##### React

  ```jsx
  import {
    reactExtension,
    Text,
    usePickupLocationOptionTarget,
  } from '@shopify/ui-extensions-react/checkout';

  export default reactExtension(
    'purchase.checkout.pickup-location-option-item.render-after',
    () => <Extension />,
  );

  function Extension() {
    const {
      isTargetSelected,
      pickupLocationOptionTarget,
    } = usePickupLocationOptionTarget();

    const title = pickupLocationOptionTarget?.title;

    if (isTargetSelected) {
      return <Text>{title}</Text>;
    }

    return null;
  }
  ```

  ##### JavaScript

  ```js
  import {extension} from '@shopify/ui-extensions/checkout';

  export default extension(
    'purchase.checkout.pickup-location-option-item.render-after',
    (root, {isTargetSelected, target}) => {
      const titleText = root.createText(
        target.current.title,
      );
      root.appendChild(titleText);

      target.subscribe((updatedTarget) => {
        titleText.updateText(
          updatedTarget.title || '',
        );
      });

      const selectedText = root.createText(
        getSelectedText(isTargetSelected),
      );
      root.appendChild(selectedText);

      isTargetSelected.subscribe(
        (updatedSelected) => {
          selectedText.updateText(
            getSelectedText(updatedSelected),
          );
        },
      );

      function getSelectedText(selected) {
        return selected
          ? 'Selected'
          : 'Not selected';
      }
    },
  );
  ```

* #### Determine if the location input form is shown

  ##### React

  ```jsx
  import {
    reactExtension,
    useApi,
    useSubscription,
    Text,
  } from '@shopify/ui-extensions-react/checkout';

  export default reactExtension(
    'purchase.checkout.pickup-point-list.render-before',
    () => <Extension />,
  );

  function Extension() {
    const {isLocationFormVisible} =
      useApi<'purchase.checkout.pickup-point-list.render-before'>();

    const locationFormShown = useSubscription(
      isLocationFormVisible,
    );

    if (locationFormShown) {
      return (
        <Text>
          The customer is being asked to provide
          their location.
        </Text>
      );
    } else {
      return (
        <Text>Pickup points are being shown.</Text>
      );
    }
  }
  ```

  ##### JavaScript

  ```js
  import {extension} from '@shopify/ui-extensions/checkout';

  export default extension(
    'purchase.checkout.pickup-point-list.render-before',
    (root, {isLocationFormVisible}) => {
      const content = root.createText(
        getTextContent(
          isLocationFormVisible.current,
        ),
      );
      root.appendChild(content);

      isLocationFormVisible.subscribe(
        (updatedLocationFormVisible) => {
          content.updateText(
            getTextContent(
              updatedLocationFormVisible,
            ),
          );
        },
      );

      function getTextContent(
        isLocationFormVisible,
      ) {
        if (isLocationFormVisible) {
          return 'The customer is being asked to provide their location.';
        } else {
          return 'Pickup points are being shown.';
        }
      }
    },
  );
  ```

* #### Delivery groups

  ##### React

  ```jsx
  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>
    );
  }
  ```

## Related

[Reference - Targets](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

[Reference - Components](https://shopify.dev/docs/api/checkout-ui-extensions/components)

[Reference - Configuration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

[Learn - Tutorials](https://shopify.dev/apps/checkout)