Skip to main content
POST
Add points to customer account

Headers

X-API-Key
string
required

API key for authentication

Body

application/json

Request containing customer ID/email, points to add, and optional description

points
number<double>
required

Number of points to add to the customer's account. Must be greater than 0. Points are added to availablePoints immediately, unless the earn rule in earnRuleId requires manual approval. Decimal values are supported for fractional points. Example: 50.0

Required range: x >= 0.01
Example:

50

customerEmail
string | null

Customer's email address. Alternative to customerId for identifying the customer. Provide customerId or customerEmail. When you send both, customerId is used. Must be the email of a customer in your store's loyalty customer list, or the call returns 400 with the title "Customer not found using this email". Email matching is case-insensitive. Example: customer@example.com

Example:

"customer@example.com"

customerId
integer<int64> | null

Shopify customer ID (numeric). Identifies the customer whose points change. Provide customerId or customerEmail. When you send both, customerId is used. The customer must be in your store's loyalty customer list, or the call returns 400 with the title "Customer not found using this customerID". The customer's status isn't checked: the call also works for a customer the merchant excluded or who opted out. Example: 67890

Example:

67890

earnRuleId
integer<int64> | null

Optional: ID of an earn rule to record this transaction under. The number of points always comes from the points field. When adding points, the earn rule must exist in your store, be active and be within its scheduled dates, otherwise the request fails with 400 ("Point Earn Rule not found" or "Point Earn Rule is not active"). If the earn rule requires manual approval, the added points are pending until approved. When removing points, the ID is only stored on the transaction. Example: 10

Example:

10

note
string | null

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"
Maximum string length: 500
Example:

"Compensation for delayed shipping - Order #1234"

Response

Points successfully added to customer account

achievableTierId
integer<int64>
availablePoints
number<double>
createAt
string<date-time>
creditedPoints
number<double>
currentVipTier
string
customerStatus
enum<string>
Available options:
ACTIVE,
INACTIVE,
EXCLUDED,
EXCLUDED_BY_CUSTOMER
dob
string<date>
dobYearProvided
boolean
expiringPointsAmount
number<double>
pendingPoints
number<double>
pointsExpireAt
string<date-time>

The customer's short referral link, on https://referral.appstle.com/ or the merchant's custom referral domain. Its last part is the customer's referral token, which Accept referral offer takes as token. The link redirects to the store's primary domain with appstle_referral=true and appstle_referral_code={token} in the query string.

Example:

"https://referral.appstle.com/abc123def456ghij"

referredCompleted
integer<int64>
rewardedForCreatingAccount
boolean
rewardedForFacebook
boolean
rewardedForInstagram
boolean
rewardedForNewsLetter
boolean
rewardedForPinterest
boolean
rewardedForSharingOnFacebook
boolean
rewardedForSharingOnX
boolean
rewardedForSms
boolean
rewardedForTiktok
boolean
rewardedForTwitter
boolean
rewardedForYoutube
boolean
rewards
object[]
spentAmount
number<double>
storeCreditBalance
number<double>
storeCreditCurrency
string
vipTierExpiredAt
string<date-time>
vipTierOrderCount
integer<int32>
vipTierSpentAmount
number<double>