> ## Documentation Index
> Fetch the complete documentation index at: https://quickbutik.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get preorder options

> Retrieve all preorder options configured for the store. These options can be assigned to products and variants to indicate pre-order availability and estimated delivery windows.

**Required scope:** `products:read` or `read_only`

**Note:** This endpoint is not available to storefront-only API keys.




## OpenAPI

````yaml /openapi.yaml get /v1/settings/preorders
openapi: 3.1.0
info:
  title: Quickbutik API
  version: 1.0.0
  description: >-
    Use the Quickbutik API to access and manage stores, products, orders, and
    more.
  contact:
    name: Quickbutik API Support
    url: https://quickbutik.com/support
  license:
    name: Proprietary
  x-fiddle-import-file: true
servers:
  - url: https://api.quickbutik.com
    description: Production server
security:
  - BasicAuth: []
tags:
  - name: Orders
    description: Order management operations
  - name: Products
    description: Product catalog management
  - name: Categories
    description: Product category management
  - name: Payment Methods
    description: Available payment methods
  - name: Shipping Methods
    description: Available shipping methods
  - name: Metadata
    description: Custom metadata management
  - name: Settings
    description: Store settings and configuration
  - name: Scripts
    description: Storefront script management
paths:
  /v1/settings/preorders:
    get:
      tags:
        - Settings
      summary: Get preorder options
      description: >
        Retrieve all preorder options configured for the store. These options
        can be assigned to products and variants to indicate pre-order
        availability and estimated delivery windows.


        **Required scope:** `products:read` or `read_only`


        **Note:** This endpoint is not available to storefront-only API keys.
      operationId: get-preorders
      responses:
        '200':
          $ref: '#/components/responses/PreordersSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    PreordersSuccess:
      description: Preorder options retrieved successfully
      content:
        application/json:
          schema:
            type: object
            properties:
              preorders:
                type: array
                items:
                  $ref: '#/components/schemas/PreorderOption'
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden - Insufficient permissions or scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    PreorderOption:
      type: object
      description: >-
        A preorder option configured for the store. Preorder options can be
        assigned to products and variants to indicate pre-order availability.
      properties:
        id:
          type: integer
          example: 1
          description: Unique identifier for the preorder option
        text:
          type: string
          example: Pre-order — ships in 2–3 weeks
          description: Display text shown to customers for this preorder option
        delivery_from:
          type:
            - string
            - 'null'
          example: '2025-03-01'
          description: Earliest estimated delivery date (free-form string, often a date)
        delivery_to:
          type:
            - string
            - 'null'
          example: '2025-03-15'
          description: Latest estimated delivery date (free-form string, often a date)
    Error:
      type: object
      properties:
        code:
          type: integer
          example: 404
        error:
          type: string
          example: Resource not found
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >
        **Basic Authentication with API Keys**


        The Quickbutik API uses Basic Authentication where you use your API key
        as both the username and password.


        **How it works:**

        1. Format your credentials as `api_key:api_key` (using the SAME API key
        for both username and password)

        2. Base64 encode the formatted string

        3. Include in the Authorization header as: `Authorization: Basic
        ENCODED_STRING`


        **Example:**

        - API Key: `sk_live_abc123`

        - Formatted: `sk_live_abc123:sk_live_abc123`

        - Base64 Encoded: `c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM=`

        - Header: `Authorization: Basic
        c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM=`


        **cURL Example:**

        ```bash

        curl https://api.quickbutik.com/v1/orders -u your_api_key:your_api_key

        ```


        All API requests must be made over HTTPS. Requests made over HTTP will
        be rejected.


        API keys can be generated in the Quickbutik Control Panel under Settings
        → API.

````