Custom fields

You can collect additional customer information or block checkout with the custom field Checkout Block. Custom fields can be required or option and support a variety of input types including text, dropdown, checkbox, date picker, birthday, and more.

Save custom fields to order

All custom fields will save to the order as either an order metafield, order attribute, or the order note. We recommend using order metafields when possible as they are the most robust way of storing and retrieving custom data on orders within Shopify.

Order metafields

When saving custom fields to order metafields, the namespace using is checkoutblocks and the key is defined when you add a custom field to the block:

You can optionally create metafield definitions to surface specific custom fields directly on the order detail page.

However, it's important to note that the metafield definition type that you choose is extremely important and setting a metafield type that does not support your custom field's data type can result in checkout being completely blocked for customers. When in doubt, we recommend using "single line text" or "multi line text":

Order notes

When saving custom fields to order notes, any existing content is completely replaced with your custom field. A benefit of using the order notes type is that it will show existing order notes entered in the cart within checkout automatically. This ensure consistency across the checkout funnel for specific use cases such as order notes or delivery notes.