Skip to content

CustomerClientCards

Customer client cards represent loyalty cards, membership cards, or gift cards associated with customer clients.

Storage Location

{customer_id}-customer_client_card.json

Note: This file may not exist for all customers. Only present when the customer uses loyalty/gift card features.

Fields

FieldTypeRequiredDescription
idstringYesUnique card identifier.
guidguidYesCard GUID.
customer_idintegerYesReference to Customer.
customer_client_guidguidNoReference to CustomerClient owner (null for anonymous cards).
card_numstringYesCard number.
typestringYesCard type: deposit, membership, discount, prepaid.
namestringNov1.1. Card holder name.
createddatetimeYesCard creation date.
expirationdatetimeNoCard expiration date.
statusstringYesStatus: active, inactive, deleted.
remarksstringNov1.1. Notes/remarks on the card.
card_type_namestringNov1.1. Name of the card type configuration.
card_definition_namestringNov1.1. Name of the card definition.

Card Types

TypeDescription
depositPrepaid deposit/gift card with monetary balance
membershipMembership/subscription card
discountDiscount card
prepaidPrepaid card

Example

json
{
  "id": "200130066",
  "guid": "484aa1c9-9840-2a33-e063-0a01000a5f65",
  "customer_id": 200013285,
  "card_num": "04049E62033E81",
  "type": "deposit",
  "created": "2025-04-24T00:00:00",
  "expiration": "2026-05-24T00:00:00",
  "status": "active",
  "remarks": "Imported from legacy system"
}

Technical documentation for partners and integrators