Last updated

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

FeatureFullPartialDescription
Create SessionYesInitialize Ingrid delivery checkout session
Update SessionYesSync cart and customer changes
Complete SessionYesComplete session on order acceptance
Remove SessionYesRemove shipping from order

Supported Delivery Methods

MethodSupportedDescription
Home DeliveryYesStandard and express options
Pickup PointsYesService points, lockers, stores
Scheduled DeliveryYesTime window selection
Multiple CarriersYesBased on Ingrid configuration

Advanced Features

FeatureSupportedDescription
B2B SupportYesBusiness customer checkout
B2C SupportYesConsumer checkout
Bidirectional SyncYesNorce ↔ Ingrid synchronization
Shipping DiscountsYesVoucher support
Logistics Data MappingYesWeight, dimensions, shipping date
Address Form ModeYesIngrid 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.


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:

StateDescription
intentShipping session created, awaiting customer selection
processingOrder is being processed, session validated
confirmedSession completed successfully
removedShipping 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

Norce Checkout API References

Ingrid Adapter API

Norce Checkout Overview

External Documentation