Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Glossary — delivery-promise-components
vtex.delivery-promise-components
Version: 1.1.4
Latest version: 1.1.4

Domain terms used across this app, its documentation, and the Delivery Promise platform.

TermDefinition
Delivery PromiseVTEX platform service that provides real-time delivery and pickup availability based on a shopper's location. Currently in closed beta.
Postal code (CEP)A location identifier entered by the shopper or detected via geolocation. Required for Delivery Promise to determine available shipping options.
Shopper locationThe postal code (and optionally geolocation-derived address) that identifies where a shopper wants items delivered or where they will pick them up.
Shipping methodThe fulfillment mode chosen by the shopper: delivery (shipped to address) or pickup (collected at a physical point).
Pickup pointA physical store or collection point where shoppers can retrieve their order. Displayed and selectable via pickup-point-selector.
RegionalizationThe VTEX platform feature that filters catalog availability and pricing based on the shopper's location. Required for Delivery Promise components to work correctly.
DeliveryPromiseProviderThe React context provider that wraps the store (e.g., via StoreWrapper) and shares delivery promise state across all blocks.
DeliveryPromiseContextThe internal React context exposed by DeliveryPromiseProvider; holds postalCode, deliveryPromiseMethod, shippingMethodModalRequestId, and related state.
effectiveReloadWhether a successful postal code submission should trigger location.reload(). Deferred when a required shipping-method-selector is mounted.
Block registryRuntime record of mounted blocks and their required flags. shopper-location-setter registers REGISTER_SHOPPER_LOCATION_BLOCK; shipping-method-selector registers REGISTER_SHIPPING_METHOD_BLOCK.
shippingMethodModalRequestIdIncrementing counter in context; shipping-method-selector opens its modal when this value changes and a postal code is present.
PickupModalPresentationalExported controlled component for integrations that need only the pickup UI without UPDATE_ZIPCODE or session side effects.
pickupSearchClientExported utility for fetching pickup points from the platform.
pickupInPointPreferenceExported utility for persisting a shopper's pickup-in-point preference in the host app.
vtex-test-toolsVTEX's Jest wrapper (@vtex/test-tools) used for the React builder test suite.
ToolbeltThe VTEX CLI (vtex). Used for authentication, workspace management, vtex link, vtex publish, and vtex deploy.
BuilderA VTEX IO platform module that validates and packages a specific folder (e.g., react, store, messages) into the platform app.
vtex linkToolbelt command that uploads the app to the active development workspace and starts a file-watch loop.
CSS handlesStable class name anchors exported by the app for store theme CSS customization. Defined in the React components and documented in docs/README.md.
See also
Vtex.delivery Promise Components
VTEX IO Apps
VTEX App Store
VTEX IO Apps
Was this helpful?