Rename description of delivery option

[Friedrich]

Hello,

we use delivery customizations to add custom information to a delivery option depending on some metafields of products in the cart (e.g. "DHL Express - delivery time up to 10 days (preorder)").

Our external ERP software gets the renamed delivery option and not the original one, and creates a new one everytime it doesn't know the delivery option. So we get a lot of "different" delivery options that need to be mapped manually to the correct one (e.g. "DHL Express - delivery time up to 10 days (preorder)", "DHL Express - delivery time up to 9 days (preorder)", "DHL Express - delivery time up to 8 days (preorder)", ...).

The reason is probably, that the deliveryMethod of the FulfillmentOrder only has the presentedName field and this is probably used by our ERP software (https://shopify.dev/docs/api/admin-graphql/2024-10/objects/DeliveryMethod).

Currently it is only possible to rename the title (https://shopify.dev/docs/api/functions/reference/delivery-customization/graphql/common-objects/renam...). But the CartDeliveryOption also describes a description

 (https://shopify.dev/docs/api/functions/reference/delivery-customization/graphql/common-objects/cartd...). Is it possible to "rename" or "add" the description of the delivery option?

In the "Add rate" form of the shipping/profiles settings page I can create a "Custom" shipping rate and set a "Custom delivery description". But I cannot find any information about this in the GraphQL Admin API (https://shopify.dev/docs/api/admin-graphql) nor in the "delivery options function" tutorial.

Thanks for any hints! 

[_amal · Accepted solution]

Regarding your inquiry, the Delivery Customization API can be used for renaming, reordering, and hiding delivery options during checkout; however, it currently does not allow for adding descriptions directly.

Using the UI Extension, you can add a description below the shipping option through the UI Extension API:

Reference:
https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/apis/delivery
https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/apis/metafields
https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/extension-targets-overviewCheckout Locations Shipping