# The export object

An export object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/exports` endpoint.

## Fields

| Field                                    | Type      | Description                                                                                                                                                                                         |
| ---------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                 | `string`  | `exports`                                                                                                                                                                                           |
| **id**                                   | `string`  | The export unique identifier                                                                                                                                                                        |
| links.**self**                           | `string`  | The export endpoint URL                                                                                                                                                                             |
| attributes.**resource\_type**            | `string`  | The type of resource being exported. One of 'applications', 'event\_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price\_lists', 'payment\_gateways', ...   |
| attributes.**format**                    | `string`  | The format of the export. One of 'csv', or 'json' (default).                                                                                                                                        |
| attributes.**status**                    | `string`  | The export job status. One of 'pending' (default), 'in\_progress', 'interrupted', 'completed', or 'failed'.                                                                                         |
| attributes.**includes**                  | `array`   | List of related resources that should be included in the export (redundant when 'fields' are specified).                                                                                            |
| attributes.**fields**                    | `array`   | List of fields to export for the main and related resources (automatically included). Pass the asterisk '\*' to include all exportable fields for the main and related resources.                   |
| attributes.**filters**                   | `object`  | The filters used to select the records to be exported.                                                                                                                                              |
| attributes.**dry\_data**                 | `boolean` | Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.                          |
| attributes.**jwt\_filters**              | `boolean` | Send this attribute to apply JWT scope–based sales channel filtering to the exported data.                                                                                                          |
| attributes.**started\_at**               | `string`  | Time at which the export was started.                                                                                                                                                               |
| attributes.**completed\_at**             | `string`  | Time at which the export was completed.                                                                                                                                                             |
| attributes.**estimated\_completion\_at** | `string`  | Estimated time at which the export should complete (dynamically refres^hed).                                                                                                                        |
| attributes.**interrupted\_at**           | `string`  | Time at which the export was interrupted.                                                                                                                                                           |
| attributes.**records\_count**            | `integer` | Indicates the number of records to be exported.                                                                                                                                                     |
| attributes.**processed\_count**          | `integer` | Indicates how many records have been processed in real time.                                                                                                                                        |
| attributes.**progress**                  | `float`   | The percentage of progress of the export.                                                                                                                                                           |
| attributes.**attachment\_url**           | `string`  | The URL to the output file, which will be generated upon export completion.                                                                                                                         |
| attributes.**errors\_log**               | `object`  | Contains the exports errors, if any.                                                                                                                                                                |
| attributes.**\_start**                   | `boolean` | Send this attribute if you want to restart an 'interrupted' export.                                                                                                                                 |
| attributes.**\_interrupt**               | `boolean` | Send this attribute if you want to mark status as 'interrupted'.                                                                                                                                    |
| attributes.**created\_at**               | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**               | `string`  | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**                 | `string`  | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**         | `string`  | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                  | `object`  | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**events**                 | `array`   | The associated events.                                                                                                                                                                              |
| relationships.**event\_stores**          | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                            | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/exports/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.