appearance.theme | A theme that can be used to style the appearance of Malomo.js. Supported value is light. |
order (required) | The Order object provided to this Element. |
carrierInfo.linkToCarrier | A boolean that determines whether to render a tracking code as text or a link that can take a user to the carriers tracking page. |
carrierInfo.rootClassName | The class name to use for the root carrier info element. Note that classNamePrefix is still applied to the generated class name. Defaults to carrier-info. |
carrierInfo.showIf | A function to determine whether to render carrier information. If the function returns false carrier information will not be rendered. If true is returned then carrier information will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
carrierInfo.showImage | A boolean that determines whether to render the carrier logo. If false the image will not be shown. Defaults to true. |
corso.shopId | A shop id associated with a Corso account. When present this will enable Corso support when rendering the shipmentTracker element. |
countdown.minDaysLeft | An integer indicating when to render a countdown depending on how many days are left until a shipment is delivered. A countdown will not contain a value until the number of days left is equal or less than the value of this options. If a value is not provided then the countdown will always contain a value as long as the number of days left is greater than zero. |
countdown.rootClassName | The class name to use for the root countdown element. Note that classNamePrefix is still applied to the generated class name. Defaults to countdown. |
countdown.showIf | A function to determine whether to render a countdown. If the function returns false a countdown will not be rendered. If true is returned then a countdown will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
deliveryDate.format | The format the date will be displayed as. Defaults to EEEE, MMMM d (e.g. Saturday, February 29). For more information on how to format a date please see date-fn's format documentation. |
deliveryDate.rootClassName | The class name to use for the delivery date root element. Note that classNamePrefix is still applied to the generated class name. Defaults to delivery-date. |
deliveryDate.showIf | A function to determine whether to render a delivery date. If the function returns false a delivery date will not be rendered. If true is returned then a delivery date will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
deliveryState.rootClassName | The class name to use for the delivery state root element. Note that classNamePrefix is still applied to the generated class name. Defaults to delivery-state. |
deliveryState.showIf | A function to determine whether to render a delivery state. If the function returns false a delivery state will not be rendered. If true is returned then a delivery state will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
deliveryState.states | An object containing overrides for the state to display. Defaults are provided below. |
events.dateFormat | The format of the date to be displayed for each event. Defaults to MM d (e.g. February 29). For more information on how to format a date please see date-fn's format documentation. |
events.enumerate | A function that can apply enumeration logic to the events. This is can be used for sorting or filtering out events. An array of events will be passed as the only argument. |
events.rootClassName | The class name to use for each shipping event root element. Note that classNamePrefix is still applied to the generated class name. Defaults to events. |
events.showIf | A function to determine whether to render shipment events. If the function returns false then shipment events will not be rendered. If true is returned then shipment events will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
events.timeFormat | The format for the time to be displayed for each event. Defaults to h:mm a (e.g. 12:00 AM). For more information on how to format a date please see date-fn's format documentation. |
returnActions.initiateReturnLinkText | The text for the "initiate return" link that deep links into the returns platform. Defaults to Start a return or an exchange |
returnActions.initiateReturnPromptText | The prompt text that appears next to the "initiate return" link. Defaults to Need to make a change? |
returnActions.relatedReturnsText | Header text for the "related returns" section. Below that section are all the returns/exchanges related to the current order being tracked. Defaults to Related Returns |
returnActions.returnStatusLinkText | The text for the "Return Status" button that allows customers to view the status of their return. Defaults to Return Status |
returnActions.rootClassName | The class name prefix to use for each element in the "return actions" section. Defaults to return-actions |
returnActions.showIf | A function to determine whether to render the "return actions" section/any returns or exchanges information. If the function returns false then the customer will not have an ability to interact with returns or exchanges on the tracking page.
Defaults to true if the Loop Returns integration is installed correctly, and if at least one shipment from the order has been delivered.
To remove the requirement for the order to have a delivered shipment, you can set the function to:
(order) => { return order.body.return_url; } |
returnActions.viewOriginalOrderLinkText | The text for the link back to the original order when viewing a return. Defaults to View original order |
statusMessage.messages | An object containing overrides for the message to display. Defaults are provided below. |
statusMessage.rootClassName | The class name to use for the status message root element. Note that classNamePrefix is still applied to the generated class name. Defaults to status-message. |
statusMessage.showIf | A function to determine whether to render a status message. If the function returns false then a status message will not be rendered. If true is returned then a status message will be rendered. An Order object will be passed as the first argument and a Shipment object as the second argument. Defaults to true. |
statusMessage.stopOn | An array of status keys that will only render the provided statuses if they occur in a shipments tracking history. This is useful in situations like return_to_sender where it may be more useful to show the end user the return_to_sender status message rather than the remaining event statuses as it makes it's way back to the sender. Defaults to false. |
