Vinoshipper Integration Guide

Connecting Vinoshipper to LoyaltyMatch

Overview

LoyaltyMatch integrates with Vinoshipper to:

  • Automatically register wine club members
  • Sync customer records
  • Award loyalty points for purchases
  • Allow members to redeem points for rewards or store credits
  • Connect LoyaltyMatch embedded or iFrame plugins directly to your Vinoshipper store

This integration requires two components:

  1. Webhooks (Vinoshipper → LoyaltyMatch)
  2. API Keys (LoyaltyMatch → Vinoshipper)

Once configured, the systems will communicate automatically.

Part 1: Configure Webhooks in Vinoshipper

Webhooks allow Vinoshipper to notify LoyaltyMatch when important events occur (new order, new customer, club membership changes, etc.).

Navigate in the Vinoshipper Admin Panel:

Account → Integrations → Webhooks → Create New Webhook

You will need to create three separate webhooks.

1. Club Membership Webhook

Endpoint URL:

{your LoyaltyMatch API URL}/api/vinoClub

Type:

CLUB_MEMBERSHIP

This webhook ensures that:

  • Wine club members are registered in LoyaltyMatch
  • Club changes are reflected in the loyalty system
  • Points can be awarded properly for club activity

2. Customer Webhook

Endpoint URL:

{your LoyaltyMatch API URL}/api/vinoCustomer

Type:

CUSTOMER

This webhook ensures:

  • New Vinoshipper customers are created in LoyaltyMatch
  • Customer updates stay synchronized
  • Loyalty accounts remain aligned with Vinoshipper records

3. Order Webhook

Endpoint URL:

{your LoyaltyMatch API URL}/api/vinoOrder

Type:

ORDER

This webhook allows LoyaltyMatch to:

  • Track completed purchases
  • Calculate points automatically
  • Apply Merchant Point Conversions
  • Trigger reward logic

Once saved, your webhooks are complete.

Part 2: Create an API Key for LoyaltyMatch

LoyaltyMatch requires API credentials to:

  • Create customer accounts
  • Register club members
  • Connect embedded or iFrame plugins
  • Apply credits or redemptions

Navigate in the Vinoshipper Admin Panel:

Account → Integrations → API Keys → Create New Key

After creating the key:

  • Copy the API Key
  • Copy the Secret Key

These credentials must be securely added to your LoyaltyMatch configuration.

⚠️ Keep these keys private. Treat them like passwords.

Part 3: Configure Merchant Settings in LoyaltyMatch

To award points for purchases, a Merchant must be configured in LoyaltyMatch.

Step 1: Create or Edit a Merchant

A Merchant account represents your Vinoshipper store inside LoyaltyMatch.

The Merchant's altMerchantId must match your Vinoshipper Store ID exactly.

This ensures:

  • Orders from your Vinoshipper store are properly matched
  • Points are awarded to the correct merchant
  • Reporting remains accurate

Step 2: Configure Point Conversion

To define how points are earned:

Navigate in LoyaltyMatch:

Merchant → Commerce Uploads → Add Point Conversion

Then:

  • Select your Merchant
  • Enter Points per Dollar
  • Select your Currency
  • Save

Example structures:

  • 1 point per $1
  • 5 points per $1
  • Custom ratio depending on your program

This conversion rule tells LoyaltyMatch how many points to award for each completed order received via the ORDER webhook.

How the Full Flow Works

Once everything is configured:

  1. A customer joins your wine club → LoyaltyMatch creates or updates the loyalty member.
  2. A customer places an order → LoyaltyMatch receives the order webhook.
  3. LoyaltyMatch applies the Merchant Point Conversion.
  4. Points are awarded automatically.
  5. Members can redeem points for rewards or credits.
  6. Redemptions can be pushed back into Vinoshipper using the API.

The entire system becomes automated.

Integration Checklist

  • ☐ Create 3 Webhooks
  • ☐ Add correct Endpoint URLs
  • ☐ Create API Key and Secret
  • ☐ Add API credentials to LoyaltyMatch
  • ☐ Configure Merchant altMerchantId
  • ☐ Create Merchant Point Conversion

Once these steps are complete, your integration is live.