get-loyalty-details

Method: GET
Path: /customers/{user_id}/loyalty

Tags: Customers

Summary

Retrieve loyalty details

Description

Retrieve loyalty details

Storefront SDK Usage

SDK Method: sdk.customer.getLoyaltyDetails()

Example:

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

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

console.log("Loyalty info:", data.loyalty);
console.log("Points balance:", data.loyalty_point_balance);

TypeScript Definition

"get-loyalty-details": {
        parameters: {
            query?: never;
            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?: components["schemas"]["CustomerLoyalty"];
                            loyalty_point_balance?: number;
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["CustomerLoyalty"]	CustomerLoyalty
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• 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": "get-loyalty-details",
  "summary": "Retrieve loyalty details",
  "description": "Retrieve loyalty details",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/get-loyalty-details",
    "description": "API reference for the get-loyalty-details operation"
  },
  "parameters": [
    {
      "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": {
                    "$ref": "#/components/schemas/CustomerLoyalty"
                  },
                  "loyalty_point_balance": {
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "customers",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "getLoyaltyDetails"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions