# Rekaz API

> Reference for the Rekaz Platform API, used by merchant integrations, and the Storefront API, used by custom storefronts and customer accounts. Each link below is one section of the reference in Markdown.

## Platform API

- [Overview](platform/introduction.md): getting started, authentication, conventions, and errors
- [Orders](platform/orders.md): Create orders, manage their items and coupon, record payments, and issue refunds.
- [Merchandise orders](platform/merchandise-orders.md): Orders for physical merchandise, including quotes and merchant-defined custom statuses.
- [Payment requests](platform/payment-requests.md): Request payment from a customer for a set of items.
- [Refunds](platform/refunds.md): Change the method of a refund issued against an order.
- [Credit notes](platform/credit-notes.md): Credit notes issued against order invoices.
- [Coupons](platform/coupons.md): Discount codes and automatic promotions, with their usage history.
- [Gifts](platform/gifts.md): Gifts bought for another person: create, share, resend, and redeem them.
- [Fees](platform/fees.md): Additional fees, as a fixed amount or a percentage, applied under configurable rules.
- [Products](platform/products.md): Everything the business sells, such as bookable services, subscriptions, merchandise, gifts, and bundles, with their prices and stock.
- [Product categories](platform/product-categories.md): Categories that group products.
- [Reservations](platform/reservations.md): Search available slots, preview and book reservations, and manage cancellations and statuses.
- [Attendances](platform/attendances.md): Check customers in and out of their reservations and subscriptions.
- [Providers](platform/providers.md): The providers who deliver services, with their schedules and schedule overrides.
- [Branches](platform/branches.md): The business's locations and the rule that decides whether customers choose one.
- [Holidays](platform/holidays.md): Time off, such as vacations, leave, public holidays, and breaks, for all providers or specific ones.
- [Packages](platform/packages.md): Packages customers hold and use toward covered services: list their usages, and extend, pause, transfer, or cancel them.
- [Subscriptions](platform/subscriptions.md): Recurring memberships: create, pause, resume, or cancel them.
- [Customers](platform/customers.md): The business's customers and their contact details.
- [Customer reviews](platform/customer-reviews.md): Reviews customers left, with replies, website visibility, and rating statistics for the business and its providers.
- [Business profile](platform/business-profile.md): The business's public identity, contact details, currency, and checkout settings.
- [Expenses](platform/expenses.md): Business expenses and their types.
- [Documents](platform/documents.md): Upload files and read their metadata and content.
- [Reports](platform/reports.md): Discover the report catalog, then run or explain a report query.
- [Webhook endpoints](platform/webhook-endpoints.md): HTTPS endpoints that receive event deliveries, with their signing secrets and verification.
- [Event subscriptions](platform/event-subscriptions.md): Subscribe a webhook endpoint to an event family, track its delivery progress, and resume a subscription that became unhealthy.
- [Events](platform/events.md): Read events directly by position, as an alternative to webhook delivery.

## Storefront API

- [Overview](storefront/introduction.md): getting started, authentication, conventions, and errors
- [Authentication](storefront/authentication.md): Send a one-time code to the customer's phone, exchange it for a customer access token, and end the session.
- [Store configuration](storefront/store-configuration.md): The store's branding, localization, enabled features, checkout, payment, and policy settings. Load it before rendering the storefront.
- [Products](storefront/products.md): Browse the published catalog, its categories, and bundle availability.
- [Providers](storefront/providers.md): The providers customers can book.
- [Branches](storefront/branches.md): The locations customers can choose from.
- [Presets](storefront/presets.md): Field sets the store defines for customer details. Customers save their answers under Saved details.
- [Gift themes](storefront/gift-themes.md): Designs a customer can choose when sending a gift.
- [Reviews](storefront/reviews.md): Published customer reviews and the rating summary.
- [Blog](storefront/blog.md): The store's published blog posts.
- [Profile](storefront/profile.md): The signed-in customer's profile, phone number changes, account erasure, wallet pass, and referral code.
- [Carts and checkout](storefront/carts-and-checkout.md): Build a cart, validate it, and check out to place the order.
- [Orders](storefront/orders.md): The customer's orders, merchandise orders, and payment links for unpaid orders.
- [Reservations](storefront/reservations.md): The customer's reservations, and requests to cancel them.
- [Packages](storefront/packages.md): The customer's purchased packages, the prices they cover, and slot search for booking with them.
- [Subscriptions](storefront/subscriptions.md): The customer's subscriptions, and requests to pause or resume them.
- [Gifts](storefront/gifts.md): Gifts the customer sent or received, and gift redemption.
- [Loyalty](storefront/loyalty.md): The customer's loyalty balance, the available rewards, and reward redemption.
- [Saved locations](storefront/saved-locations.md): Places the customer saved, such as home or work, and the saved place closest to a position.
- [Saved details](storefront/saved-details.md): The customer's saved answers to the store's presets.
- [My reviews](storefront/my-reviews.md): Review requests sent to the customer, and the reviews they submit.
- [Uploads](storefront/uploads.md): Files the customer uploads.

## Optional

- [Full reference](llms-full.txt): both APIs in one file