v1

latestOpenAPI 3.0.12026-07-21161785.3 KB
Points & Earn Rules

Remove points from customer account

post/api/external/remove-points

Headers

X-API-Keystring required

API key for authentication

Request body

customerEmailstring nullable

Customer's email address. Alternative to customerId for identifying the customer. Provide either customerId OR customerEmail, not both. Must be a valid email address that exists in your Shopify store. Email matching is case-insensitive. Example: customer@example.com

customerIdinteger nullable

Shopify customer ID (numeric). Identifies which customer receives the points. Provide either customerId OR customerEmail, not both. Customer must be enrolled in the loyalty program. Example: 67890

earnRuleIdinteger nullable

Optional: ID of an earn rule to associate with this point addition. Used for categorization and reporting purposes only. Does not affect point calculation - points parameter takes precedence. Helps group similar types of point additions in reports. Example: 10

notestring nullable

Optional but strongly recommended: Description of why points are being added. This note appears in the customer's transaction history and admin logs. Best practices:

  • Be specific about the reason
  • Include reference numbers (order ID, ticket ID, etc.)
  • Use consistent formatting for easier reporting Examples:
  • "Birthday bonus - January 2025"
  • "Compensation for delayed shipping - Order #1234"
  • "Referral bonus from external campaign"
  • "Migration - transferred from old system"
  • "Manual adjustment per support ticket #567"
pointsnumber double required

Number of points to add to the customer's account. Must be a positive number. Points are added to availablePoints immediately (not pending). Decimal values are supported for fractional points. Example: 50.0

Example request

{
  "customerEmail": "customer@example.com",
  "note": "Compensation for delayed shipping - Order #1234",
  "points": 50
}

Response

Points successfully removed from customer account

achievableTierIdinteger
availablePointsnumber double
createAtstring date-time
creditedPointsnumber double
currentVipTierstring
customerStatus'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'
dobstring date
expiringPointsAmountnumber double
pendingPointsnumber double
pointsExpireAtstring date-time
referralLinkstring
referredCompletedinteger
rewardedForCreatingAccountboolean
rewardedForFacebookboolean
rewardedForInstagramboolean
rewardedForNewsLetterboolean
rewardedForPinterestboolean
rewardedForSharingOnFacebookboolean
rewardedForSharingOnXboolean
rewardedForSmsboolean
rewardedForTiktokboolean
rewardedForTwitterboolean
rewardedForYoutubeboolean
spentAmountnumber double
storeCreditBalancenumber double
storeCreditCurrencystring
vipTierExpiredAtstring date-time
vipTierSpentAmountnumber double