How to configure Ingrid

About this article

In this article you will learn how to set up the Ingrid plugin. Ingrid is a shipping connector, it connects your brand with global shipping alternatives. Once Ingrid is active it will generate a widget on your checkout that your end customers will be able to use.

Adding the Ingrid plugin to Centra

To add the Ingrid plugin to your DTC store, follow the steps below:

1. Go to 'System' in the main menu to the left
2. Click 'Stores'
3. Open you DTC store
4. Scroll down to the 'Plugins' section below the store settings
5. Click '+Add plugin method' and locate and select the Ingrid plugin (listed under Shipping method)
6. Fill in the following fields:
   • Status: Make sure the plugin status is activated when you feel satisfied with the setup
   • Plugin name: Name your plugin
   • URI: This will be automatically generated based on the name you enter in the name field
   • Private key: This field can only be populated once you have received a key from Ingrid, without this you are unable to connect with Ingrid
   • Test mode: Depending on which stage you are in with the setup of this plugin, Test-Mode can be 'Yes' or 'No'. 'Yes' means that all orders will end up in an Ingrid test environment, while 'No' means all orders will be made towards the production environment
   • Convert method: This allows Ingrid and Centra to convert the shipping methods defined in your setup to Unifaun/nShift methods for specific warehouse integrations, default is No conversion
   • Default locale: Ingrid is available in many languages but if you do not have localization active you can make sure that customers get the same language throughout their experience by setting a default language
   • Clear zipcode on error: 'Yes', means that if you incorrectly add a postal code Ingrid will clear the value your customer entered. If 'No', the widget will keep the post code entered
   • Suspend Ingrid widget on shipping option changed: If set to 'Yes' Ingrid's widget will be put into a "loading state" whenever the shipping option is changed by the user until Centra has recevied the update. It is important that your front end picks up those changes and resumes the widget when ready
   • Update address in Ingrid's widget from address stored on basket in Centra: Centra will always try to populate the Ingrid widget with the selection address if Centra has received it before Ingrid, however other address updates will depend on this setting.
   • If set to 'On address prefill (default)' the address the widget uses to present the shipping options will be updated from Centra on the PUT /payment-fields endpoint
   • If set to 'Only if Ingrid does not have an address for the session' - prevents the PUT /payment-fields endpoint from updating the address in the Ingrid session
   • Required fields: You are able to define which values are required by the customer to be entered in the widget. Tick the boxes to select the fields you want to have as mandatory
   • Pricelist-restrict: You are able to restrict which pricelists have access to the widget. Tick the boxes to select the pricelists you want to have available and be restircted to. If you don't select anything here it will be available for all
   • Market-restrict: You are able to restrict which markets have access to the widget. Tick the boxes to select the markets you want to have available and be restircted to. If you don't select anything here it will be available for all
   • Country-restrict: You are able to restrict which countries have access to the widget. Tick the boxes to select the countries you want to have available and be restircted to. If you don't select anything here it will be available for all
   • Locale-restirct: You are able to restrict which locales have access to the widget. Tick the boxes to select the locales you want to have available and be restircted to. If you don't select anything here it will be available for all
7. Click 'Save' when you're done.

How to implement Ingrid in your Checkout

Here your frontend partner can read more about how to implement Ingrid, what happens "behind the scenes", about problems that can occur and much more.

How to get free shipping vouchers to work with Ingrid

If you want to setup a free shipping voucher in Centra and make it work when using Ingrid, you need to setup a "free_shipping" tag in Ingrid per carrier. Here you can read more about how to do so in Ingrid.

How Ingrid data exposed to 3PLs

If a client have Ingrid to decide the shipping method, they might want to send it to their 3PL. We have a standardized format of exposing the data in the SOAP API and the Order API.

The fields that are exposed are those saved on the Order as attributes. These are the keys that the 3PL see.

• Ingrid ID: shipwallet_id - Ingrid's unique identifier. Example: "abcdef1234567890abcdef1234567890". 32 characters in size. Generally doesn't hold any value for the 3PL, but good for back tracing
• Ingrid Service Method: shipwallet_method - The chosen shipping method. Ingrid's ID can for example be "pnl-mpc" (Postnord Mypack), max 10 characters, we also support to convert this into Unifaun/nShift codes if that's the system the warehouse utilizes for booking the shipments. For pnl-mpc the Unifaun/nShift code would be P19
• Ingrid Converted Method ID: shipwallet_converted_method_id - Identifier of chosen carrier. If external method identifier is defined on carrier, its value is passed in this field. Otherwise, shipping method from carrier is entered
• Ingrid Pickup: shipwallet_pickup - If the user has chosen to have it delivered to a Service point, this is the carrier identifer of that service point. This might be empty, but if not this is crucial to get right so the customer gets the goods to the right Service Point. Example: "12345"
• Ingrid Door Code: shipwallet_doorcode - Door code, if applicable. Example: "1234", maximum 10 characters
• Ingrid Delivery Time: shipwallet_deliverytime - When it should be delivered. This can be a user choice, if they use for example Best. Example: "YYYY-MM-DD"
• Ingrid Courier Instructions: shipwallet_courier_instructions - Generic instructions for the courier, maximum 250 characters
• Ingrid TOS ID: shipwallet_tos_id - Ingrid identifier of order created based on completed session
• Ingrid Cart Attributes: shipwallet_cart_attribute_data