Order status

Custom step names

You can change the default "Title" and "Help Text" used in the order steps by setting them via URL parameter on each step.

📘
Custom Title and Help Text with Locales
Beware that custom Title and Help Text are not affected by locale configurations

We recommend configuring also the language parameter when using custom step names, to avoid mixing the language of the content, retrieved from the browser, and the titles you are presenting.

📘
URL Params Encoding
Remember that we require to comply with (UTF-8) encoding when sending query params. so that if your custom name string has whitespace, you should replace it with the symbol "%20".
ie: "stepConfirmed=Custom title to confirmed step" => stepConfirmed=Custom%20title%20to%20confirmed%20step"
ie: "stepConfirmedHelp=Custom help text to confirmed step" => stepConfirmedHelp=Custom%20help%20text%20to%20confirmed%20step"

Specific configuration parameters

Parameter	Description
stepConfirmed	Parameter used to change the name of the Confirmed step Default: Confirmed
stepConfirmedHelp	Parameter used to change the "Help Text" of the Confirmed step Default: Your order has been received by the store
stepPicking	Parameter used to change the name of the Picking step Default: Picking
stepPickingHelp	Parameter used to change the "Help Text" of the Picking step Default: Your picker is selecting your products
stepGoingToDestination	Parameter used to change the name of the Going To Destination step Default: Going to destination
stepGoingToDestinationHelp	Parameter used to change the "Help Text" of the Going To Destination step Default: The driver is on his way to your address
stepReadyToPickup	Parameter used to change the name of the Ready To Pickup step Default: Picked up
stepReadyToPickupHelp	Parameter used to change the "Help Text" of the ReadyToPickup step Default: Your order is ready to be picked up
stepDelivered	Parameter used to change the name of the Delivered step Default: Delivered
stepDeliveredHelp	Parameter used to change the "Help Text" of the Delivered step Default: Your order has been successfully delivered
stepCancel	Parameter used to change the name of the Cancel step Default: Cancelled
stepCancelHelp	Parameter used to change the "Help Text" of the Cancel step Default: We cancel the order according to your request.
stepPickedUp	Parameter used to change the name of the Picked up step Default: Picked up
stepPickedUpHelp	Parameter used to change the "Help Text" of the Picked up step Default: Your order has been successfully picked up

You can change the default "Icon" used in the order steps by setting them via URL parameter on each step.

📘
Custom Icon with Locales
Beware that custom Icon are not affected by primary color or secondary color

Specific configuration parameters

Parameter	Description
stepConfirmedIcon	Parameter used to change the icon of the Confirmed step
stepPickingIcon	Parameter used to change the icon of the Picking step
stepGoingToDestinationIcon	Parameter used to change the icon of the Going To Destination step
stepReadyToPickupIcon	Parameter used to change the icon of the Ready To Pickup step
stepPickedUpIcon	Parameter used to change the icon of the Picked up step
stepDeliveredIcon	Parameter used to change the icon of the Delivered step
stepCancelIcon	Parameter used to change the icon of the Cancel step