Order status - steps

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

ParameterDescription
stepConfirmedParameter used to change the name of the Confirmed step
- Default: Confirmed
stepConfirmedHelpParameter used to change the "Help Text" of the Confirmed step
- Default: Your order has been received by the store
stepPickingParameter used to change the name of the Picking step
- Default: Picking
stepPickingHelpParameter used to change the "Help Text" of the Picking step
- Default: Your picker is selecting your products
stepGoingToDestinationParameter used to change the name of the Going To Destination step
- Default: Going to destination
stepGoingToDestinationHelpParameter used to change the "Help Text" of the Going To Destination step
- Default: The driver is on his way to your address
stepReadyToPickupParameter used to change the name of the Ready To Pickup step
- Default: Picked up
stepReadyToPickupHelpParameter used to change the "Help Text" of the ReadyToPickup step
- Default: Your order is ready to be picked up
stepDeliveredParameter used to change the name of the Delivered step
- Default: Delivered
stepDeliveredHelpParameter used to change the "Help Text" of the Delivered step
- Default: Your order has been successfully delivered
stepCancelParameter used to change the name of the Cancel step
- Default: Cancelled
stepCancelHelpParameter used to change the "Help Text" of the Cancel step
- Default: We cancel the order according to your request.
stepPickedUpParameter used to change the name of the Picked up step
- Default: Picked up
stepPickedUpHelpParameter 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

ParameterDescription
stepConfirmedIconParameter used to change the icon of the Confirmed step
stepPickingIconParameter used to change the icon of the Picking step
stepGoingToDestinationIconParameter used to change the icon of the Going To Destination step
stepReadyToPickupIconParameter used to change the icon of the Ready To Pickup step
stepPickedUpIconParameter used to change the icon of the Picked up step
stepDeliveredIconParameter used to change the icon of the Delivered step
stepCancelIconParameter used to change the icon of the Cancel step