DOCSEARCHbyAlgolia
Submit Docs

Ingrid Developer Documentation

website·Indexed 36 days ago

https://developer.ingrid.com/

Developer resources for Ingrid's suite of delivery and logistics APIs, including Headless Checkout, Delivery Tracking, Address API (validation and suggestions), Prebooking, and In-store integration via the Public Carrier Protocol (PCP).

Tokens
132.4K
Snippets
625
Records
934
Agent score
53%

What's inside Ingrid

  1. Introduction to Ingrid Delivery Checkout

    The Delivery Checkout API allows developers to implement a flexible delivery options selector widget within a checkout page. It is designed to optimize the delivery selection process for speed and convenience. The API is highly customizable and supports three primary business models: single cart merchants, merchants supporting split shipments, and marketplaces.

  2. Overview of providing orders to Ingrid Delivery Tracking

    Ingrid Delivery Tracking focuses on order-level tracking rather than just individual parcels. A single order can contain multiple parcels, each tracked independently. There are three primary ways to provide order data to the system:

    1. Ingrid Delivery Checkout (V1 and V2): Orders are automatically recognized and tracked out of the box.
    2. Ingrid Transport Administration: Orders created directly from shipments in Transport Administration are automatically recognized.
    3. External Registration: Orders created outside the Ingrid ecosystem must be registered manually via the CreateTrackingOrder API endpoint.

  3. Introduction to the Ingrid Product Page Widget

    The Product Page Widget is a tool that allows users to check delivery options directly on a product website, improving the shopping experience by providing shipping information before the checkout process.

  4. Overview of Ingrid Currency Conversion

    Ingrid's currency conversion allows the Shipping Selector to display prices based on FX rates provided via an API. The system provides two environments for development and production:

    • Stage: Used for testing and development. Base URL: https://api-stage.ingrid.com
    • Production: Used for live environments. Base URL: https://api.ingrid.com

  5. Overview of the Address Book API

    The Address Book API provides endpoints to create, read, update, and delete addresses associated with a user's account. An Address Book Id is a unique identifier for each address book, which can be a user ID or any other unique string that identifies the address book.

  6. Overview of the Public Carrier Protocol (PCP) delivery journey

    The Public Carrier Protocol (PCP) enables carriers to integrate with the Ingrid delivery platform. The typical delivery lifecycle follows these steps:

    1. Pre-advice: The carrier provides shipment data to the platform when a booking is received.
    2. Ingestion: The parcel is scanned at a store/locker; the platform notifies the carrier that the parcel is ready for the consumer.
    3. Notification: The carrier notifies the consumer that the parcel is ready for pickup.
    4. Validation: The consumer identifies themselves (via QR code or ID); the platform requests validation from the carrier.
    5. Handover: If validated, the parcel is handed to the consumer.
    6. Delivery Confirmation: The platform notifies the carrier that the parcel has been delivered.

  7. Overview of Headless Checkout API

    The Headless Checkout API allows retailers using Ingrid Checkout to build custom checkout frontends while leveraging Ingrid's backend for delivery solutions. Key capabilities include:

    • Custom UI/UX: Design your own checkout experience while using Ingrid's delivery backend.
    • Carrier Integration: Seamlessly integrate various carriers and delivery mechanisms.
    • Smart Delivery Logic: Dynamically select and pre-select optimal shipping options based on product, region, and customer to increase conversion rates and average order values.
    • Analytics: Access detailed delivery analytics for data-informed decision making.

  8. Introduction to the Ingrid Upsell Widget

    The Ingrid Upsell Widget is designed to increase revenue by encouraging customers to add more items to their cart in exchange for qualifying for free delivery.

  9. Overview of Ingrid Currency Conversion

    The Currency Conversion feature allows the Shipping Selector to display prices based on FX rates provided via an API. Ingrid provides two environments for development and production:

    • Stage: Used for testing and development. Base URL: https://api-stage.ingrid.com
    • Production: Used for live environments. Base URL: https://api.ingrid.com

  10. Overview of Ingrid Delivery Tracking

    Ingrid Delivery Tracking provides a harmonized process for monitoring order delivery and communicating status to end customers. It tracks the entire lifecycle of a delivery: from checkout completion and warehouse preparation to carrier transport, final receipt by the customer, or the return process.

  11. Overview of Ingrid Address Validation API

    The Address Validation API verifies that user-entered addresses are accurate and standardized against authoritative data sources to reduce shipping and billing errors. It supports multiple address providers, including Google Maps and Loqate.

  12. Overview of the Public Carrier Protocol (PCP)

    The Public Carrier Protocol (PCP) allows carriers to integrate with the Ingrid delivery platform. Carriers provide shipment data to the platform and receive event notifications (e.g., when a parcel is delivered).

    A typical delivery journey follows these steps:

    1. Carrier pre-advises the platform with shipment data.
    2. Parcel is scanned at the store; the platform notifies the carrier it is ready for consumer pickup.
    3. Carrier notifies the consumer.
    4. Consumer identifies themselves via QR code or ID; the platform requests validation from the carrier.
    5. If validated, the parcel is handed over, and the platform notifies the carrier of the delivery.