API Endpoints

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.

Specific configuration parameters

ParameterDescription
steps.confirmed.titleParameter used to change the name of the Confirmed step
- Default: Confirmed
steps.confirmed.helpParameter used to change the "Help Text" of the Confirmed step
- Default: Your order has been received by the store
steps.picking.titleParameter used to change the name of the Picking step
- Default: Picking
steps.picking.helpParameter used to change the "Help Text" of the Picking step
- Default: Your picker is selecting your products
steps.goingToDestination.titleParameter used to change the name of the Going To Destination step
- Default: Going to destination
steps.goingToDestination.helpParameter used to change the "Help Text" of the Going To Destination step
- Default: The driver is on his way to your address
steps.readyToPickup.titleParameter used to change the name of the Ready To Pickup step
- Default: Picked up
steps.readyForPickup.helpParameter used to change the "Help Text" of the ReadyToPickup step
- Default: Your order is ready to be picked up
steps.delivered.titleParameter used to change the name of the Delivered step
- Default: Delivered
steps.delivered.helpParameter used to change the "Help Text" of the Delivered step
- Default: Your order has been successfully delivered
steps.pickedUp.titleParameter used to change the name of the Picked up step
- Default: Picked up
steps.pickedUp.helpParameter used to change the "Help Text" of the Picked up step
- Default: Your order has been successfully picked up
steps.cancel.titleParameter used to change the name of the Cancel step
- Default: Cancelled
steps.cancel.helpParameter used to change the "Help Text" of the Cancel step
- Default: We cancel the order according to your request.

Custom step icons

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

Specific configuration parameters

ParameterDescription
steps.confirmed.iconParameter used to change the icon of the Confirmed step
steps.picking.iconParameter used to change the icon of the Picking step
steps.goingToDestination.iconParameter used to change the icon of the Going To Destination step
steps.readyToPickup.iconParameter used to change the icon of the Ready To Pickup step
steps.pickedUp.iconParameter used to change the icon of the Picked up step
steps.delivered.iconParameter used to change the icon of the Delivered step
steps.cancel.iconParameter used to change the icon of the Cancel step