Managing Shipping Form Fields in Checkout
This guide helps Salesforce admins control which fields appear in the shipping address section during checkout, and how to use the Checkout Shipping Field custom metadata type to add or manage these fields.
Overview
If you need to collect additional information from customers during checkout—beyond the standard address fields—you can add extra fields from the Shipment or Account objects to the shipping form. This is managed through the Checkout Shipping Field custom metadata type.
How to Add or Remove Shipping Fields
- Go to Salesforce Setup.
- Search for Custom Metadata Types.
- Click Manage Records for the custom metadata type Checkout Shipping Field.
- Add a new record by clicking the New button.
- Enter the required values for your use case (see field descriptions below).
- Click Save.
To remove a field, find it in the list and click Delete next to it.
Field Descriptions
| Field | Type | Description |
|---|---|---|
| Label | Text | User-friendly name of the record. |
| Checkout Shipping Field Name | Text | Unique technical name of the record. |
| Shipment Field Name | Picklist | Select the field from the Shipment object to display in the shipping form. |
| Web Order Field | Text | (Optional) The field name of a web order field. Not required if 'Prepopulated Account Field' is set. |
| Prepopulated Account Field | Text | (Optional) The field name of an account field. Not required if 'Web Order Field' is set. |
| Order | Number | Used to display the shipping fields in order. Lower numbers appear higher in the form. |
| Hide | Checkbox | If checked, the field will be hidden in the UI. |
| Required | Checkbox | If checked, the field must be filled in by the user. |
| Read Only | Checkbox | If checked, the field will be shown but cannot be edited by the user. |
| Prefill | Checkbox | If checked, the field will be pre-filled with available data if possible. |
Tip: You do not need to enter API names—just select from the available options in the dropdowns where possible.
How These Fields Are Used
- The fields you add here are shown in the shipping form during checkout.
- The Shipment Field Name you select is mapped to the corresponding field on the Shipment object and shown to the user.
- The Web Order Field and Prepopulated Account Field options allow you to prefill values from related objects if needed.
- The Order field controls the display order of fields in the form.
- The Required, Read Only, Prefill, and Hide options control how the field behaves in the form:
- Required: User must fill in the field to continue.
- Read Only: User can see but not change the value.
- Prefill: The form will try to fill in the value automatically if possible.
- Hide: The field will not be shown in the UI.
What Happens Next
- The fields you add will appear in the shipping form for users at checkout.
- The fields you remove will no longer be shown.
- No code changes or deployments are needed—just update the list and save.
Tips
- You can add custom fields (like “Delivery Instructions”) if they are available in the dropdown and are part of the Shipment object.
- Changes take effect the next time the shipping form is loaded.
This lets you easily manage which shipping details are collected from customers, using simple labels and clicks. All fields must be on the Shipment object to be available for selection. The options you set for each field control how it appears and behaves for users during checkout.