Skip to main content

Custom platform configuration guide

The Custom Platform Integration configuration guide explains how to connect a proprietary or unsupported e-commerce platform to Ingrid Returns using Ingrid's Public API and web-hooks.

J
Written by Jakub Talarek

The Custom Platform Integration configuration guide explains how to connect a proprietary or unsupported e-commerce platform to Ingrid Returns using Ingrid's Public API and web-hooks, enabling automated order lookup, return processing, and refund creation.

Onboarding Requirements

  • Custom platform with API capabilities

  • Ability to implement order lookup endpoint

  • Web-hook support (optional but recommended)

Setup Steps

  1. Review Ingrid Returns API documentation: https://developer.ingrid.com/returns/integration/

  2. Implement on your platform:

    1. Order lookup endpoint: Responds to Ingrid API requests for order data

    2. Refund creation logic: Processes refunds when triggered by Ingrid

    3. Web-hook subscriptions: Listen for return events from Ingrid

  3. In Returns Back-office: Settings → Integrations → Ecom Integration → Add New

  4. Select Custom from dropdown

  5. Optional: Enable “Create returns from warehouse notifications”

  6. Click SAVE

  7. Configure API communication:

    1. Provide your order lookup endpoint URL to Ingrid

    2. Subscribe to Ingrid webhooks: return.created, return.processed, refund.approved

    3. Test integration with sandbox environment

Available Custom Platform Settings

The ecom integration window for a Custom platform has these settings:

  • Ecom (required): select Custom.

  • Ecom link URL: marked as deprecated.

  • Create returns from warehouse notifications: optional checkbox.

Click SAVE to store the settings.

Did this answer your question?

Related Articles