Add store credits to customer account

POST /api/external/add-credits

Add store credits to customer account

cURL

curl --request POST \
  --url https://loyalty-admin.appstle.com/api/external/add-credits \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "customerId": 123,
  "customerEmail": "<string>",
  "credits": 123,
  "earnRuleId": 123,
  "note": "<string>"
}
'

200

{
  "availablePoints": 123,
  "pendingPoints": 123,
  "creditedPoints": 123,
  "spentAmount": 123,
  "storeCreditBalance": 123,
  "achievableTierId": 123,
  "currentVipTier": "<string>",
  "vipTierExpiredAt": "2023-11-07T05:31:56Z",
  "createAt": "2023-11-07T05:31:56Z",
  "rewardedForFacebook": true,
  "rewardedForPinterest": true,
  "rewardedForTwitter": true,
  "rewardedForInstagram": true,
  "rewardedForYoutube": true,
  "rewardedForTiktok": true,
  "rewardedForNewsLetter": true,
  "rewardedForSms": true,
  "referredCompleted": 123,
  "referralLink": "<string>",
  "dob": "2023-12-25",
  "rewards": [
    {
      "shop": "<string>",
      "customerId": 123,
      "discountCode": "<string>",
      "createAt": "2023-11-07T05:31:56Z",
      "id": 123,
      "description": "<string>",
      "pointTransactionId": 123,
      "pointRedeemRuleId": 123,
      "usedAt": "2023-11-07T05:31:56Z",
      "orderId": 123,
      "orderName": "<string>",
      "expireDate": "2023-11-07T05:31:56Z",
      "variantId": 123,
      "discountCodeId": "<string>",
      "productData": "<string>",
      "usageCount": 123,
      "amount": 123,
      "lastExpiryReminderSentDate": "2023-11-07T05:31:56Z"
    }
  ],
  "rewardedForCreatingAccount": true,
  "rewardedForSharingOnFacebook": true,
  "rewardedForSharingOnX": true,
  "expiringPointsAmount": 123,
  "pointsExpireAt": "2023-11-07T05:31:56Z"
}

Headers

X-API-Key · string · required

API key for authentication

Body

application/json

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

customerId · integer<int64>

customerEmail · string

credits · number<double>

earnRuleId · integer<int64>

note · string

Response

200

application/json

Store credits successfully added to customer account

availablePoints · number<double>

pendingPoints · number<double>

creditedPoints · number<double>

spentAmount · number<double>

storeCreditBalance · number<double>

achievableTierId · integer<int64>

currentVipTier · string

vipTierExpiredAt · string<date-time>

createAt · string<date-time>

rewardedForFacebook · boolean

rewardedForPinterest · boolean

rewardedForTwitter · boolean

rewardedForInstagram · boolean

rewardedForYoutube · boolean

rewardedForTiktok · boolean

rewardedForNewsLetter · boolean

rewardedForSms · boolean

referredCompleted · integer<int64>

referralLink · string

customerStatus · enum<string>

Available options: ACTIVE, INACTIVE, EXCLUDED, EXCLUDED_BY_CUSTOMER

dob · string<date>

rewards · object[]

Show child attributes

rewardedForCreatingAccount · boolean

rewardedForSharingOnFacebook · boolean

rewardedForSharingOnX · boolean

expiringPointsAmount · number<double>

pointsExpireAt · string<date-time>