Skip to main content

How delivery methods are fetched

Collector Checkout fetches the list of available delivery methods every time the customer changes any information that might lead to a change in available delivery methods, e.g. the customer changes delivery address or updates the cart.

How to configure TMS provider#

When the Checkout sends the GET request to the TMS provider, it has some default query parameters that are always included. You can have logic based on these paramters, e.g adjust the shipping fee based on cartPrice or enable/disable an option based on customerType.

Default Request Query Parameters

ParameterExplanation
storeIdThe storeId for the checkout session
privateIdThe checkout's private id which can be used to fetch information about the checkout
storeTypeCustomerType for the checkout session, b2b or b2c
currencyCurrency used for the checkout session
languageThe display language used for the checkout session. Supported language are: sv, no, fi, da, en
cartPriceThe total price for cart
cartWeightThe total weight for the cart
emailThe customer's email address
addressThe address for the customer's current delivery address
postalCodeThe postal code for the customer's current delivery address
countryCodeThe country code for the customer's current delivery address

When requesting for available shipping methods, apart from all the parameters above, you can set custom parameters that is related to articles in the cart. This is done by adding shippingProperties to the cart object in either Initialize Checkout or Update Cart as a JSON object that will be be added in the request query parameters automatically the following way:

{
"items": [
{
"id": "2",
"description": "A bulky product",
"unitPrice": 100,
"quantity": 1,
"vat": 20,
"requiresElectronicId": true,
"sku": "a unique alphanumeric code for article identification"
}
],
"shippingProperties": {
"height": 10,
"width": 20,
"isBulky": true
}
}

The following scenario would result in the following query parameters when GET-request is sent to the TMS Provider:

https://{UriToProvider}?storeId={storeId}&....&address={address}&height=10&width=20&isBulky=true

When you create your configuration at the TMS provider, these query parameters can be used to configure the delivery methods as desired, based on the state of the checkout session.

Please note

Note that the example with height, width and isBulky are just examples. Any key/value pair string/string can be used and will be translated to query parameters accordingly.