Exporting records
You can export price records scoped a few ways:- A whole batch — every record in a given price batch.
- Specific records — a chosen set of record keys.
- By product — all records for one or more products, optionally narrowed by a temporal filter (current price, next upcoming price, or a date range).
Exporting a batch also records the export on the batch — an export-history entry,
an entry in the batch’s activity history, and the export timestamp and format —
so there is an audit trail of what left the system and when. Recording an export
is lifecycle-neutral: the batch’s status does not change, so an approved batch
stays approved and still publishes on its effective date. See
Price batches.
Available fields
Fields fall into three groups you can mix freely:
Retrieve the full, current list of exportable fields from the export-fields
endpoint rather than hard-coding it.
Export templates
An export template saves a column mapping and format configuration so you don’t rebuild it each time. Templates are managed with standard create, read, update, and delete operations, and can be filtered by format. Reuse a template whenever you run the same kind of export — for example, a recurring feed with a fixed column layout.Formats
Exports produce a spreadsheet (Excel) or CSV. Beyond a generic Excel export, format presets exist that shape the file for specific downstream systems. When your goal is to push prices into an external commerce platform, prefer publishing over a manual export — publishing is batched, scheduled, and audited per target. The format recorded against a batch is a fixed set of values —oracle, vtex,
and generic_excel — and anything else is rejected. If you record an export on a
batch through the API, send one of those three; the API reference lists them on
the request schema. Exporting records from the pricing pages does not ask
you to choose: it always builds an Excel workbook and records it as
generic_excel.
Publishing overview
Deliver prices to external systems, batched and audited.
Price batches
The unit most exports are scoped to.