Integrated shipping | Qliro devportal

For developers

By Qliro

Select search filters:

Integrated shipping

Use our integrated shipping to present available shipping methods to the customer directly in the checkout.

Overview

Checkout offers highly customizable integrated shipping with a range of features for you to be able to present your shipping options in the best way to your customer.

There are two options available:

Merchant provided - You as a merchant handle all the shipping logic and send in the options that should be presented to the customer.
nShift - If you are using nShift Delivery checkout, use this option and Qliro Checkout will handle all shipping interactions with customers through nShift.
Ingrid - Qliro Checkout is also compatible with Ingrid delivery platform where you are able to configure your shipping preferences and display them to the customer.

Merchant provided

Here you decide which options that should be presented to the customer by sending them either in the create order call or as a response to the request sent by Qliro to MerchantOrderAvailableShippingMethodsUrl. When the customer changes adress or the cart updates Qliro will send a POST request to that URL giving you the possibility to update the shipping options if needed.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "AvailableShippingMethods": [
    {
      "MerchantReference": "HOME_DELIVERY",
      "ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
      "DisplayName": "Home Deliver",
      "Descriptions": "\"Expected date\",\"Expected time\"",
      "Brand": "DHL",
      "PriceIncVat": 300,
      "PriceExVat": 200,
      "OriginalPrice": 0,
      "SupportsAccessCode": true,
      "SupportsDynamicSecondaryOptions": true,
      "SecondaryOptions": [
        {
          "MerchantReference": "UniqueMerchantReference",
          "DisplayName": "Pickup location 1",
          "Descriptions": "\"Address\", \"Hours\"",
          "Coordinates": {
            "Lat": 59.349962,
            "Lng": 18.04763
          },
          "DeliveryDateInfo": {
            "DateStart": "2099-01-01",
            "DateEnd": "2099-01-01",
            "Unit": "Date"
          }
        }
      ],
      "AdditionalShippingServices": [
        {
          "MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
          "DisplayName": "Express delivery",
          "Descriptions": "Faster delivery",
          "PriceExVat": 100,
          "PriceIncVat": 150,
          "DeliveryDate": "2099-01-01",
          "DeliveryDateInfo": {
            "DateStart": "2099-01-01",
            "DateEnd": "2099-01-01",
            "Unit": "Date"
          }
        }
      ],
      "DeliveryDate": "2099-01-01",
      "CategoryDisplayName": "HOME_DELIVERY",
      "LabelDisplayName": "Name",
      "DeliveryDateInfo": {
        "DateStart": "2099-01-01",
        "DateEnd": "2099-01-01",
        "Unit": "Date"
      }
    }
  ]
}

For details on the request/response parameters in the create order call as well as error codes, please continue to the API reference.

For details on the Update Shipping Methods push, please continue to the Notifications.

Best practice

If you only want to present static options to the customer the best way to do it is to populate the create order call when creating an order.
Updates to shipping options can be made using update order but for best user experience we recommend using the MerchantOrderAvailableShippingMethodsUrl.

nShift

nShift checkout can be integrated directly so that Qliro checkout handles all shipping communication directly with nShift.

Note: In our API communication we refer to nShift by its previous name "Unifaun".

How-to

Contact merchant solutions to activate the feature on your account
Create a new checkout configuration on the nShift side with the Qliro template.
Specify nShift parameters under the ShippingConfiguration parameter in the create order call.
Qliro uses the information from create order to get shipping information from nShift.
Qliro updates the iframe with the shipping information.
Use getOrder to retrieve information about the order. OrderID is used as "preparedID" to be passed to nShift.

Example

1
2
3
4
5
6
7
8
9
10
11
12
{
  "ShippingConfiguration": {
    "Unifaun": {
      "CheckoutId": "string",
      "Tags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  }
}

Ingrid

Qliro checkout is also compatible with Ingrid delivery checkout. Set your preferred shipping configuration using Ingrid, Qliro will seamlessly handle all shipping communication directly with Ingrid and present the shipping alternatives as an integral part of the checkout.

How-to

Share credentials and enable Ingrid
Contact merchant solutions to activate the feature on your account and inform which countries Ingrid should be enabled in. Provide the Ingrid Credential Key (base 64) in the way instructed by merchant solutions.
Creating and updating orders with Ingrid enabled
Send in optional Ingrid-specific metadata for each order item on CreateOrder and UpdateOrder (see api documentation). You have the option to send in cart vouchers (key: Ingrid.Vouchers) or cart attribute (key: Ingrid.CartAttributes) in the merchantProvidedMetadata.
Set up your fallback shipping option
It is strongly recommended that you send in at least one shipping option via AvailableShippingMethods property in the CreateOrder and UpdateOrder requests. This shipping option will act as a fallback if Ingrid Api doesn't respond.

Attention! MerchantOrderAvailableShippingMethodsUrl can NOT be used for this purpose and should not be sent in if Ingrid is toggled on.
Post-purchase administration
Qliro will create a shipping order item from the shipping method the customer has selected after the purchase is completed. Ingrid checkout session ID is accessible via this order item. For example to access transport id (tos_id) when the order is completed in Qliro Checkout.

MerchantReference is used as "External ID" when completing Ingrid Checkout Session. You need to set the shipping order item to shipped via Qliro Admin Api when the corresponding transport order is shipped via Ingrid.

Attention! You need to manage Ingrid transport order administration; either manually (via https://mad.ingrid.com/ ) or via Ingrid:s shipment order management API

Good to know

For the best user experience, we recommend you use our shipping section. It is customizable depending on your and your customers needs. For more information on visual customization, e.g. adding a map, enabling a pickup point selection and managing tab grouping of shipping alternatives, continue to Custom shipping
The shipping options will be presented in the order they are sent in. The first option will, therefore, appear as the top option which will also be pre-selected in the checkout.
Use onShippingMethodChanged or onShippingPriceChanged (optional listener) to know when the customer changes shipping data. Continue to Listeners to read more.
We will present a shipping logo in the checkout if the correct tag is used. Available tags are: Airmee, Aramex, Asendia, Best, Bring, Budbee, Dao, Dhl, Dsv, EarlyBird, FedEx, Helthjem, Instabikes, Instabox, Oda, Posti, PostNord, Porterbuddy, Schenker, Svosj, Ups

Next up is Payment methods