This guide describes how to display individual shipping estimates for items in a customer's cart on an ecommerce platform using the Checkout API.
To enhance the customer experience, some stores may want to display precise shipping estimates for each item in the customer's cart. This can be particularly useful for ecommerce platforms that have sellers with different shipping capabilities and delivery times. This guide will walk through the process of displaying the Service Level Agreement (SLA) by item using the Checkout API.
Enable the useIndividualShippingEstimates flag
First, it is necessary to enable the Checkout API behavior to fill the shippingEstimateDate with the SLA information. To do so, you must update the store's orderForm with the Update orderForm configuration endpoint. You must include the flag useIndividualShippingEstimates to true as in the example shown.
By enabling this flag, the shippingEstimateDate will be updated with the SLA information configured by the sellers.
Add items to cart
Once you enable the useIndividualShippingEstimates, test if the configuration is correct by adding items to a shopping cart using the Add cart items endpoint. See the request body example presented.
Send shipping data attachment
Send the item shipping data to the orderForm using the Add shipping address and select delivery option endpoint as in the example shown.
Once configured, the orderForm will retrieve the variable shippingEstimateDate, which will display the shipping estimate date instead of only the shipping estimate in business days.
Enable the useIndividualShippingEstimates flag
First, it is necessary to enable the Checkout API behavior to fill the shippingEstimateDate with the SLA information. To do so, you must update the store's orderForm with the Update orderForm configuration endpoint. You must include the flag useIndividualShippingEstimates to true as in the example shown.
By enabling this flag, the shippingEstimateDate will be updated with the SLA information configured by the sellers.
Add items to cart
Once you enable the useIndividualShippingEstimates, test if the configuration is correct by adding items to a shopping cart using the Add cart items endpoint. See the request body example presented.
Send shipping data attachment
Send the item shipping data to the orderForm using the Add shipping address and select delivery option endpoint as in the example shown.
Once configured, the orderForm will retrieve the variable shippingEstimateDate, which will display the shipping estimate date instead of only the shipping estimate in business days.