APappstle
Referrals

Accept referral offer (GET)

Changed on

Accepts a referral offer using the referral token and email address via query parameters. This is a convenience endpoint that provides the same functionality as the POST version but via GET request. Useful for simple referral link implementations where query parameters are easier to construct. Creates a new customer referral record and may generate a welcome discount code for the referee.

get/loyalty/cp/api/referral-rules/accept-offer

Request

  • Base URL
    https://your-store.myshopify.com/apps
  • URL
    https://your-store.myshopify.com/apps/loyalty/cp/api/referral-rules/accept-offer
  • Auth
    none declared

Query parameters

tokenstring required

Referral token received from the referrer

emailstring required

Email address of the person accepting the referral

Response

Referral offer accepted successfully

discountCodestring
errorKeystring
existingCustomerboolean
idinteger
messagestring
status'SUCCESS' | 'FAILED'

Changes

  • eace591c6962Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0f423f0dce11Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status