API Endpoints

Order status - substeps

Custom substeps names

You can customize the title of the substates of the order

📘

Custom Names and Locales

Beware that custom names 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.

Specific configuration parameters Pick and Delivery

ParameterDescription
receivedParameter used to change the title of the Received substep (optional)
- Default: Received
pickingParameter used to change the title of the Picking substep (optional)
- Default: Picking
goingToDestinationParameter used to change the title of the Going To Destination substep (optional)
- Default: Going To Destination
deliveredParameter used to change the title of the Delivered substep (optional)
- Default: Delivered

Specific configuration parameters Pick and Collect

ParameterDescription
receivedParameter used to change the title of the Received substep (optional)
- Default: Received
pickingParameter used to change the title of the Picking substep (optional)
- Default: Picking
readyForPickupParameter used to change the title of the Ready for Pickup substep (optional)
- Default: ReadyForPickup
subStepPickedUpParameter used to change the title of the PickedUp substep (optional)
- Default: PickedUp

Custom substeps icons

You can change the default "Icon" used in the order substeps by setting "icon" parameter on each step.

The "Icon" configuration are being set in the "substeps" attribute of the configuration object.

Specific configuration parameters Pick and Delivery

ParameterDescription
subStepConfirmedIconString with an URL which will be used as display icon in the Confirmed order substep
subStepPickingIconString with an URL which will be used as display icon in the Picking order substep
subStepGoingToDestinationIconString with an URL which will be used as display icon in the Going To Destination order substep
subStepDeliveredIconString with an URL which will be used as display icon in the Delivered order substep

Specific configuration parameters Pick and Collect

ParameterDescription
subStepConfirmedIconString with an URL which will be used as display icon in the Confirmed order substep
subStepPickingIconString with an URL which will be used as display icon in the Picking order substep
subStepReadyToPickupIconString with an URL which will be used as display icon in the Ready For Pickup order substep
subStepPickedUpIconString with an URL which will be used as display icon in the PickedUp order substep

Specific configuration parameters Active and Inactive

ParameterDescription
subStepPickingIconActiveString with an URL which will be used as display icon in the Picking order substep when substep is active
subStepPickingIconInactiveString with an URL which will be used as display icon in the Picking order substep when substep is inactive
subStepGoingToDestinationIconActiveString with an URL which will be used as display icon in the Going To Destination when order substep is active
subStepGoingToDestinationIconInactiveString with an URL which will be used as display icon in the Going To Destination when order substep is inactive
subStepReadyToPickupIconActiveString with an URL which will be used as display icon in the Ready For Pickup when order substep is active
subStepReadyToPickupIconInactiveString with an URL which will be used as display icon in the Ready For Pickup when order substep is inactive
subStepDeliveredIconActiveString with an URL which will be used as display icon in the Delivered order substep when substep is active
subStepDeliveredIconInactiveString with an URL which will be used as display icon in the Delivered order substep when substep is inactive
subStepPickedUpIconActiveString with an URL which will be used as display icon in the PickedUp order substep when substep is active
subStepPickedUpIconInactiveString with an URL which will be used as display icon in the PickedUp order substep when substep is inactive