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
In WooCommerce admin: WooCommerce → Settings → Advanced → REST API
Click Add Key
Set permissions to Read/Write
Copy Consumer Key and Consumer Secret
In Returns Back-office: Settings → Integrations → Ecom Integration → Add New
Select WooCommerce from dropdown
Enter configuration:
URL: Your WooCommerce store URL
Consumer key: Paste from step 4
Consumer secret: Paste from step 4
Optional settings:
Web-hook secret: For web-hook security
Product manufacturing country key: Custom attribute key
Product HS code key: Custom attribute key
Shipping method ID: Default shipping method
Shipping method title: Shipping display name
Optional checkboxes:
API refunds: Enable automatic refund creation
Refund matches order line amount: Match exact line item amounts
Optional: Enable “Create returns from warehouse notifications”
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 |
