Documentation

Object Reference

AdditionalInfo

Additional meta information related to the session.

Address

Common address entity that used almost everywhere in Ingrid's API.

Any

BillingItem

Individual billing item of the total shipping cost.

CarrierAddon

Carrier specific addons

Cart

Cart information from the e-commerce store. Information in here is used by the shipping rule engine to calculate the best shipping option for the customer.

CartItem

Product in the shopping cart

CompleteSessionRequest

Contains the data needed to complete a session

CompleteSessionResponse

Returns the completed session state

Coordinates

Geolocation coordinates

Cost

Cost amount

CreateSessionFromOrderRequest

Contains the required information to initialize session from transport order.

CreateSessionFromOrderResponse

Contains the session object from tos order and shipping selector HTML snippet

CreateSessionRequest

Contains the required information to initialize a new session.

CreateSessionResponse

Contains the session object and shipping selector HTML snippet

CustomerInfo

Contains information about the customer such as name, address, email and mobile phone number.

DateTimeRange

Provides a date interval. Depending on a case, `start` and `end` parts are not guaranteed to be present.

Dimensions

Dimensions of an item in millimeters.

Distance

Walking and driving distance information (if available). This depends if we could reverse geolocate supplied address and succeeded in finding a nearest route from A to B. Usually only available for distance information between address provided by the customer and service point address.

DistanceSpec

Generic distance object used by Distance object to provide driving and walking information.

Error

GetSessionResponse

Returns the current session state and shipping selector HTML snippet

LegLocation

LegLocation represents a location that takes part in a delivery.

ListSessionsSummariesResponse

Contains the list of session IDs with result fields.

OperationalHours

Service points's operational hours

PickupLocation

Contains information about the pickup service point as returned by the carrier.

PriceComponent

Specifies a single price component.

Result

Summary of the shipment.

ResultCategory

The Delivery Category selected by the User.

ResultDeliveryAddon

Specifies a single selected addon.

ResultDeliveryTime

Listing of Delivery Time Components produced by the Ingrid Delivery Checkout.

ResultDeliveryTimeRange

ResultPricing

The price of the delivery promise from Ingrid Delivery Checkout. Given as a total or divided into it is components for cases such as separating eg. Delivery Addons selected by the user during checkout.

ResultShipping

How the package should be shipped to the end customer.

ResultWarehouse

Route

A route represents a list of delivery steps for a chained delivery.

Section

SectionColumnItem

SectionItem

SelectedShippingOption

Contains shipping option chosen by the user after the session is completed

Session

Contains information about the current session. Each session is unique for every customer transaction

SessionSummary

Contains the result field associated with session id.

ShippingCost

Detailed information about the shipping cost.

ShippingDate

Information about possible shipping dates

ShippingDateTag

ShippingLeg

Represents a single step in the chained delivery.

SnippetConfiguration

Supports

Contains information about features that a shipping option supports. Configurable in Merchant Admin tool.

Tag

TimeSlot

Contains information about estimated delivery times

UpdateSessionRequest

Contains the data needed to update the session

UpdateSessionResponse

Returns the current session state

Last updated: Mon, Apr 15, 06:15 AM