# checkout_address_info_submitted

The `checkout_address_info_submitted` event logs an instance of a customer submitting their mailing address. This event is only available in checkouts where Checkout Extensibility for customizations is enabled
### Accessing Standard Events

```javascript
import {register} from '@shopify/web-pixels-extension';

register(({analytics}) => {
  analytics.subscribe('checkout_address_info_submitted', (event) => {
    // Example for accessing event data
    const checkout = event.data.checkout;

    const payload = {
      event_name: event.name,
      event_data: {
        addressLine1: checkout.shippingAddress?.address1,
        addressLine2: checkout.shippingAddress?.address2,
        city: checkout.shippingAddress?.city,
        country: checkout.shippingAddress?.country,
      },
    };

    // Example for sending event to third party servers
    fetch('https://example.com/pixel', {
      method: 'POST',
      body: JSON.stringify(payload),
      keepalive: true,
    });
  });
});

```

```javascript
analytics.subscribe('checkout_address_info_submitted', (event) => {
  // Example for accessing event data
  const checkout = event.data.checkout;

  const payload = {
    event_name: event.name,
    event_data: {
      addressLine1: checkout.shippingAddress?.address1,
      addressLine2: checkout.shippingAddress?.address2,
      city: checkout.shippingAddress?.city,
      country: checkout.shippingAddress?.country,
    },
  };

  // Example for sending event to third party servers
  fetch('https://example.com/pixel', {
    method: 'POST',
    event_data: JSON.stringify(payload),
    keepalive: true,
  });
});

```



## Properties


### PixelEventsCheckoutAddressInfoSubmitted
The `checkout_address_info_submitted` event logs an instance of a customer submitting their mailing address. This event is only available in checkouts where Checkout Extensibility for customizations is enabled

### clientId

value: `string`

The client-side ID of the customer, provided by Shopify

### context

value: `Context`



### data

value: `PixelEventsCheckoutAddressInfoSubmittedData`



### id

value: `string`

The ID of the customer event

### name

value: `string`

The name of the customer event

### seq

value: `number`

The sequence index number of the event.

### timestamp

value: `string`

The timestamp of when the customer event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format

### type

value: `EventType.Standard`



### Context
A snapshot of various read-only properties of the browser at the time of event

### document

value: `WebPixelsDocument`

Snapshot of a subset of properties of the `document` object in the top frame of the browser

### navigator

value: `WebPixelsNavigator`

Snapshot of a subset of properties of the `navigator` object in the top frame of the browser

### window

value: `WebPixelsWindow`

Snapshot of a subset of properties of the `window` object in the top frame of the browser

### WebPixelsDocument
A snapshot of a subset of properties of the `document` object in the top frame of the browser

### characterSet

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the character set being used by the document

### location

value: `Location`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the current document

### referrer

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the page that linked to this page

### title

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the title of the current document

### Location
A snapshot of a subset of properties of the `location` object in the top frame of the browser

### hash

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'#'` followed by the fragment identifier of the URL

### host

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the host, that is the hostname, a `':'`, and the port of the URL

### hostname

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the domain of the URL

### href

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the entire URL

### origin

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the canonical form of the origin of the specific location

### pathname

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing an initial `'/'` followed by the path of the URL, not including the query string or fragment

### port

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the port number of the URL

### protocol

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the protocol scheme of the URL, including the final `':'`

### search

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'?'` followed by the parameters or "querystring" of the URL

### WebPixelsNavigator
A snapshot of a subset of properties of the `navigator` object in the top frame of the browser

### cookieEnabled

value: `boolean`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns `false` if setting a cookie will be ignored and true otherwise

### language

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns a string representing the preferred language of the user, usually the language of the browser UI. The `null` value is returned when this is unknown

### languages

value: `ReadonlyArray<string>`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns an array of strings representing the languages known to the user, by order of preference

### userAgent

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns the user agent string for the current browser

### WebPixelsWindow
A snapshot of a subset of properties of the `window` object in the top frame of the browser

