# The import object

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

## Fields

| Field                               | Type      | Description                                                                                                                                                                                         |
| ----------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                            | `string`  | `imports`                                                                                                                                                                                           |
| **id**                              | `string`  | The import unique identifier                                                                                                                                                                        |
| links.**self**                      | `string`  | The import endpoint URL                                                                                                                                                                             |
| attributes.**resource\_type**       | `string`  | The type of resource being imported. One of 'addresses', 'tags', 'price\_lists', 'line\_items', 'orders', 'tax\_categories', 'skus', 'shipping\_categories', 'bundles', 'sku\_lists', ...           |
| attributes.**format**               | `string`  | The format of the import. One of 'csv', or 'json' (default).                                                                                                                                        |
| attributes.**parent\_resource\_id** | `string`  | The ID of the parent resource to be associated with imported data.                                                                                                                                  |
| attributes.**status**               | `string`  | The import job status. One of 'pending' (default), 'in\_progress', 'interrupted', or 'completed'.                                                                                                   |
| attributes.**started\_at**          | `string`  | Time at which the import was started.                                                                                                                                                               |
| attributes.**completed\_at**        | `string`  | Time at which the import was completed.                                                                                                                                                             |
| attributes.**interrupted\_at**      | `string`  | Time at which the import was interrupted.                                                                                                                                                           |
| attributes.**inputs**               | `array`   | Array of objects representing the resources that are being imported.                                                                                                                                |
| attributes.**inputs\_size**         | `integer` | Indicates the size of the objects to be imported.                                                                                                                                                   |
| attributes.**errors\_count**        | `integer` | Indicates the number of import errors, if any.                                                                                                                                                      |
| attributes.**warnings\_count**      | `integer` | Indicates the number of import warnings, if any.                                                                                                                                                    |
| attributes.**processed\_count**     | `integer` | Indicates the number of records that have been processed (created or updated).                                                                                                                      |
| attributes.**errors\_log**          | `object`  | Contains the import errors, if any.                                                                                                                                                                 |
| attributes.**warnings\_log**        | `object`  | Contains the import warnings, if any.                                                                                                                                                               |
| attributes.**skip\_errors**         | `boolean` | Disables the interruption of the import in case its errors exceeds the 10% threshold.                                                                                                               |
| attributes.**attachment\_url**      | `string`  | The URL the the raw inputs file, which will be generated at import start.                                                                                                                           |
| 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/imports/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.