list-loyalty-activities

Method: GET
Path: /customers/{user_id}/loyalty-points-activity

Tags: Customers

Summary

List all loyalty points activity

Description

List all loyalty points activity

Storefront SDK Usage

SDK Method: sdk.customer.listLoyaltyPointsActivity()

Example:

const { data, error } = await sdk.customer.listLoyaltyPointsActivity({
  user_id: "user_456"
});

if (error) {
  console.error("Failed to get loyalty activity:", error);
  return;
}

console.log("Loyalty activity:", data.loyalty_points_activity);

// With pagination and sorting
const { data: sortedData, error: sortedError } = await sdk.customer.listLoyaltyPointsActivity({
  user_id: "user_456",
  page: 1,
  limit: 20,
  sort_by: JSON.stringify({ "created_at": "desc" })
});

TypeScript Definition

"list-loyalty-activities": {
        parameters: {
            query?: {
                /** @description no of rows per page */
                limit?: components["parameters"]["pageLimitParam"];
                /** @description page number of pagination list */
                page?: components["parameters"]["pageParam"];
                /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                sort_by?: components["parameters"]["sortingParam"];
            };
            header?: never;
            path: {
                /** @description user id */
                user_id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            loyalty_points_activity?: components["schemas"]["LoyaltyPointActivity"][];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["parameters"]["pageLimitParam"]	pageLimitParam
components["parameters"]["pageParam"]	pageParam
components["parameters"]["sortingParam"]	sortingParam
components["schemas"]["LoyaltyPointActivity"]	LoyaltyPointActivity
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• limit (query): no of rows per page
• page (query): page number of pagination list
• sort_by (query): JSON string format: {"field1":"asc", "field2":"desc"}
• user_id (path): user id

Responses

200

OK

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Customers"
  ],
  "operationId": "list-loyalty-activities",
  "summary": "List all loyalty points activity",
  "description": "List all loyalty points activity",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-loyalty-activities",
    "description": "API reference for the list-loyalty-activities operation"
  },
  "parameters": [
    {
      "$ref": "#/components/parameters/pageLimitParam"
    },
    {
      "$ref": "#/components/parameters/pageParam"
    },
    {
      "$ref": "#/components/parameters/sortingParam"
    },
    {
      "name": "user_id",
      "in": "path",
      "description": "user id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "loyalty_points_activity": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/LoyaltyPointActivity"
                    }
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "customers",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listLoyaltyActivities"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions