Documentation

Headless Checkout API - Glossary

You may stumble upon some unfamiliar concepts in the documentation. This section lists the common terms in the documentation for easy access, learning and getting more insight into business context of the Ingrid system.

Retailer

A retailer is a company primarily engaged in online sales. A retailer may operate one or more sites, which are online shops managed by that retailer.

Site

An entity in Ingrid system that represents a single online shop or website. It is used to group all the data related to a specific online shop. One retailer can have multiple sites, and each site can have its own configuration, delivery options, and settings.

Configuration

The underlying settings for how Ingrid products will work in the specific site. Configuration enables retailer to control and customise how the Ingrid products work such as:

Carrier

A company that performs the delivery of the actual parcels and packages sent by the retailer to their customers, e.g. DHL, PostNord, InPost.

Carrier product

An entity in Ingrid system that represents actual integration with carriers system. Carriers define their products and Ingrid integrates with them. A full list of carrier products offered by Ingrid can be found in Supported Carrier Products. Retailer uses carrier products in the configuration to define what delivery offering will be available in the checkout.

Session

The session is the central element of the Headless Checkout, representing a single checkout session for a customer. It contains cart information, customer information, delivery options, and other relevant data.

Delivery

A delivery as part of a session represents a collection of cart items that will be sent to the customer in separate packages. In a typical checkout flow, there is usually one delivery. However, there are instances when a retailer might inform the customer that their items will be delivered in multiple packages, allowing the customer to select delivery options for each package. This can occur due to:

If a retailer prefers not to inform the customer about multiple deliveries during checkout, they can opt to group all items into a single delivery. Multiple shipments can then be created later within the transport system.

Category

Also referred to as the delivery category, this entity defines the delivery offering available to consumers in the Headless Checkout. Examples include 'Home Delivery,' 'Pickup Point,' 'Parcel Locker,' and 'Click & Collect.'

Category option

A category option is a specific delivery choice available for selection by the customer within a particular category. For instance, if there is a category for 'Pickup Points' that offers a list of 20 options, each pickup point is represented as a separate category option. Although they all fall under the same category, customer can pick only one pickup location (option).

Order

An order represents a completed session. It contains all the essential information resulting from the user's interaction with the Headless Checkout, necessary for fulfilling the delivery. This includes user choice, cart details, delivery address, customer information, and more. Booking, tracking and analytics are conducted based on orders.

Ingrid Merchant Platform (IMP)

It is the administration portal for Ingrid clients. It can be used to manage sites, configure widgets, manage orders, track shipments and more.

Production: https://mad.ingrid.com/, stage: https://mad-stage.ingrid.com/.

Attributes

Attributes are custom strings that can be added to the session for delivery and/or line items. They allow additional information to be passed to the Ingrid system, which can then be used in filter rules within configuration to apply custom logic to delivery categories. For example:

Last updated: Thu, May 29, 06:39 AM