Documentation

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

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

Any

type_url
string

value
string

Cart

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

items

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.

CartItem

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

Coordinates

Geolocation coordinates

lat
number

Latitude

lng
number

Longitude

CustomerInfo

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.

Error

code
integer

details

error
string

message
string

PrebookingCallback

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

triggered_at
string

DateTime in RFC3339 format. Example `2021-05-08T22:47:31Z07:00`

Result

delivery_time

Delivery time detailing of how the promise given to merchant was produced.

selection

Defines how result was obtained by e.g. user choice or preselection

shipping

Details about delivery options selected

ResultDeliveryTime

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

carrier_delivery_promise

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

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

The assumed/configured pickup time by Carrier from the Merchant Warehouse.

ResultDeliveryTimeRange

earliest
string

DateTime in RFC3339 format. Example `2021-05-08T22:47:31Z07:00`

latest
string

DateTime in RFC3339 format. Example `2021-05-08T22:47:31Z07:00`

ResultShipping

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

Contains information about the features a shipping option should support such as Door code, courier instructions and/or customer number.

warehouse

Address of the warehouse from which the package was assumed to shipped.

ResultWarehouse

address

Session

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 details as items, their weight, dimensions, attributes, quantities as well as shipping date, cart total value and currency.

customer

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

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.

Supports

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: Thu, Dec 08, 06:15 AM