Object Reference

AdditionalInfo

courier_instructions 🔗	string optional Courier instruction provided by the customer
customer_number 🔗	string optional Customer number is the carrier identifier that is sometimes required for certain delivery options
door_code 🔗	string optional Entrance door code provided by the customer that can be used by the courier to get in

address_lines 🔗	string[] List of address lines part of address such as street, street nbr and building/apartment number
city 🔗	string Name of the City
coordinates 🔗	Coordinates optional Geolocation coordinates of the address. Available if reverse geolocation lookup of the address was successful.
country 🔗	string Country should be specified as two uppercase letters (ISO Alpha-2). Example 'SE' for Sweden, 'ES' for Spain
name 🔗	string Customer or Company name
postal_code 🔗	string Postal code / Zipcode

type_url 🔗	string
value 🔗	string

Cart information from the e-commerce store. Information in here is used by the Ingrid Delivery Logic to calculate delivery options

items 🔗	CartItem[] The Cart contains items and parameters that could be used but the Checkout Delivery Logic
pre_order 🔗	boolean Indicates if the order is a pre-order on Merchant side which impacts the delivery promise presented to the consumer

A product in the e-commerce checkout cart

name 🔗	string optional Product name
out_of_stock 🔗	boolean optional Flag indicating if the item is currently out of stock at time of purchase
quantity 🔗	integer Total qty of the product in the cart
sku 🔗	string Merchants unique product identifier

Geolocation coordinates

lat 🔗	number Latitude
lng 🔗	number Longitude

address 🔗	Address Customer's recipient address. The address information is used as recipient address information to accurately calculate the delivery options
email 🔗	string optional Customer's email to where email notifications would be sent if applicable.
phone 🔗	string optional Customer's mobile phone number to where SMS notifications would be sent applicable.

meta 🔗	hash Generic key/value object that is used for supplying complementary information
prebooking_id 🔗	string Unique identifier of the callback formatted as shipping_method:UUID
session 🔗	Session
triggered_at 🔗	string DateTime in RFC3339 format. Example `2021-05-08T22:47:31+01:00`

delivery_time 🔗	ResultDeliveryTime Delivery time detailing of how the promise given to merchant was produced
selection 🔗	ResultSelection Defines how result was obtained by e.g. user choice or preselection
shipping 🔗	ResultShipping Details about delivery options selected

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

carrier_delivery_promise 🔗	ResultDeliveryTimeRange The date and time result based on carrier responses and/or carrier settings. Carrier_delivery_promise might or might not match the customer_delivery_promise depending on Merchant settings. e.g. if checkout presentation is set to promise business days, while carrier is able to deliver parcels on saturdays, carrier_delivery_promise and customer_delivery_promise could differ
customer_delivery_promise 🔗	ResultDeliveryTimeRange The underlying date and time result of the delivery time promise presented to the end consumer in checkout The presentation format of the delivery time is typically not "date and time" but "nbr of business days"
pickup_from_merchant 🔗	ResultDeliveryTimeRange The assumed/configured pickup time by Carrier from the Merchant Warehouse

earliest 🔗	string DateTime in RFC3339 format. Example `2021-05-08T22:47:31+01:00`
latest 🔗	string DateTime in RFC3339 format. Example `2021-05-08T22:47:31+01:00`

carrier 🔗	string Name of the Delivery company
delivery_type 🔗	string The type of delivery (PICKUP, INSTORE, MAILBOX, DELIVERY)
meta 🔗	hash Carrier specific meta data related to the delivery option, for example addons or carrier specifics functionality
product 🔗	string Name of the Carrier product
shipping_method 🔗	string Ingrid's ID of the shipping product. Example 'bst-std' for BEST Delivery
supports 🔗	Supports Contains information about the features a shipping option should support such as Door code, courier instructions and/or customer number
warehouse 🔗	ResultWarehouse Address of the warehouse from which the package was assumed to shipped

address 🔗

Address

additional_information 🔗	AdditionalInfo optional Additional but not required information associated with the current order such as door code, courier instruction and/or carrier customer number
cart 🔗	Cart Cart details as items, their weight, dimensions, attributes, quantities as well as shipping date, cart total value and currency
customer 🔗	CustomerInfo Information about the customer such as name, email, phone and address. This information is required when completing an Ingrid Checkout session. The address information is used as recipient address information to correctly calculate the final delivery option
purchase_country 🔗	string Country where the purchase is being made. Should be in sync with the checkout country. Example 'SE' for Sweden
result 🔗	Result The session result field defines the outcome of Ingrid Checkout for the given delivery. It contains details actual Delivery selection, the selection type user choice vs. preselection and delivery time details

The enabled additional fields possible to add for the selection delivery option

courier_instructions 🔗	boolean Shows if courier instruction was possible to set for the end consumer or not
customer_number 🔗	boolean Shows if carrier customer number s possible to set for the end consumer or not
door_code 🔗	boolean Shows if door code was possible to set for the end consumer or not
search 🔗	boolean

Last updated: Fri, Dec 20, 06:15 AM