---
title: "Export catalog"
method: GET
path: "/v1/catalog/export"
tags: ["Catalog"]
---

# Export catalog

`GET /v1/catalog/export`

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

## Response `200`

- CatalogSnapshot
  - `format` 'hyperline.product_catalog.v2', required — Portable catalog snapshot format identifier.
  - `sourceClientId` string, required — ID of the organisation that exported the snapshot.
  - `exportedAt` string, required — Date when the snapshot was exported. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
  - `checksum` string — Checksum of the snapshot payload, when available.
  - `trackedEntityTypes` string[] — Entity types for which the snapshot is authoritative during import.
  - `resources` CatalogSnapshotResource[], required — Catalog resources included in the snapshot.
    - `entityType` 'aggregator' | 'aggregator_filter' | 'bundle_item' | 'customer_segment' | 'price' | 'price_book' | 'price_configuration' | 'product' | 'product_accounting' | 'product_provider', required — Type of catalog entity represented by the resource.
    - `id` string, required — Original ID of the resource in the source organisation.
    - `configKey` string, required — Stable configuration key used to match the resource across organisations.
    - `data` object, required — Serialized resource payload. The shape depends on the resource entity type.
    - `refs` object — References from this resource to other catalog resources, keyed by reference name.

## Other responses

- `403` — Catalog versioning not enabled.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)