Activity Object

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "activity_type": "purchase",
  "source_type": "loyalty_campaigns",
  "source_id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
  "entry_type": "credit",
  "points": 100,
  "earning_type": "points",
  "metadata": {
    "earning_value": 100
  },
  "created_at": "2026-03-09T14:02:06+00:00"
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "activity_type": "purchase",
  "source_type": "loyalty_campaigns",
  "source_id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
  "entry_type": "credit",
  "points": 100,
  "earning_type": "points",
  "metadata": {
    "earning_value": 100
  },
  "created_at": "2026-03-09T14:02:06+00:00"
}

An activity is an entry in a customer’s loyalty activity log: points earned for an order, a reward redemption, a manual points adjustment, a VIP tier change, and so on. Activities are returned by List customer activities (GET /public/customers/activities, requires the read:activities scope).

Properties

string<uuid>

Unique identifier for the activity.

string<uuid>

Yuko’s internal UUID for the customer the activity belongs to. This is not the Shopify customer ID you pass as the customer_id query parameter.

string

The kind of activity, for example purchase, point_adjustment or vip_tier_upgrade. You can filter by this value with the activity_type query parameter.

string

What produced the activity, for example loyalty_campaigns (an earn rule), loyalty_tiers (a VIP tier change) or users (a manual adjustment). You can filter by this value with the source_type query parameter.

string<uuid> | null

The UUID of the record that produced the activity, such as the earn rule or reward.

string | null

credit when points were added, debit when points were removed, or null when the activity didn’t change the points balance.

integer

The number of points earned or used in this activity, taken from metadata.earning_value (or metadata.used_point for redemptions). 0 when no points were involved.

string | null

How the activity rewarded the customer (for example points), when applicable.

object

The full activity payload. Its structure depends on activity_type, and it’s an empty array ([]) when the activity has no payload. For VIP tier changes, see VIP Tier Change Object.

string<date-time>

The date and time when the activity was recorded (ISO 8601).

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "activity_type": "purchase",
  "source_type": "loyalty_campaigns",
  "source_id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
  "entry_type": "credit",
  "points": 100,
  "earning_type": "points",
  "metadata": {
    "earning_value": 100
  },
  "created_at": "2026-03-09T14:02:06+00:00"
}

Rest API

API References

Object Reference

Properties

​Properties

Properties