> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Restore a saved entity to checkout

> Adds a previously selected entity back into the Redis-backed public checkout cart from query/body parameters. The endpoint validates the required ids, amount, frequency, and sponsorship amount, creates a replacement frontend session when the supplied one is expired, and stores the entity amount and default frequency in Redis. Public checkout uses this legacy route when restoring cart state.



## OpenAPI

````yaml get /frontend/save_entity
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /frontend/save_entity:
    get:
      tags:
        - Public
      summary: Restore a saved entity to checkout
      description: >-
        Adds a previously selected entity back into the Redis-backed public
        checkout cart from query/body parameters. The endpoint validates the
        required ids, amount, frequency, and sponsorship amount, creates a
        replacement frontend session when the supplied one is expired, and
        stores the entity amount and default frequency in Redis. Public checkout
        uses this legacy route when restoring cart state.
      operationId: getSaveEntity
      parameters:
        - name: client_id
          in: query
          description: >-
            Client id that owns the checkout session and entity. Validator rule:
            `required`.
          required: true
          schema:
            type: integer
          example: 207
        - name: program_id
          in: query
          description: 'Program id for the selected entity. Validator rule: `required`.'
          required: true
          schema:
            type: integer
          example: 11
        - name: entity_id
          in: query
          description: >-
            Entity id to add back to `saved_entity_id` in Redis. Validator rule:
            `required`.
          required: true
          schema:
            type: integer
          example: 4711
        - name: session_id
          in: query
          description: >-
            Redis frontend session id for the checkout cart. Validator rule:
            `required`; a replacement session is created if it is expired.
          required: true
          schema:
            type: string
          example: 7f2c8f8d64b8a1d4a9e2
        - name: amount
          in: query
          description: >-
            Raw amount entered by the donor. Validator rule: `required`; the
            controller trims and strips non-numeric characters before storing it
            as `sponsorship_amount`.
          required: true
          schema:
            type: string
          example: $35.00
        - name: frequency
          in: query
          description: >-
            Frequency value carried by the legacy route. Validator rule:
            `required`; used for the saved entity frequency and amount-policy
            selection.
          required: true
          schema:
            type: integer
          example: 1
        - name: sponsorship_amount
          in: query
          description: >-
            Sponsorship amount to store in Redis when `amount` is empty.
            Validator rule: `required`.
          required: true
          schema:
            type: string
          example: '35.00'
      responses:
        '200':
          description: Entity was restored to the checkout cart.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: >-
                      <strong>Jane Student</strong> has been added back to your
                      order!
                type: object
        '404':
          description: >-
            The client-owned recipient is unavailable or outside the allowed
            program scope.
        '422':
          description: Required query parameters were missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      security: []
components:
  schemas:
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.