---
title: "Brink configuration guide"
canonical: "https://ingrid-support.refined.site/space/KB/406945793/Brink%20configuration%20guide"
format: markdown
---
The Brink configuration guide explains how to connect your Brink Commerce store to Ingrid Returns via REST and GraphQL APIs, enabling automated order lookup, return processing, and refund handling.
---
### Onboarding Requirements
- Brink Commerce account
- REST API and GraphQL API credentials
---
### **Setup Steps**
1. In Brink admin, generate API credentials (both REST and GraphQL)
2. In Returns Back-office: **Settings → Integrations → Ecom Integration → Add New**
3. Select **Brink** from dropdown
4. Enter API configuration:
1. **Rest API URL**: Brink REST API endpoint
2. **Rest API Key**: REST authentication key
3. **GraphQL API URL**: Brink GraphQL endpoint
4. **GraphQL API Key**: GraphQL authentication key
5. Configure payment and shipping:
1. **Payment provider**: Select your payment gateway
2. **Shipping solution**: Select shipping provider
3. **Shipping product ID**: Product ID for return shipping
6. Enter store URLs:
1. **Terms URL**: Link to your terms and conditions
2. **Merchant URL**: Your store website URL
7. Optional. Enable refunds handling:
1. Check **Handle refunds**
2. Enter **Turnr API Username**
3. Enter **Turnr API Password**
8. Optional: Enable “Create returns from warehouse notifications”
9. Click **SAVE**
---
### **Available Brink Settings**
| **Setting** | **Description** | **Required** |
| --- | --- | --- |
| Rest API Url | The base URL for Brink’s REST API endpoint. Used for standard API operations such as fetching and updating order or product data. | Yes |
| Rest API Key | API key used to authenticate requests made to Brink’s REST API. | Yes |
| GraphQL API Url | The base URL for Brink’s GraphQL API endpoint. Used for querying structured data via GraphQL. | No |
| GraphQL API Key | API key used to authenticate requests made to the Brink GraphQL API. | No |
| Payment provider | Specifies which payment provider is used in the Brink setup. This affects how refunds and payment-related operations are handled:
- **Klarna** – Integration tailored for Klarna payments
**Adyen** – Integration tailored for Adyen payments | Yes |
| Shipping solution | Defines which shipping solution is used:
- **Ingrid** – Uses Ingrid for shipping logic and handling
**Internal** – Uses Brink’s internal shipping logic
**Nshift** – Uses Nshift as the shipping provider integration | Yes |
| Shipping product ID | Identifier of the shipping product in Brink. Used when shipping needs to be represented as a product line item in the order. | No |
| Terms URL | URL to the store’s terms and conditions page. Likely used in return flows or customer-facing documentation. | No |
| Merchant URL | URL to the merchant’s website. Used for redirects, references, or linking in customer communication. | No |
| Handle refunds | Checkbox. When enabled, Ingrid will handle and trigger refund operations via the Brink/payment provider integration. | No |
| Turn API Username | Username used to authenticate against the Turn API (likely related to returns or refund processing). | No |
| Turn API Password | Password used together with the Turn API Username for authentication. | No |
| Create returns from warehouse notifications | Checkbox. When enabled, Ingrid automatically creates return cases based on warehouse notifications. | No |