### innerHeight

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the content area of the browser window including, if rendered, the horizontal scrollbar

### innerWidth

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the content area of the browser window including, if rendered, the vertical scrollbar

### location

value: `Location`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the location, or current URL, of the window object

### origin

value: `string`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the global object's origin, serialized as a string

### outerHeight

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the outside of the browser window

### outerWidth

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the outside of the browser window

### pageXOffset

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollX

### pageYOffset

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollY

### screen

value: `Screen`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen), the interface representing a screen, usually the one on which the current window is being rendered

### screenX

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the horizontal distance from the left border of the user's browser viewport to the left side of the screen

### screenY

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the vertical distance from the top border of the user's browser viewport to the top side of the screen

### scrollX

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled horizontally

### scrollY

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled vertically

### Screen
The interface representing a screen, usually the one on which the current window is being rendered

### height

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/height), the height of the screen

### width

value: `number`

Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/width), the width of the screen

### PixelEventsCheckoutAddressInfoSubmittedData


### checkout

value: `Checkout`



### Checkout
A container for all the information required to add items to checkout and pay.

### attributes

value: `Attribute[]`

A list of attributes accumulated throughout the checkout process.

### billingAddress

value: `MailingAddress | null`

The billing address to where the order will be charged.

### buyerAcceptsEmailMarketing

value: `boolean`

Indicates whether the customer has consented to be sent marketing material via email. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### buyerAcceptsSmsMarketing

value: `boolean`

Indicates whether the customer has consented to be sent marketing material via SMS. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### currencyCode

value: `string | null`

The three-letter code that represents the currency, for example, USD. Supported codes include standard ISO 4217 codes, legacy codes, and non- standard codes.

### delivery

value: `Delivery | null`

Represents the selected delivery options for a checkout. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### discountApplications

value: `DiscountApplication[]`

A list of discount applications.

### discountsAmount

value: `MoneyV2 | null`

The total amount of the discounts applied to the price of the checkout. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### email

value: `string | null`

The email attached to this checkout.

### lineItems

value: `CheckoutLineItem[]`

A list of line item objects, each one containing information about an item in the checkout.

### localization

value: `Localization`

Information about the active localized experience. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### order

value: `Order | null`

The resulting order from a paid checkout.

### phone

value: `string | null`

A unique phone number for the customer. Formatted using E.164 standard. For example, *+16135551111*.

### shippingAddress

value: `MailingAddress | null`

The shipping address to where the line items will be shipped.

### shippingLine

value: `ShippingRate | null`

Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object.

### smsMarketingPhone

value: `string | null`

The phone number provided by the buyer after opting in to SMS marketing. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### subtotalPrice

value: `MoneyV2 | null`

The price at checkout before duties, shipping, and taxes.

### token

value: `string | null`

A unique identifier for a particular checkout.

### totalPrice

value: `MoneyV2 | null`

The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts.

### totalTax

value: `MoneyV2`

The sum of all the taxes applied to the line items and shipping lines in the checkout.

### transactions

value: `Transaction[]`

A list of transactions associated with a checkout or order. Certain transactions, such as credit card transactions, may only be present in the checkout_completed event.

### Attribute
Custom attributes associated with the cart or checkout.

### key

value: `string`

The key for the attribute.

### value

value: `string`

The value for the attribute.

### MailingAddress
A mailing address for customers and shipping.

### address1

value: `string | null`

The first line of the address. This is usually the street address or a P.O. Box number.

### address2

value: `string | null`

The second line of the address. This is usually an apartment, suite, or unit number.

### city

value: `string | null`

The name of the city, district, village, or town.

### country

value: `string | null`

The name of the country.

### countryCode

value: `string | null`

The two-letter code that represents the country, for example, US. The country codes generally follows ISO 3166-1 alpha-2 guidelines.

### firstName

value: `string | null`

The customer’s first name.

### lastName

value: `string | null`

The customer’s last name.

### phone

