Ingrid

Ingrid Checkout (opens in a new tab) is a tool designed to fit into your checkout process, displaying detailed delivery information to each customer, which covers elements such as delivery times, pricing, and carrier options. After setting up your preferred delivery configuration, the tool takes over the remaining tasks.

This page expands upon the Common Integration Process, offering more in-depth information specifically concerning Ingrid.

1. Sign agreement

Contact Ingrid for more information: https://www.ingrid.com/book-a-demo (opens in a new tab)

2. Configure shipping broker

Follow the guidelines provided by Ingrid to configure their service according to your specific requirements.

We integrate with Ingrid SIW API:

Documentation: https://developer.ingrid.com/siw/api/ (opens in a new tab)
Object reference: https://developer.ingrid.com/siw/reference/ (opens in a new tab)

3. Activate shipping broker

Contact us and provide us with the necessary configuration details that you acquired from Ingrid in the previous steps. We will need:

Ingrid Private key
Fallback shipping text: any text of your choice that will be used in case shipping broker fails and can’t display the shipping widget.

We will then enable Ingrid in your checkout form.

4. Extend API requests

See example of a fully extended request below:

{
  "items": [
    {
      "description": "Product One",
      "notes": "Some notes",
      "amount": 50,
      "taxCode": "tax46",
      "taxAmount": 2,
      "quantity": 1,
      "articleNumber": "ASDASD86",
      // Extended shipping parameters ↓
      "shippingParameters": {
        "height": 300,
        "length": 300,
        "width": 30,
        "weight": 30,
        "attributes": ["Hazmat"]
      }
    },
    // Extended default shipping item ↓
    {
      "Description": "Shipping",
      "Notes": "SHI001",
      "Amount": 55.0,
      "TaxCode": "0",
      "TaxAmount": 9.8,
      "Quantity": 1
    }
  ],
  // Extended shipping settings ↓
  "shippingSettings": {
    "Vouchers": ["value"],
    "attributes": ["isbulky=True", "shippingclass=A"]
  }
}

Default shipping item

View Default Shipping Item section in the Common Integration Guide for more information.

Shipping parameters

The shipping parameters are specific for a single item. This is extra information Ingrid will use to provide better shipping options. View Shipping Parameters section in the Common Integration Guide for more information.

Parameter	Data Type	Necessity	Description
height	Integer	Optional	Height of the item in millimeters
length	Integer	Optional	Length of the item in millimeters
width	Integer	Optional	Width of the item in millimeters
weight	Integer	Optional	Weight of the item in grams
attributes	string[]	Optional	Attributes of the item. Cart Item level attributes are specific to that particular item and can be set to adjust delivery scenarios in Ingrid. E.g. [“SendAsLetter”, “Prescription”, “Hazmat”] These values are passed “as is” to Ingrid.

Shipping settings

The shipping settings affect the entire cart. This is extra information Ingrid will use to provide better shipping options. View Shipping Settings section in the Common Integration Guide for more information.

Parameter	Type	Necessity	Description
vouchers	string[]	Optional	Vouchers that can be used in price/filter rules. These values are passed “as is” to Ingrid.
attributes	string[]	Optional	Attributes of the entire cart. Ingrid can set varied delivery scenarios based on such attributes. E.g. [“PRIO”, “AB-testID”] These values are passed “as is” to Ingrid.

5. Obtain shipping details

After a purchase is successfully completed, the Payment Status response will include additional shipping data within the modules section, encompassing all essential shipping information.

Provider-Specific Integration Guide NShift