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

# Export catalog

> Export the live product catalog as a portable snapshot (the same artifact the app exports), usable for backups or imports into another organisation.



## OpenAPI

````yaml get /v1/catalog/export
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/catalog/export:
    get:
      tags:
        - Catalog
      summary: Export catalog
      description: >-
        Export the live product catalog as a portable snapshot (the same
        artifact the app exports), usable for backups or imports into another
        organisation.
      operationId: exportCatalog
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogSnapshot'
        '403':
          description: Catalog versioning not enabled.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    CatalogSnapshot:
      type: object
      properties:
        format:
          type: string
          enum:
            - hyperline.product_catalog.v2
          description: Portable catalog snapshot format identifier.
          example: hyperline.product_catalog.v2
        sourceClientId:
          type: string
          description: ID of the organisation that exported the snapshot.
          example: cli_DKL4Xcb5VSa8CQ
        exportedAt:
          type: string
          description: >-
            Date when the snapshot was exported. UTC date time string in the
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          example: '2026-06-17T12:30:00Z'
        checksum:
          type: string
          description: Checksum of the snapshot payload, when available.
          example: sha256:6b1f9f4c5b8a4c7e
        trackedEntityTypes:
          type: array
          items:
            type: string
            enum:
              - aggregator
              - aggregator_filter
              - bundle_item
              - customer_segment
              - price
              - price_book
              - price_configuration
              - product
              - product_accounting
              - product_provider
          description: Entity types for which the snapshot is authoritative during import.
          example:
            - product
            - price_configuration
            - price
        resources:
          type: array
          items:
            $ref: '#/components/schemas/CatalogSnapshotResource'
          description: Catalog resources included in the snapshot.
      required:
        - format
        - sourceClientId
        - exportedAt
        - resources
      additionalProperties: {}
    CatalogSnapshotResource:
      type: object
      properties:
        entityType:
          type: string
          enum:
            - aggregator
            - aggregator_filter
            - bundle_item
            - customer_segment
            - price
            - price_book
            - price_configuration
            - product
            - product_accounting
            - product_provider
          description: Type of catalog entity represented by the resource.
          example: product
        id:
          type: string
          description: Original ID of the resource in the source organisation.
          example: itm_3kXODDF42QXtnL
        configKey:
          type: string
          description: >-
            Stable configuration key used to match the resource across
            organisations.
          example: product:enterprise-plan
        data:
          type: object
          additionalProperties: {}
          description: >-
            Serialized resource payload. The shape depends on the resource
            entity type.
          example:
            name: Enterprise plan
            type: flat_fee
        refs:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
          description: >-
            References from this resource to other catalog resources, keyed by
            reference name.
          example:
            productId: product:enterprise-plan
      required:
        - entityType
        - id
        - configKey
        - data
      additionalProperties: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````