value: `string | null`

The phone number for this mailing address as entered by the customer.

### province

value: `string | null`

The region of the address, such as the province, state, or district.

### provinceCode

value: `string | null`

The two-letter code for the region. For example, ON.

### zip

value: `string | null`

The ZIP or postal code of the address.

### Delivery
The delivery information for the event.

### selectedDeliveryOptions

value: `DeliveryOption[]`

The selected delivery options for the event.

### DeliveryOption
Represents a delivery option that the customer can choose from.

### cost

value: `MoneyV2 | null`

The cost of the delivery option.

### costAfterDiscounts

value: `MoneyV2 | null`

The cost of the delivery option after discounts have been applied.

### description

value: `string | null`

The description of the delivery option.

### handle

value: `string`

The unique identifier of the delivery option.

### title

value: `string | null`

The title of the delivery option.

### type

value: `string`

The type of delivery option.

- `pickup`
- `pickupPoint`
- `shipping`
- `local`

### MoneyV2
A monetary value with currency.

### amount

value: `number`

The decimal money amount.

### currencyCode

value: `string`

The three-letter code that represents the currency, for example, USD. Supported codes include standard ISO 4217 codes, legacy codes, and non- standard codes.

### DiscountApplication
The information about the intent of the discount.

### allocationMethod

value: `string`

The method by which the discount's value is applied to its entitled items.

- `ACROSS`: The value is spread across all entitled lines.
- `EACH`: The value is applied onto every entitled line.

### targetSelection

value: `string`

How the discount amount is distributed on the discounted lines.

- `ALL`: The discount is allocated onto all the lines.
- `ENTITLED`: The discount is allocated onto only the lines that it's entitled for.
- `EXPLICIT`: The discount is allocated onto explicitly chosen lines.

### targetType

value: `string`

The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.

- `LINE_ITEM`: The discount applies onto line items.
- `SHIPPING_LINE`: The discount applies onto shipping lines.

### title

value: `string`

The customer-facing name of the discount. If the type of discount is a `DISCOUNT_CODE`, this `title` attribute represents the code of the discount.

### type

value: `string`

The type of the discount.

- `AUTOMATIC`: A discount automatically at checkout or in the cart without the need for a code.
- `DISCOUNT_CODE`: A discount applied onto checkouts through the use of a code.
- `MANUAL`: A discount that is applied to an order by a merchant or store owner manually, rather than being automatically applied by the system or through a script.
- `SCRIPT`: A discount applied to a customer's order using a script

### value

value: `MoneyV2 | PricingPercentageValue`

The value of the discount. Fixed discounts return a `Money` Object, while Percentage discounts return a `PricingPercentageValue` object.

### PricingPercentageValue
A value given to a customer when a discount is applied to an order. The application of a discount with this value gives the customer the specified percentage off a specified item.

### percentage

value: `number`

The percentage value of the object.

### CheckoutLineItem
A single line item in the checkout, grouped by variant and attributes.

### discountAllocations

value: `DiscountAllocation[]`

The discounts that have been applied to the checkout line item by a discount application.

### finalLinePrice

value: `MoneyV2`

The combined price of all of the items in the line item after line-level discounts have been applied. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### id

value: `string | null`

A globally unique identifier.

### properties

value: `Property[]`

The properties of the line item. A shop may add, or enable customers to add custom information to a line item. Line item properties consist of a key and value pair. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### quantity

value: `number`

The quantity of the line item.

### sellingPlanAllocation

value: `SellingPlanAllocation | null`

The selling plan associated with the line item and the effect that each selling plan has on variants when they're purchased. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### title

value: `string | null`

The title of the line item. Defaults to the product's title.

### variant

value: `ProductVariant | null`

Product variant of the line item.

### DiscountAllocation
The discount that has been applied to the checkout line item.

### amount

value: `MoneyV2`

The monetary value with currency allocated to the discount.

### discountApplication

value: `DiscountApplication`

The information about the intent of the discount.

