v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Catalog

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.

get/v1/catalog/export

Response

format'hyperline.product_catalog.v2' required

Portable catalog snapshot format identifier.

sourceClientIdstring required

ID of the organisation that exported the snapshot.

exportedAtstring required

Date when the snapshot was exported. UTC date time string in the ISO 8601 format.

checksumstring

Checksum of the snapshot payload, when available.

trackedEntityTypesstring[]

Entity types for which the snapshot is authoritative during import.

Example response

{
  "format": "hyperline.product_catalog.v2",
  "sourceClientId": "cli_DKL4Xcb5VSa8CQ",
  "exportedAt": "2026-06-17T12:30:00Z",
  "checksum": "sha256:6b1f9f4c5b8a4c7e",
  "trackedEntityTypes": [
    "product",
    "price_configuration",
    "price"
  ],
  "resources": [
    {
      "entityType": "product",
      "id": "itm_3kXODDF42QXtnL",
      "configKey": "product:enterprise-plan",
      "data": {
        "name": "Enterprise plan",
        "type": "flat_fee"
      },
      "refs": {
        "productId": "product:enterprise-plan"
      }
    }
  ]
}