Ingrid Shipping Adapter
Overview
The Ingrid Adapter integrates Ingrid Delivery Checkout with Norce Checkout, enabling merchants to offer Ingrid's comprehensive delivery experience within the Norce Commerce platform. Ingrid provides an embedded checkout widget that allows customers to select from various delivery options including home delivery, pickup points, and scheduled deliveries.
This adapter is part of Norce Checkout (NCO) and manages the complete shipping lifecycle – from session initialization to order completion. Changes made in Norce Checkout are automatically synchronized with Ingrid and vice versa, ensuring both systems remain consistent throughout the checkout flow.
When an order is accepted, the adapter completes the session in Ingrid, storing the delivery reference (tos_id) in the tmsReference field for tracking and fulfilment.
Capabilities and Supported Flows
Shipping Operations
| Feature | Full | Partial | Description |
|---|---|---|---|
| Create Session | Yes | — | Initialize Ingrid delivery checkout session |
| Update Session | Yes | — | Sync cart and customer changes |
| Complete Session | Yes | — | Complete session on order acceptance |
| Remove Session | Yes | — | Remove shipping from order |
Supported Delivery Methods
| Method | Supported | Description |
|---|---|---|
| Home Delivery | Yes | Standard and express options |
| Pickup Points | Yes | Service points, lockers, stores |
| Scheduled Delivery | Yes | Time window selection |
| Multiple Carriers | Yes | Based on Ingrid configuration |
Advanced Features
| Feature | Supported | Description |
|---|---|---|
| B2B Support | Yes | Business customer checkout |
| B2C Support | Yes | Consumer checkout |
| Bidirectional Sync | Yes | Norce ↔ Ingrid synchronization |
| Shipping Discounts | Yes | Voucher support |
| Logistics Data Mapping | Yes | Weight, dimensions, shipping date |
| Address Form Mode | Yes | Ingrid handles address collection |
Integration Model
The adapter uses a widget-based checkout model:
- Norce Checkout provides order, cart, customer, currency, and locale data to the adapter.
- The adapter creates and maintains a session in Ingrid.
- The Ingrid Delivery Checkout widget is embedded in the merchant's frontend and displays delivery options.
- Customer selections (delivery option, pickup point, time slot) are sent back to Norce Checkout through adapter callback endpoints.
- When the order is accepted, the adapter completes the session in Ingrid.
All synchronization hooks are registered automatically when the session is created.
Promotions and Discounts
The Ingrid Adapter handles two types of discounts: item-level discounts (reflected in per-item pricing) and shipping discounts (forwarded to Ingrid as voucher codes). Promotions flow one way — from Norce to Ingrid. No promotion data is mapped back from Ingrid to Norce.
Setup Requirements
For shipping discount vouchers to work, both systems must be configured with matching codes:
| System | Required Configuration |
|---|---|
| Norce Commerce | Create a promotion using the "Discount freight" effect type with a discount code. The Norce Adapter classifies these as type = shipping on the Norce Checkout order. |
| Ingrid | Configure a shipping rule that matches the same voucher code (e.g., a free shipping rule triggered by the code). Coordinate with your Ingrid account manager. |
How It Works
- The Norce Adapter maps "Discount freight" promotions as
type = shippingdiscounts on the Norce Checkout order. - The Ingrid Adapter extracts the discount codes and sends them as
cart.vouchersin the Ingrid API request. Discount attributes are flattened and appended tocart.attributes. - Ingrid evaluates the voucher codes against its shipping rules and applies the corresponding discount (e.g., free shipping).
Item-level discounts are handled separately — the adapter maps the per-item price difference (originalTotal − total) to Ingrid's cart.items[].discount field. Item discounts are not forwarded as vouchers.
No promotion data is mapped back from Ingrid. The entire Ingrid session is stored as raw JSON in the shippingData attribute on the Norce shipping object.
For implementation details and request/response examples, see the Ingrid Adapter Developer Guide — Promotions and Discounts.
Limitations
- Orders must contain country, culture, and currency before a session can be created.
- The cart must contain at least one item.
- Checkout sessions have a limited lifetime and may expire.
- Available delivery methods and carriers depend on the merchant's configuration in the Ingrid platform.
Shipping States
The adapter uses the following shipping states in Norce Checkout:
| State | Description |
|---|---|
intent | Shipping session created, awaiting customer selection |
processing | Order is being processed, session validated |
confirmed | Session completed successfully |
removed | Shipping removed from order |
Architecture Notes
- Authentication towards Ingrid is handled using API key authentication.
- Merchant configuration is resolved using the API key provided by Ingrid.
- The adapter automatically registers callbacks for:
- Cart changes
- Customer updates (in Search Address Mode)
- Order state transitions
Links and References
Norce Checkout API References
Ingrid Adapter API
Norce Checkout Overview
- Norce Checkout Introduction
- Working with Norce Checkout
- Shipping Adapters Overview
- Ingrid Adapter Developer Guide