search-loyalty-accounts-response.md

Search Loyalty Accounts Response

A response that includes loyalty accounts that satisfy the search criteria.

Structure

SearchLoyaltyAccountsResponse

Fields

Name	Type	Tags	Description	Getter	Setter
errors	?(Error[])	Optional	Any errors that occurred during the request.	getErrors(): ?array	setErrors(?array errors): void
loyaltyAccounts	?(LoyaltyAccount[])	Optional	The loyalty accounts that met the search criteria, in order of creation date.	getLoyaltyAccounts(): ?array	setLoyaltyAccounts(?array loyaltyAccounts): void
cursor	?string	Optional	The pagination cursor to use in a subsequent request. If empty, this is the final response. For more information, see Pagination.	getCursor(): ?string	setCursor(?string cursor): void

Example (as JSON)

{
  "loyalty_accounts": [
    {
      "balance": 10,
      "created_at": "2020-05-08T21:44:32Z",
      "customer_id": "Q8002FAM9V1EZ0ADB2T5609X6NET1H0",
      "id": "79b807d2-d786-46a9-933b-918028d7a8c5",
      "lifetime_points": 20,
      "mapping": {
        "created_at": "2020-05-08T21:44:32Z",
        "id": "66aaab3f-da99-49ed-8b19-b87f851c844f",
        "phone_number": "+14155551234"
      },
      "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
      "updated_at": "2020-05-08T21:44:32Z",
      "enrolled_at": "enrolled_at4"
    }
  ],
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ],
  "cursor": "cursor8"
}