Ingrid Integration

Omnium offers integration with Ingrid, enabling seamless order management. Orders added to Omnium that include an Ingrid transport order ID can be processed directly through Omnium. The Ingrid widget can be activated in the Omnium user interface, allowing users to create new shipments effortlessly.

Omnium - Ingrid setup

Configuring Omnium: Adding a new shipping provider

1. Navigate to the configuration settings:
   Configuration -> Settings -> Orders -> Shipping Providers

2. Add the following details:

   • Name: Enter the name of the provider.
   • Display Name: Specify the name to be shown to users.
   • Provider: Select "Ingrid."
   • Merchant Secret: Retrieve this from the Ingrid portal. Use the Base64-encoded private key.
   • Base URL:
     • For testing: https://api-stage.ingrid.com/v1
     • For production: https://api.ingrid.com/v1

3. Enable the Ingrid Widget in the Omnium UI (Optional):

   • Vue Template: Set the template to ingrid-provider.
   • Turn On: Enable the Display in OMS option.

This configuration will integrate Ingrid as a shipping provider within Omnium and allow the use of the Ingrid widget in the user interface.

Ingrid shipment options

Adding shipment options for each market

Under each market, define the shipment options you provide in your webshop:

1. Include the following details:

   • Shipping Provider: Set as "Ingrid."
   • Delivery Type:
     • Use Delivery if the package is sent to the customer (e.g., home delivery, pickup points).
     • Use Pickup if the customer collects the package at a store or warehouse.
   • Display Name: Enter a user-friendly name for the option.
   • Shipping Method: Provide the system name or shipping code from Ingrid (e.g., pnl-mph for Postnord home delivery).

2. Navigate to the Property Tab:

   • Mark the option as Hidden in OMS to ensure shipment options are selected through the Ingrid widget.

Webshop creates the Ingrid transport order, and Omnium books the shipment

Integration Flow:

1. In your webshop, when users select a shipment option provided by Ingrid, a corresponding shipment should be added to their cart.
2. Ensure your webshop creates the Ingrid transport order.
3. Omnium will then book the shipment based on the transport order details.

Storing the tosId for shipments

Add TosId to the Shipment property list:

1. Include a key named IngridTosId in the property list of the shipment.
2. Assign the ID from Ingrid as the value for this key.