Export Format Config

The export format configuration determines the structure, encoding, and field selection of mapping result files delivered to your organization. Each organization has a single active configuration. Create or replace it with the PUT endpoint, and retrieve it with GET.

Both endpoints require authentication. Include your API key in the X-API-Key header.

PUT /api/v1/export-format

Create or replace your organization’s export format configuration. If no configuration exists, one is created. If one already exists, it is fully replaced by the new values.

PUT https://api.mapping.travel/api/v1/export-format
Content-Type: application/json

Request body

string

required

Output file format. Accepted values: json, csv, jsonl.

string[]

List of fields to include in the export. When omitted, all fields are included by default.

string

default:","

Column delimiter for CSV exports. Ignored for JSON and JSONL formats.

boolean

default:"true"

Whether to include a header row in CSV exports.

string

Optional compression for the export file. Accepted values: gzip, none. Defaults to none.

Response

Returns the saved configuration.

string

required

UUID of the format configuration.

string

required

The configured output format.

string[]

Fields included in the export.

string

CSV delimiter character.

boolean

Whether CSV exports include a header row.

string

Compression applied to the export file.

string

required

ISO 8601 timestamp of the last update.

Example

curl -X PUT https://api.mapping.travel/api/v1/export-format \
  -H "X-API-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "jsonl",
    "compression": "gzip",
    "includeFields": ["referenceId", "supplierId", "supplierHotelId", "confidence"]
  }'

{
  "id": "fmt-2c3d4e5f-0000-0000-0000-000000000001",
  "format": "jsonl",
  "includeFields": ["referenceId", "supplierId", "supplierHotelId", "confidence"],
  "compression": "gzip",
  "updatedAt": "2026-04-25T12:00:00Z"
}

GET /api/v1/export-format

Retrieve your organization’s current export format configuration.

GET https://api.mapping.travel/api/v1/export-format

Response

Returns the current format configuration object if one has been set.

string

required

UUID of the format configuration.

string

required

Output file format (json, csv, or jsonl).

string[]

Fields included in the export, if configured.

string

CSV column delimiter.

boolean

Whether CSV exports include a header row.

string

Compression type applied to export files.

string

required

ISO 8601 timestamp of the last configuration update.

Errors

Status	Description
`404 Not Found`	No export format configuration has been set for your organization. Use the PUT endpoint to create one.

Example

curl https://api.mapping.travel/api/v1/export-format \
  -H "X-API-Key: <token>"

Inventory

Mapping

Reference Hotels

Suppliers

Webhooks

Export

PUT /api/v1/export-format

Request body

Response

Example

GET /api/v1/export-format

Response

Errors

Example

​PUT /api/v1/export-format

​Request body

​Response

​Example

​GET /api/v1/export-format

​Response

​Errors

​Example

PUT /api/v1/export-format

Request body

Response

Example

GET /api/v1/export-format

Response

Errors

Example