Skip to main content

WooCommerce configuration guide

The WooCommerce configuration guide explains how to connect your WooCommerce store to Ingrid Returns via the REST API, enabling automated order lookup, return processing, and refund creation directly in your WooCommerce admin.

I
Written by Iuliia Prylypko

The WooCommerce configuration guide explains how to connect your WooCommerce store to Ingrid Returns via the REST API, enabling automated order lookup, return processing, and refund creation directly in your WooCommerce admin.


Onboarding Requirements

  • WooCommerce admin access

  • REST API enabled


Setup Steps

  1. In WooCommerce admin: WooCommerce → Settings → Advanced → REST API

  2. Click Add Key

  3. Set permissions to Read/Write

  4. Copy Consumer Key and Consumer Secret

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

  6. Select WooCommerce from dropdown

  7. Enter configuration:

    1. URL: Your WooCommerce store URL

    2. Consumer key: Paste from step 4

    3. Consumer secret: Paste from step 4

  8. Optional settings:

  9. Web-hook secret: For web-hook security

    1. Product manufacturing country key: Custom attribute key

    2. Product HS code key: Custom attribute key

    3. Shipping method ID: Default shipping method

    4. Shipping method title: Shipping display name

  10. Optional checkboxes:

    1. API refunds: Enable automatic refund creation

    2. Refund matches order line amount: Match exact line item amounts

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

  12. Click SAVE


Available Woocommerce Settings

Setting

Description

Required

Url

The base URL of the WooCommerce store (e.g., https://yourstore.com ). Used as the endpoint for API communication.

Yes

Consumer key

WooCommerce REST API Consumer Key. Used to authenticate API requests from Ingrid to WooCommerce.

Yes

Consumer secret

WooCommerce REST API Consumer Secret. Paired with the Consumer Key for secure authentication.

Yes

API refunds

Checkbox. When enabled, refunds are created and processed directly via the WooCommerce REST API instead of being handled manually or via another mechanism.

No

Web-hook secret

Secret key used to verify incoming webhook requests from WooCommerce to ensure they are authentic and untampered.

Yes

Product manufacturing country key

The WooCommerce product meta key that stores the manufacturing country. Used for customs, compliance, and shipping-related workflows.

Yes

Product HS code key

The WooCommerce product meta key that stores the HS (Harmonised System) code. Used for international shipping and customs declarations.

Yes

Refund matches order line amount

Checkbox. When enabled, the refund amount will match the exact order line amount. Ensures refund values correspond precisely to original line item pricing.

No

Shipping method ID

The WooCommerce shipping method identifier used when creating or syncing orders and returns.

Yes

Shipping method title

The display name/title of the shipping method that will appear on the order (e.g., “Standard Shipping”, “Express Delivery”).

Yes

Create returns from warehouse notifications

Checkbox. When enabled, Ingrid automatically creates return cases based on warehouse notifications (e.g., when returned goods are received).

No

Did this answer your question?