### Property
The line item additional custom properties.

### key

value: `string`

The key for the property.

### value

value: `string`

The value for the property.

### SellingPlanAllocation
Represents an association between a variant and a selling plan.

### sellingPlan

value: `SellingPlan`

A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.

### SellingPlan
Represents how products and variants can be sold and purchased.

### id

value: `string`

A globally unique identifier.

### name

value: `string`

The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

### ProductVariant
A product variant represents a different version of a product, such as differing sizes or differing colors.

### id

value: `string | null`

A globally unique identifier.

### image

value: `Image | null`

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

### price

value: `MoneyV2`

The product variant’s price.

### product

value: `Product`

The product object that the product variant belongs to.

### sku

value: `string | null`

The SKU (stock keeping unit) associated with the variant.

### title

value: `string | null`

The product variant’s title.

### untranslatedTitle

value: `string | null`

The product variant’s untranslated title.

### Image
An image resource.

### src

value: `string | null`

The location of the image as a URL.

### Product
A product is an individual item for sale in a Shopify store.

### id

value: `string | null`

The ID of the product.

### title

value: `string`

The product’s title.

### type

value: `string | null`

The [product type](https://help.shopify.com/en/manual/products/details/product-type) specified by the merchant.

### untranslatedTitle

value: `string | null`

The product’s untranslated title.

### url

value: `string | null`

The relative URL of the product.

### vendor

value: `string`

The product’s vendor name.

### Localization
Information about the active localized experience.

### country

value: `Country`

The country of the active localized experience.

### language

value: `Language`

The language of the active localized experience.

### market

value: `Market`

The market including the country of the active localized experience.

### Country
A country.

### isoCode

value: `string | null`

The ISO-3166-1 code for this country, for example, "US".

### Language
A language.

### isoCode

value: `string`

The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code, for example, "en-US".

### Market
A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [this](https://shopify.dev/docs/apps/markets) conceptual overview.

### handle

value: `string | null`

A human-readable, shop-scoped identifier.

### id

value: `string | null`

A globally unique identifier.

### Order
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process.

### customer

value: `OrderCustomer | null`

The customer that placed the order.

### id

value: `string | null`

The ID of the order. ID will be null for all events except checkout_completed.

### OrderCustomer
The customer that placed the order.

### id

value: `string | null`

The ID of the customer.

### isFirstOrder

value: `boolean | null`

Indicates if the order is the customer’s first order. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### ShippingRate
A shipping rate to be applied to a checkout.

### price

value: `MoneyV2`

Price of this shipping rate.

### Transaction
A transaction associated with a checkout or order.

### amount

value: `MoneyV2`

The monetary value with currency allocated to the transaction method.

### gateway

value: `string`

The name of the payment provider used for the transaction.

### paymentMethod

value: `TransactionPaymentMethod`

The payment method used for the transaction. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### TransactionPaymentMethod
The payment method used for the transaction. This property is only available if the shop has [upgraded to Checkout Extensibility](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-upgrade).

### name

value: `string`

The name of the payment method used for the transaction. This may further specify the payment method used.

### type

value: `string`

The type of payment method used for the transaction.

- `creditCard`: A vaulted or manually entered credit card.
- `redeemable`: A redeemable payment method, such as a gift card or store credit.
- `deferred`: A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment later.
- `local`: A [local payment method](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market.
- `manualPayment`: A manual payment method, such as an in-person retail transaction.
- `paymentOnDelivery`: A payment that will be collected on delivery.
- `wallet`: An integrated wallet, such as PayPal, Google Pay, Apple Pay, etc.
- `offsite`: A payment processed outside of Shopify's checkout, excluding integrated wallets.
- `customOnSite`: A custom payment method that is processed through a checkout extension with a payments app.
- `other`: Another type of payment not defined here.

### EventType


### AdvancedDom

value: `advanced-dom`



### Custom

value: `custom`



### Dom

value: `dom`



### Meta

value: `meta`



### Standard

value: `standard`