API Endpoints

Order status - substeps

Custom substeps names

You can customize the title of the substates of the order

Specific configuration parameters Pick and Delivery

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

Specific configuration parameters Pick and Collect

ParameterDescription
customStepsName.receivedParameter used to change the title of the Received substep (optional)
- Default: Received
customStepsName.pickingParameter used to change the title of the Picking substep (optional)
- Default: Picking
customStepsName.readyForPickupParameter used to change the title of the Ready for Pickup substep (optional)
- Default: ReadyForPickup
customStepsName.pickedUpParameter 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
substeps.confirmed.iconString with an URL which will be used as display icon in the Confirmed order substep
substeps.picking.iconString with an URL which will be used as display icon in the Picking order substep
substeps.goingToDestination.iconString with an URL which will be used as display icon in the Going To Destination order substep
substeps.delivered.iconString with an URL which will be used as display icon in the Delivered order substep

Specific configuration parameters Pick and Collect

ParameterDescription
substeps.confirmed.iconString with an URL which will be used as display icon in the Confirmed order substep
substeps.picking.iconString with an URL which will be used as display icon in the Picking order substep
substeps.readyForPickup.iconString with an URL which will be used as display icon in the Ready For Pickup order substep
substeps.pickedUp.iconString with an URL which will be used as display icon in the PickedUp order substep

Specific configuration parameters Active and Inactive

ParameterDescription
substeps.picking.iconActiveString with an URL which will be used as display icon in the Picking order substep when substep is active
substeps.picking.iconInactiveString with an URL which will be used as display icon in the Picking order substep when substep is inactive
substeps.goingToDestination.iconActiveString with an URL which will be used as display icon in the Going To Destination when order substep is active
substeps.goingToDestination.iconInactiveString with an URL which will be used as display icon in the Going To Destination when order substep is inactive
substeps.readyForPickup.iconActiveString with an URL which will be used as display icon in the Ready For Pickup when order substep is active
substeps.readyForPickup.iconInactiveString with an URL which will be used as display icon in the Ready For Pickup when order substep is inactive
substeps.delivered.iconInactiveString with an URL which will be used as display icon in the Delivered order substep when substep is active
substeps.delivered.iconInactiveString with an URL which will be used as display icon in the Delivered order substep when substep is inactive
substeps.pickedUp.iconActiveString with an URL which will be used as display icon in the PickedUp order substep when substep is active
substeps.pickedUp.iconInactiveString with an URL which will be used as display icon in the PickedUp order substep when substep is inactive