Add new / edit carrier
Description
The purpose of this page is to add new or edit carrier. It has these steps for new carrier addition:
General settings
Multistore (If multistore is enabled)
Shipping locations and costs
Size, weight, and group access
Summary
Common components
Bell icon (todo link)
Shop association block (todo link)
The UI elements
Carrier name input
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | The name field is required. |
Allowed/Forbidden values | Allowed letters, numbers, spaces and ().- | The name field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Allowed characters: letters, spaces and "().-". The carrier's name will be displayed during checkout. For in-store pickup, enter 0 to replace the carrier name with your shop name. | - |
Lower limit | 1 | - |
Upper limit | 64 | Your entry in field name (language English (English)) exceeds max length 64 chars (incl. HTML tags). |
Behavior | - |
Transit time input
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | The field delay is required at least in English (English). |
Allowed/Forbidden values | <>;=#{} | The delay field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Country name - Invalid characters: <>;=#{} | - |
Lower limit | 1 | - |
Upper limit | - | - |
Behavior | - |
Speed grade input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | Only one number from 0 to 9 is allowed. | The grade field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Enter a "0" for a longest shipping delay, or "9" for the shortest shipping delay. | - |
Lower limit | 1 | - |
Upper limit | 1 | The grade field is too long (1 chars max). |
Behavior | - |
Logo input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | JPG, GIF, PNG, WEBP | Cannot upload file. |
Default value | - | - |
Help text | Format: JPG, GIF, PNG, WEBP. Filesize: 8.00 MB max. Current size: undefined. | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 8.00 MB | Cannot upload file. |
Behavior | - |
Tracking URL input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | The url field is invalid. |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | For example: 'http://example.com/track.php?num=@' with '@' where the tracking number should appear. | - |
Tool tips | Delivery tracking URL: Type '@' where the tracking number should appear. It will be automatically replaced by the tracking number. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Add handling costs toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | No | - |
Help text | - | - |
Tool tips | Include the handling costs (as set in Shipping > Preferences) in the final carrier price. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Free shipping toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | No | - |
Help text | - | - |
Tool tips | Include the handling costs (as set in Shipping > Preferences) in the final carrier price. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Billing radio buttons
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | According to total weight. | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Tax dropdown
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | First tax rule by tax rule list. | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Out-of-range behavior dropdown
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | Apply the cost of the highest defined range. | - |
Help text | - | - |
Tool tips | Out-of-range behavior occurs when no defined range matches the customer's cart (e.g. when the weight of the cart is greater than the highest weight limit is defined by the weight ranges). | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Range Will be applied when the weight or currency is >= input
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | Numbers allowed only. | This range is not valid. |
Default value | 0.000000 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Range Will be applied when the weight or currency is < input
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | Numbers allowed only. | This range is not valid. |
Default value | - | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Maximum package width (Dimension unit) input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | Integer numbers allowed only. | The max_width field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Maximum width managed by this carrier. Set the value to "0", or leave this field blank to ignore. The value must be an integer. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Maximum package height (Dimension unit) input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | Integer numbers allowed only. | The max_height field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Maximum height managed by this carrier. Set the value to "0", or leave this field blank to ignore. The value must be an integer. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Maximum package depth (Dimension unit) input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | Integer numbers allowed only. | The max_depth field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Maximum depth managed by this carrier. Set the value to "0", or leave this field blank to ignore. The value must be an integer. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Maximum package weight (Dimension unit) input
| Description | Value | Error message |
|---|---|---|
Mandatory | No | - |
Allowed/Forbidden values | Integer numbers allowed only. | The max_weight field is invalid. |
Default value | - | - |
Help text | - | - |
Tool tips | Maximum weight managed by this carrier. Set the value to "0", or leave this field blank to ignore. The value must be an integer. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Group access checkboxes
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | All groups marked | - |
Help text | - | - |
Tool tips | Mark the group that are allowed access to this carrier. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Enabled toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | - |
Default value | Yes | - |
Help text | - | - |
Tool tips | Enable the carrier in the front office. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Behaviors description
General settings step behavior
This step has elements:
Carrier name input behavior
This is input (Forms normal UI kit) to enter carrier name.
Transit time input behavior
This is input (Forms normal UI kit) to enter transit time. This input has language dropdown to enter information for customers in different languages.
Speed grade input behavior
This is input (Forms normal UI kit) to enter speed grade.
Logo input behavior
This is input (Forms files UI kit) to choose file that will be shown as carrier logo. This input has a file icon on the left input side. On the right input side there is CTA button with a catalog icon with title Choose a file. Once clicked on input or button opens modal with this PC files. When file uploaded it is shown in Logo block in each carrier creation step.
Tracking URL input
This is input (Forms normal UI kit) to enter tracking URL.
Previous button behavior
This is outline CTA button (Buttons outline UI kit), once clicked the previous step is displayed. When hover mouse pointer on button, its color changes. This button is shown in each new carrier creation step.
Next button behavior
This is outline CTA button (Buttons outline UI kit), once clicked the next step is displayed. If there is an error, this button is disabled. When hover mouse pointer on button, its color changes. This button is shown in each new carrier creation step.
Finish button behavior
This is a green CTA button (Buttons basics UI kit), once clicked saves carrier and display carrier list. If there is an error, this button is disabled. When hover mouse pointer on button, its color changes. This button is shown in each new carrier creation step.
Multistore step behavior
This step contains these common components:
Shop association block (todo link)
Shipping locations and costs step behavior
This step has elements:
Add handling costs toggle switch behavior
This is toggle switch (Forms switch story UI kit) that allows choosing if the handling costs are added to the final price or not.
Free shipping toggle switch behavior
This is toggle switch (Forms switch story UI kit) that allows choosing if the carrier is free or not.
Billing radio buttons behavior
There are 2 radio buttons (Forms radio buttons) are displayed: "According to total price." and "According to total weight.". When "According to total price" is selected, the ranges are defined by currency. The currency displayed is the default one configured in International > Localization. When "According to total weight" is selected, the ranges are defined by weight. The weight displayed is the one defined in International > Localization.
Tax dropdown behavior
This is dropdown menu (Dropdowns basics UI kit) that displays all the enabled tax rules existing in International > Taxes > Taxes rules.
Out-of-range behavior dropdown behavior
This is dropdown menu (Dropdowns basics UI kit) that allows to select one of the 2 options: "Apply the cost of the highest defined range" or "Disable carrier". If the total weight or total price of the cart is not in one of the defined ranges and if the chosen option is "Disable carrier", then the carrier will be disabled. If the total weight or total price of the cart is not in one of the defined ranges and if the chosen option is "Apply the cost of the highest defined range", then the carrier price will be the one corresponding to the highest range.
Range Will be applied when the weight or currency is >= input behavior
This is input (Forms basics UI kit) to enter weight or currency number when range starts.
Range Will be applied when the weight or currency is < input behavior
This is input (Forms basics UI kit) to enter weight or currency number when range finishes. If one of the ranges overlaps another, the following error message is displayed: "Ranges are overlapping" and the fields for all zones are disabled.
Zones settings behavior
All the zones existing in International > Locations > Zones are displayed below in alphabetical order to chose zones for the range. Each zone has a checkbox (Forms checkboxes UI kit) allowing to enable its input field. Only numbers are allowed in zones fields, inputting any other symbol will result in the field being marked in red. The disabled zones are marked as inactive. When trying to go to the next step without selecting any zone the following error message is displayed: "Please select at least one zone".
Add new range button behavior
This is CTA button (Buttons outline UI kit) once clicked, a new column of range setting is displayed. When hover mouse pointer on button, its color changes. When clicking on it and if one of the existing ranges isn't completed, the following message is displayed "Please validate the last range before creating a new one."
Delete button behavior
This is CTA button (Buttons outline UI kit) it appears under each added range. Once button clicked opens popup that has notification: Are you sure to delete this range? and 2 buttons:
OK -it is a blue color CTA button (Buttons basics UI kit), once clicked deletes range and closes popup.
Cancel -it is outlined CTA button (Buttons outlined UI kit), once clicked cancels deletion and closes popup.
When hover mouse pointer on each button, it color changes.
Size, weight and group access step behavior
This step has elements:
Maximum package width (Dimension unit) input behavior
This is input field (Forms normal UI kit) to enter package width. The dimension unit mentioned in parenthesis is the one defined in International > Localization > Localization.
Maximum package height (Dimension unit) input
This is input field (Forms normal UI kit) to enter package height. The dimension unit mentioned in parenthesis is the one defined in International > Localization > Localization.
Maximum package depth (Dimension unit) input behavior
This is input field (Forms normal UI kit) to enter package depth. The dimension unit mentioned in parenthesis is the one defined in International > Localization > Localization.
Maximum package weight (Dimension unit) input behavior
This is input field (Forms normal UI kit) to enter package weight. The weight dimension unit mentioned in parenthesis is the one defined in International > Localization > Localization.
Group access checkboxes behavior
The ID and the name of all existing customers' groups are displayed. A checkbox (Forms checkboxes UI kit) is displayed before each group to select or unselect them. A global checkbox allows selecting/unselecting all customers' groups in one click.
Summary step behavior
This step has elements:
Carrier information block behavior
The information about the carrier being created are displayed:
The carrier's price, the transit time, if the shipping costs are calculated according to the price or to the weight, the tax rule, the different ranges, the behavior if the weight or the price is higher than the defined ranges, the delivery zones, the customers' groups, and the shops are displayed.
Enabled toggle switch behavior
This is toggle switch (Forms switch story UI kit) that allows to enable or disable created carrier.
Multistores functionality
Multistores independent page. Multistore functionality depends on Shop association block settings.
Last updated
