Documentation

Headless Checkout API - Reference



Overview

Ingrid provides HTTP endpoints returning data in JSON format. We provide you with two environments:



Object Reference

Addon

An Addon represents an additional service or feature offered with a delivery.

AddonAddonType

AddonType defines the specific type of addon offered.

- ADDON_TYPE_UNSPECIFIED: Addon type is unspecified or unknown.
- CUSTOM: A custom addon specified by the carrier or merchant.
- CARRY_IN: An addon for carrying the delivery item into the recipient's premises.
- LEAVE_AT_DOOR: An addon for leaving the item at the door without requiring a signature.
- UNWRAPPING: An addon for unwrapping the delivered item.

Enum Values:
  • ADDON_TYPE_UNSPECIFIED
  • CUSTOM
  • CARRY_IN
  • LEAVE_AT_DOOR
  • UNWRAPPING

Address

Represents an address suitable for delivery.

Any

CompleteSessionResponse

Response message for completing a session.

Contact

Contact represents generic contact information.

ContactPhoneNumber

A phone number, including region and optional extension.

Coordinates

Represents a latitude/longitude pair. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.

Delivery

The delivery represents a single delivery of goods to a recipient. It includes information about the goods, the recipient details, the fulfillment methods and the delivery options.

DeliveryCategory

The DeliveryCategory represents a grouping of delivery options that share the same type and other characteristics.

DeliveryCategoryDeliveryType

DeliveryType defines the method or mode of delivery.

- DELIVERY_TYPE_UNSPECIFIED: Delivery type is unspecified or unknown.
- DELIVERY: Delivery to a customer's home or address.
- PICKUP: Delivery to a service point or locker.
- MAILBOX: Delivery to a customer's mailbox.
- INSTORE: Delivery to a merchant's store for in-store pickup.

Enum Values:
  • DELIVERY_TYPE_UNSPECIFIED
  • DELIVERY
  • PICKUP
  • MAILBOX
  • INSTORE

DeliveryCategoryOptionsSource

OptionsSource specifies the origin of the delivery options.

- OPTIONS_SOURCE_UNSPECIFIED: Source of the options is unspecified.
- FALLBACK: Delivery options come from a fallback configuration.
- CARRIER: Delivery options are sourced directly from the carrier.

Enum Values:
  • OPTIONS_SOURCE_UNSPECIFIED
  • FALLBACK
  • CARRIER

DeliveryCategoryWarehouse

Information about a warehouse. All this data is stored in the site configuration.

DeliveryChoice

The DeliveryChoice represents what option is selected for the given delivery.

DeliveryOption

The DeliveryOption represents the details of a specific delivery option.

DeliveryOptionCarrier

The Carrier contains details about the shipping carrier associated with this delivery option.

DeliveryServiceCompleteSessionBody

Request message for completing a session.

Distance

Generic distance

ETD

ETD stands for Estimated Time of Delivery.

ETDAbsolute

Absolute represents an ETD as a single or pair of timestamps.

ETDCustom

Custom represents an ETD in a human-readable text format.

ETDRelative

Relative represents an ETD as a range of time units.

ETDTimeUnit

TimeUnit specifies the unit of time measurement for ETD.

- TIME_UNIT_UNSPECIFIED: Default value. This value is unused.
- TIME_UNIT_MINUTE: Minutes
- TIME_UNIT_HOUR: Hours
- TIME_UNIT_DAY: Calendar days
- TIME_UNIT_BUSINESS_DAY: Business days (excluding weekends and holidays)
- TIME_UNIT_WEEK: Calendar weeks
- TIME_UNIT_MONTH: Calendar months

Enum Values:
  • TIME_UNIT_UNSPECIFIED
  • TIME_UNIT_MINUTE
  • TIME_UNIT_HOUR
  • TIME_UNIT_DAY
  • TIME_UNIT_BUSINESS_DAY
  • TIME_UNIT_WEEK
  • TIME_UNIT_MONTH

Fulfillment

A Fulfillment details when a delivery can be fulfilled.

FulfillmentReadiness

Readiness specifies a time range when the goods will be ready for shipment.

LineItem

Represents a single item.

LineItemDimensions

Represents the dimensions of the item.

PickupLocation

The PickupLocation represents a physical location from which a delivery can be retrieved.

PickupLocationDistances

Distances define the walking and driving distances to the pickup location.

PickupLocationLocationType

LocationType defines the type of the pickup location.

- LOCATION_TYPE_UNSPECIFIED: Unspecified type.
- LOCKER: A locker pickup location.
- STORE: A store pickup location.
- POSTOFFICE: A post office pickup location.
- MANNED: A manned pickup location, e.g., staffed desk.

Enum Values:
  • LOCATION_TYPE_UNSPECIFIED
  • LOCKER
  • STORE
  • POSTOFFICE
  • MANNED

PickupLocationOperationalHours

OperationalHours define when the pickup location is operating.

PickupLocationSection

Section provides extra information about the pickup location.

SectionColumn

Column contains a list of items displayed in a single section column.

SectionItem

Item represents a single piece of information in a section.

Session

A Session is the primary resource for handling the delivery options and the customer lifecycle.

SessionPurchase

Purchase describes purchase experience. Q(grigagod): shoud we stick to a main cart concept?.

SessionState

State defines the current state of the session.

- STATE_UNSPECIFIED: Default value. This value is unused.
- ACTIVE: Session is active and can be modified.
- COMPLETED: Session is completed and can not be modified.

Enum Values:
  • STATE_UNSPECIFIED
  • ACTIVE
  • COMPLETED

Status

Last updated: Thu, Jun 19, 09:58 AM