---
updatedAt: 2026-06-25T13:16:45.000Z
agentTools:
  projectIndex: https://loyalty.developer.dotdigital.com/llms.txt
---

# Get member loyalty data

Retrieves all the loyalty details for the specified Shopify member.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Dotdigital Loyalty",
    "description": "Manage loyalty program members, rewards, and rules. Use this API to retrieve\nmember details, points history, redemption history, and tier progress; list\navailable rewards and generate coupon codes; and list reward rules and register\nsocial media engagement events for a customer.",
    "version": "v1.0.1"
  },
  "externalDocs": {
    "description": "Learn more about Dotdigital Loyalty APIs",
    "url": "https://developer-loyalty.dotdigital.com/"
  },
  "servers": [
    {
      "url": "https://{region}-api.dotdigital.com",
      "variables": {
        "region": {
          "description": "The Dotdigital region id your account belongs to",
          "enum": [
            "r1",
            "r2",
            "r3"
          ],
          "default": "r1"
        }
      }
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/loyalty/v1/members/{shopifyId}": {
      "get": {
        "tags": [
          "Members"
        ],
        "summary": "Get member loyalty data",
        "description": "Retrieves all the loyalty details for the specified Shopify member.",
        "parameters": [
          {
            "name": "shopifyId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/inline_response_200"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MemberDetails": {
        "required": [
          "birthdayDate",
          "currentTier",
          "eligibleRewards",
          "eligibleRules",
          "email",
          "emailMarketingConsentState",
          "firstName",
          "id",
          "joinedDate",
          "lastActivityDate",
          "lastName",
          "pointsBalance",
          "pointsExpirationDate",
          "smsMarketingConsentState",
          "telephoneNumber"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Shopify id",
            "format": "int64",
            "example": 12345
          },
          "firstName": {
            "type": "string",
            "description": "Members first name",
            "nullable": true,
            "example": "Some"
          },
          "lastName": {
            "type": "string",
            "description": "Members last name",
            "nullable": true,
            "example": "Member"
          },
          "email": {
            "type": "string",
            "description": "Members email address",
            "format": "email",
            "nullable": true
          },
          "telephoneNumber": {
            "pattern": "^\\+[1-9]\\d{10,14}$",
            "type": "string",
            "description": "Members mobile phone number",
            "nullable": true,
            "example": "+447123123123"
          },
          "birthdayDate": {
            "type": "string",
            "description": "Members DOB",
            "format": "date",
            "nullable": true
          },
          "lastActivityDate": {
            "type": "string",
            "description": "The date and time the members was last active in UTC time.",
            "format": "date-time"
          },
          "pointsExpirationDate": {
            "type": "string",
            "description": "The date and time the rewards points expire in UTC time.",
            "format": "date-time",
            "nullable": true
          },
          "joinedDate": {
            "type": "string",
            "description": "The date and time that the member joined the rewards program in UTC time.",
            "format": "date-time"
          },
          "pointsBalance": {
            "minimum": 0,
            "type": "integer",
            "description": "The members current reward points balance.",
            "format": "int32"
          },
          "emailMarketingConsentState": {
            "type": "string",
            "description": "The marketing consent state for emails.",
            "example": "Subscribed",
            "enum": [
              "Not subscribed",
              "Pending",
              "Redacted",
              "Subscribed",
              "Unsubscribed"
            ]
          },
          "smsMarketingConsentState": {
            "type": "string",
            "description": "The marketing consent state for SMS/MMS/RCS.",
            "example": "Unsubscribed",
            "enum": [
              "Not subscribed",
              "Pending",
              "Redacted",
              "Subscribed",
              "Unsubscribed"
            ]
          },
          "eligibleRewards": {
            "type": "array",
            "description": "Any rewards the member is currently eligible for.",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/MemberRewardDetails"
            }
          },
          "eligibleRules": {
            "type": "array",
            "description": "Any member rules the member is currently eligible for.",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/MemberRuleDetails"
            }
          },
          "currentTier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TierDetails"
              },
              {
                "description": "The members current reward tier."
              }
            ]
          }
        },
        "additionalProperties": false
      },
      "MemberRewardDetails": {
        "required": [
          "available",
          "cost",
          "id",
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique id for the reward.",
            "format": "uuid"
          },
          "cost": {
            "type": "integer",
            "description": "The cost in reward points.",
            "format": "int32",
            "example": 10
          },
          "type": {
            "$ref": "#/components/schemas/RewardType"
          },
          "name": {
            "type": "string",
            "description": "The name of the reward.",
            "nullable": true,
            "example": "Free P&P"
          },
          "available": {
            "type": "boolean",
            "description": "Whether the reward is available for redemption."
          }
        },
        "additionalProperties": false
      },
      "MemberRuleDetails": {
        "required": [
          "alreadyFulfilled",
          "definition",
          "id",
          "points",
          "type"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the rule.",
            "format": "uuid"
          },
          "points": {
            "type": "integer",
            "description": "The reward points associated with the rule.",
            "format": "int32",
            "example": 5
          },
          "type": {
            "$ref": "#/components/schemas/RuleType"
          },
          "definition": {
            "type": "object",
            "description": "The definition of the rule.",
            "nullable": true,
            "example": "{}"
          },
          "alreadyFulfilled": {
            "type": "boolean",
            "description": "Whether the rule has been already fulfilled for the member.",
            "nullable": true,
            "example": false
          }
        },
        "additionalProperties": false
      },
      "RewardType": {
        "type": "string",
        "description": "The type of reward.",
        "example": "FreeShippingCouponCode",
        "enum": [
          "FixedAmountDiscountCouponCode",
          "PercentageOffWholeCartDiscountCouponCode",
          "FreeShippingCouponCode"
        ]
      },
      "RuleType": {
        "type": "string",
        "description": "The reward rules type.",
        "example": "Purchase",
        "enum": [
          "Purchase",
          "SignUp",
          "Birthday",
          "Anniversary",
          "SocialEngagement"
        ]
      },
      "TierDetails": {
        "required": [
          "achievedDate",
          "id",
          "level",
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique id for this record.",
            "format": "uuid"
          },
          "achievedDate": {
            "type": "string",
            "description": "The date and time when the member achieved this reward tier in UTC.",
            "format": "date-time"
          },
          "name": {
            "type": "string",
            "description": "The name of the reward tier.",
            "nullable": true,
            "example": "First purchase"
          },
          "level": {
            "minimum": 0,
            "type": "integer",
            "description": "The tier hierarchy level.",
            "format": "int32",
            "example": 1
          }
        },
        "additionalProperties": false
      },
      "inline_response_200": {
        "allOf": [
          {
            "description": "The members details."
          },
          {
            "$ref": "#/components/schemas/MemberDetails"
          }
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-samples-languages": [
    "curl",
    "csharp",
    "java",
    "javascript",
    "node",
    "python",
    "php",
    "ruby"
  ]
}
```

# Sibling pages

* [Get a members reward point history](https://loyalty.developer.dotdigital.com/reference/get_loyalty-v1-members-shopifyid-points-history.md)
* [Get a members reward redemption history](https://loyalty.developer.dotdigital.com/reference/get_loyalty-v1-members-shopifyid-redemption-history.md)
* [Get a members progress towards the next tier](https://loyalty.developer.dotdigital.com/reference/get_loyalty-v1-members-shopifyid-tier-progress.md)
* [Get loyalty members](https://loyalty.developer.dotdigital.com/reference/get_loyalty-v1-members.md)