Data sync and exports

Overview

Not every integration should read individual records one request at a time. Formuley exposes three different patterns for moving larger datasets:

• bulk operations for multi-record actions
• raw data endpoints for paginated extraction
• export jobs for asynchronous file generation

Choose the pattern that matches the job.

These three surfaces do not share the same plan boundary:

• bulk operations require Lab or Enterprise
• raw data endpoints require Lab or Enterprise
• export jobs require Enterprise

Use bulk operations when you are changing many records

Bulk endpoints live under /api/v1/bulk/....

Current bulk families documented in the product include:

• formula archive and activation jobs
• ingredient updates
• compliance checks
• bulk job status polling at /api/v1/bulk/jobs/[id]

Use bulk operations when the system needs to perform write-heavy changes across many records.

Lab includes the basic bulk API with lower per-request limits. Enterprise includes the full bulk API.

Use raw data when you need structured paginated reads

The raw data surface lives at /api/v1/data/[type].

Current supported raw data types are:

• formulas
• ingredients
• batches
• orders
• compliance
• cost_history
• inventory

Use it when you need:

• warehouse ingestion
• BI tooling
• scheduled snapshots into your own system
• downstream syncs that should stay structured instead of file-based

This is the better choice when you want application-friendly pagination and filtering.

Use exports when you need asynchronous files

The exports surface lives at:

• /api/v1/exports
• /api/v1/exports/[id]

Use exports when you need file-oriented delivery, background processing, or a large payload that should complete asynchronously.

The export API supports job creation, status polling, and file metadata. The request model also allows a public HTTPS webhook callback URL when your workflow needs completion notification.

Export jobs are an Enterprise capability.

How to choose

• Choose bulk operations when the job changes many records.
• Choose raw data when you need structured, paginated reads and your plan includes the raw data API.
• Choose exports when a background file job is easier to integrate than a stream of API calls and your plan includes export jobs.

Expected result

After this guide, you should know which surface to use for:

• migrations
• BI and warehousing
• scheduled sync pipelines
• large export jobs

Next docs

• API overview
• Webhooks