> ## Documentation Index > Fetch the complete documentation index at: https://docs.anny.co/llms.txt > Use this file to discover all available pages before exploring further. # Get dynamic checkout form for order checkout > Returns dynamic checkout field definitions and validation metadata. Supports prefill via remember customer token (`rct`). ## OpenAPI ````yaml /developers/openapi/customer-internal.openapi.json get /api/ui/checkout-form openapi: 3.1.0 info: title: customer-api version: '1.0' contact: name: anny GmbH url: anny.co email: support@anny.co description: >- The Customer API is the **public booking surface** for end-user facing applications. It covers everything a customer can see and do — searching availability, placing bookings, managing their account, and more. --- ## When to use the Customer API Use the Customer API when you are **building something your customers interact with directly**: - **Custom booking flow** — embed a fully branded booking experience inside your own app or website instead of redirecting to anny - **Headless checkout** — drive the cart, checkout, and payment steps entirely from your own frontend - **Custom confirmation pages** — retrieve booking and order details after checkout to render a tailored confirmation - **Opening hours and availability on public pages** — display live schedule data on your website with no authentication required - **White-label experiences** — build lobby screens, kiosks, or mobile apps on top of the Customer API Many endpoints work **without any authentication**. For a custom OAuth2 client to authenticate your own users, contact [support@anny.co](mailto:support@anny.co) with your use case. --- ## Authentication — Optional Auth Most Customer API endpoints work without a token. Providing a customer bearer token unlocks personal data and additional actions: | Auth state | What's accessible | |---|---| | Anonymous | Availability, public resource/service info, booking lookup by number, checkout | | Customer token | Own bookings, account data, communities, passes, queue tickets | ``` Authorization: Bearer {customer_access_token} ``` To authenticate your own users, you need a custom OAuth2 client — contact [support@anny.co](mailto:support@anny.co). See the [Authentication guide](/developers/guides/authentication) for the full token flow. --- ## Customer API vs Admin API | Feature | Customer API | Admin API | |---|---|---| | **Use case** | End-user apps, booking widgets | Server-side automation, backend tooling | | **Auth** | Optional — many endpoints work without a token | Required — API token or OAuth2 | | **Identifiers** | Slugs, booking numbers, order numbers | Immutable UUIDs and integer IDs | | **Access** | Public and customer-owned data only | Full read/write | → [Go to the Admin API](/developers/api-reference/admin) --- ## Resource Identifiers The Customer API uses **human-readable identifiers** that appear in booking URLs: | Entity | Identifier | Example | |---|---|---| | Resources | Slug | `conference-room-berlin` | | Services | Slug | `hourly-desk-booking` | | Organizations | Slug | `acme-gmbh` | | Bookings | Booking number | `BB123456789` | | Orders | Order number | `BO123456789` | Use the Admin API if you need immutable internal IDs for storage in external systems. --- ## Starting Points | Guide | What it covers | |---|---| | [Getting Started](/developers) | First steps and quickstart | | [JSON:API Conventions](/developers/guides/json-api-conventions) | Request and response format | | [Authentication](/developers/guides/authentication) | Customer token flow, OAuth2, anonymous access | | [Availability & Booking Search](/developers/guides/availability) | Search open slots, filter by service and resource | | [Customer Booking Lifecycle](/developers/guides/customer/booking-lifecycle) | View, modify, and cancel bookings | | [Order & Checkout Flow](/developers/guides/customer/checkout) | Cart, checkout steps, payment | | [Plans & Subscriptions](/developers/guides/customer/plans-subscriptions) | Membership plans and recurring billing | | [Communities & Access Control](/developers/guides/customer/communities) | Community membership and access gates | | [Waitlist](/developers/guides/customer/waitlist) | Join and manage waitlists | --- ## Base URLs | Environment | URL | |---|---| | Production | `https://b.anny.co` | | Gov-Cloud | `https://b.anny.eu` | termsOfService: https://anny.co/terms-of-use x-logo: url: https://cdn.anny.co/cms/anny_logo_main_colour_blue_4865e76654.svg altText: anny logo href: https://anny.co servers: - url: https://b.anny.co description: Production - url: https://b.anny.eu description: Gov-Cloud security: [] tags: - name: Addresses - name: Business Accounts - name: Access Control - name: Connections - name: Notifications - name: Payment Setups paths: /api/ui/checkout-form: get: tags: - Internal UI summary: Get dynamic checkout form for order checkout description: >- Returns dynamic checkout field definitions and validation metadata. Supports prefill via remember customer token (`rct`). operationId: ui-checkout-form parameters: - name: oid in: query required: false description: Order id. Required unless `bookings[]` is provided. schema: type: integer - name: oat in: query required: false description: Order access token. Required unless `bookings[]` is provided. schema: type: string - name: bookings[] in: query required: false description: Reserved booking ids to build a checkout form without `oid/oat`. schema: type: array items: type: integer style: form explode: true - name: rct in: query required: false description: Remember customer token used to prefill returned form values. schema: type: string responses: '200': description: Dynamic checkout form payload content: application/json: schema: type: object properties: sections: type: array items: type: object values: type: object meta: type: object examples: default: value: sections: - id: customer title: Customer fields: - id: email type: email label: Email required: true - id: first_name type: text label: First name required: true - id: legal title: Legal fields: - id: legal_document_acceptances type: checkbox-group label: Agreements required: true values: email: jane@example.com first_name: Jane meta: order_id: 12345 payment_methods: - slug: card label: Credit card '404': description: No eligible bookings/order found '422': description: Validation error for missing or invalid query parameters ````