Skip to main content

Brink Retail configuration guide

The Brink Retail configuration guide explains how to connect your Brink Retail store to Ingrid Returns using OAuth authentication, enabling automated order lookup and return processing via the Management and Shopper APIs.

I
Written by Iuliia Prylypko

The Brink Retail configuration guide explains how to connect your Brink Retail store to Ingrid Returns using OAuth authentication, enabling automated order lookup and return processing via the Management and Shopper APIs.

Onboarding Requirements

  • Brink Retail account

  • Management and Shopper API credentials

  • OAuth client credentials

Setup Steps

  1. In Brink Retail admin, generate:

    1. Management API credentials

    2. Shopper API credentials

    3. OAuth client ID and secret

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

  3. Select Brink retail from dropdown

  4. Enter API configuration:

    1. Management API URL: Management endpoint

    2. Shopper API URL: Shopper endpoint

    3. API Key: Default is “BrinkCommerceDefaultApiKey” (can be customised)

  5. Configure OAuth:

    1. Auth URL: OAuth authorisation endpoint

    2. Client ID: OAuth client identifier

    3. Client Secret: OAuth client secret

  6. Enter Terms URL: Link to terms and conditions

  7. Configure product settings:

    1. Product property keys: Select relevant product properties

    2. Store group IDs: Select applicable store groups

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

  9. Click SAVE

Available Brink Retail Settings

Setting

Description

Required

Management API Url

Base URL for the Brink Retail Management API. Used for administrative operations such as retrieving order or store data.

Yes

Shopper API Url

Base URL for the Brink Retail Shopper API. Used for customer-facing operations (e.g., order lookups, return creation, etc.).

Yes

API Key

API key used to authenticate requests to Brink Retail APIs.

Yes

Auth Url

Authorisation endpoint URL used for authentication flows (e.g., OAuth token retrieval).

Yes

Client ID

Client identifier used together with Client Secret for authentication against the Auth service.

Yes

Client Secret

Secret key paired with the Client ID for secure authentication.

Yes

Terms URL

URL to the merchant’s terms and conditions page. Likely used in return flows or customer-facing communication.

Yes

Product property keys

Optional configuration field.
If provided, Ingrid will use the specified product property keys (from the customAttributes object on product variants) instead of relying on variant names.
⚠ Keys are case-sensitive.

No

Store group IDs

Used to filter which orders are visible/processed based on Brink Retail store groups. Only orders belonging to the specified store groups will be included.

No

Create returns from warehouse notifications

Checkbox. When enabled, Ingrid automatically creates return cases based on warehouse notifications.

No

Did this answer your question?

Related Articles