Documentation

Object Reference

AdditionalInfo

Additional meta information related to the session.

Address

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

Addresses

All address information related to one delivery group.

Any

BillingAddress

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.

CartGroup

Optional specification of group to which the cart items should be assigned.

CartItem

Product in the shopping cart

CompleteSessionRequest

CompleteSessionResponse

Coordinates

Geolocation coordinates

CreateSessionRequest

CreateSessionResponse

CustomerAddress

DateTimeRange

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

DeliveryAddress

DeliveryGroup

Summary of the order.

DeliveryGroupCategory

The Delivery Category selected by the User.

DeliveryGroupDeliveryAddon

Specifies a single selected addon.

DeliveryGroupDeliveryTime

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

DeliveryGroupDeliveryTimeRange

DeliveryGroupItem

Item that belongs to a delivery group.

DeliveryGroupPricing

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.

DeliveryGroupShipping

How the package should be shipped to the end customer.

DeliveryGroupWarehouse

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

GroupContent

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.

Route

Route represents a list of delivery steps.

SearchAddress

Section

SectionColumnItem

SectionItem

Session

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

SessionSummary

ShippingDate

Information about possible shipping dates.

ShippingDateTag

ShippingLeg

ShippingLeg represents a single step of package delivery.

Supports

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

Tag

UpdateSessionRequest

UpdateSessionResponse

Last updated: Mon, Jun 24, 06:15 AM