This article explains where the configuration of Delivery Checkout when used with Qliro differs from the standard configuration.
Sections in this article:
- Create a Delivery Checkout to use with Qliro
- Delivery options
- DeliveryCheckout API
- Additional articles
Create a Delivery Checkout to use with Qliro
If you are new to Delivery Checkout, we recommend starting by reading these articles: Getting started with Checkout and Set up Delivery Checkout.
- Before getting started you must:
- Have an integration with Qliro Checkout solution on your website.
- Be an nShift customer and have login credentials to nShift Delivery.
- Provide Qliro with nShift Delivery API credentials.
- Create the Delivery Checkout structure according to your needs entering the relevant information, for example, services, prices, and agents. Depending on your subscription plan, you should use one of the following templates: Qliro - Essential, Qliro - Professional, or Qliro - Premium.
- Follow the setup instructions in Set up Delivery Checkout and Create a Delivery Checkout. Pay attention to the section below about Delivery options which is different for the Qliro flow.
Delivery Checkout flow with Qliro:
Delivery options
For most delivery options, services, prices and addons it is possible to enter appliance conditions. You can also use advanced conditions to dynamically modify certain text fields. Before creating your delivery checkout it is recommended to explore delivery conditions further.
- The name you give the delivery option, for example, "Home", is for internal use only.
- Check the Disabled box if you do not want the delivery option to be used immediately. You can change the "Disabled" status at any time, for example, if there is a temporary problem with a carrier's service or if you only want to include this option at a certain time of year.
- Assign the delivery option to a Category, if relevant. If you use both sub levels and categories you should assign the sub level to a category instead. However, using categories can often replace using sub levels.
- Select a service, in the Service section.
- Click Add service.
If the service has agents/pickup points you can decide which and how many agents to show using geolocation. The distance to the nearest agents is calculated for every zip code. For example, "20" means that agents within a radius of 20 km from a defined GPS coordinate are shown.
Geolocation can only be used in Belgium (BE), Denmark (DK), Estonia (EE), Finland (FI), Germany (DE), Luxembourg (LU), the Netherlands (NL), Norway (NO), Sweden (SE) and Åland (AX).
- Enter a value in the Maximum radius (km) field if you want to show agents based on geolocation, otherwise it should be set to "0".
- With Maximum number of agents you can limit the number of agents that are shown based on geolocation. Max. 15 agents.
- Click New or Free shipping in the Prices section to enter the service price.
- If New, enter the price as a numerical value, for example, "7.0" in Price, in each currency section.
If Free delivery, enter the cart value from which the delivery should be free, for example, "39.0", in Limit for free delivery, in each currency section.
- In the Addons section, click the edit icon to the left of an addon you want to activate or edit.
- Check Preselected, Mandatory or both if the addon should be preselected and/or mandatory in the webshop.
- Click New in the Prices section to enter prices for the addon. In each currency section, enter the price as a numerical value, for example, "1.0" in Price.
- If you click OK when leaving the Edit addon page the addon is activated even if you have not entered any information.
- If New, enter the price as a numerical value, for example, "7.0" in Price, in each currency section.
- Click OK.
- Click New in the Fields for titles section if you want to add a title that should be used under certain conditions. In the Language section, enter a title in the languages you defined earlier.
- Click New in the Sort order section to specify in what place the delivery option should appear.
General Key/values
You can make customizations that will enrich the customer experience. The General Key/values section can be used to modify the look and feel of the shipping section in Qliro Checkout.
- Enter Key and Value in the General Key/values section.
- Click New.
Key |
Type |
Description |
SupportsAccessCode |
boolean |
If provided and true, a field will be presented so that the customer can enter an access code. The access code will be optional. Max. 50 characters. Suitable for home delivery methods. |
CategoryDisplayName |
string |
Can be used to group shipping methods. If used it must be set on all included shipping methods. Only 2 category values can be used for a list of shipping methods. Recommended values: "HOME_DELIVERY" and "PICKUP". Other values will be used as is. |
LabelDisplayName |
string |
To be used with categories. Only use 3 or less different labels for all shipping options. Recommended values: "Express", "Free" and "Economy". |
ShippingFeeMerchantReference |
string |
When the customer chooses a shipping method in Qliro One, an order item will be added to the cart, including the shipping fee for that particular shipping method. By default, the merchantReference of this fee item will be copied from the selected shipping option. If the ShippingFeeMerchantReference parameter is provided, the merchantReference will be overridden. Max. 200 characters. |
Example: Two categories and three different labels to categorize and label shipping options.
To add more delivery options for the delivery checkout, click New option on the New delivery checkout page and follow the steps above.
For some items, such as delivery options and prices you can change the order in which they appear in the webshop. Use the up and down icons next to an item row or use Sort order as described above.
Custom agents are treated as a service and are added in the same way as other services.
Click Test to see how the delivery options will be displayed in the webshop depending on which parameters you enter.
"tocity" and "tozipcode" are always mandatory but for some carriers, other parameters may be required as well.
To show, edit or delete a delivery checkout, use the search function.
DeliveryCheckoutAPI
DeliveryCheckout API is an integration service for communication between Delivery Checkout and your webshop. DeliveryCheckout API uses a REST API framework for communication with JSON as data carrier offering a number of functions.
Please refer to Qliro's documentation on how to integrate Qliro Checkout with Delivery Checkout.
Please find all the general documentation for the DeliveryCheckoutAPI here.
Additional articles
- Checkout setup
- Delivery conditions
- DeliveryCheckout API
- Custom agents
- Neutral services
- Subscription plans