> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Import

## Methods

* [import.search](#import-search)
* [import.info](#import-info)
* [import.create](#import-create)

***

## Entity Properties

* [Import Options](#import-options-properties)
* [Import](#import-properties)

***

## `import.search`

`import.search(null|object $filters, array $options = [])`

Retrieve list of imports. Filtration could be applied.

### Parameters

**filters** `null | object`

* `null` - Retrieve list of all imports.
* `object` - Retrieve list of imports using specified [Search Filters](https://docs.shipstream.io/merchant-api/search-filters.md).

**options** `array`

* `null` - No options will be applied.
* `object` - Apply specified [Search Options](https://docs.shipstream.io/merchant-api/search-options.md).

### Return Value

An array of objects. Each object will contain [Import Properties](#import-properties).

### Example Request

Get import details for one import id:

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "import.search",
        [
            {
                "task_id" : {
                    "eq" : 1
                }
            },
            []
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "task_id" : 1,
            "status" : "complete",
            "progress" : 100,
            "num_records" : 6,
            "num_parse_success" : 6,
            "num_parse_failures" : 0,
            "num_submit_success" : 1,
            "num_submit_failures" : 5
        }
    ]
}
```

### Error Codes

| code | message |
| - | - |
| 101 | Invalid filters given. Details in error message. |

***

## `import.info`

`import.info (string $taskId, null|object $fields = [])`

Retrieve full order information.

### Parameters

**taskId** `string`

Import unique ID.

**fields** `null | object`

* `null` - Retrieve basic import properties.
* `array` - Defined list of properties to retrieve. "records" will add records information which is excluded by default.

### Return Value

Object which contains the specified (or default if no fields parameter was given) [Import Properties](#import-properties).

### Example Request

Get order information for the specified order:

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "import.info",
        [
            3,
            [
                "records"
            ]
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "task_id" : 1,
        "status" : "complete",
        "progress" : 100,
        "num_records" : 6,
        "num_parse_success" : 6,
        "num_parse_failures" : 0,
        "num_submit_success" : 1,
        "num_submit_failures" : 5,
        "records" : [
            {
                "entity_id" : "10000045",
                "parse_status" : "valid",
                "submit_status" : "complete"
            }
        ]
    }
}
```

### Error Codes

| code | message |
| - | - |
| 100 | Requested import does not exist. |

***

## `import.create`

`import.create (string $data, string $entityType, null|object $options)`

Import data.

### Parameters

**data** `string`

base64 encoded string.

**entityType** `string`

Entity type. Allowed: "product", "order", "delivery", "bom".

**options** `null | object`

Apply specified [Import Options](#import-options-properties).

### Return Value

The internal import id.

### Example Request

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "import.create",
        [
            "base64 encoded data",
            "order",
            {
                "handle_duplicates" : "drop",
                "send_email_on_complete" : 1,
                "email" : "email@example.com",
                "hold_orders" : "hold"
            }
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : 7
}
```

### Error Codes

| code | message |
| - | - |
| 101 | Invalid filters given. Details in error message. |
| 103 | Invalid file type given. |
| 104 | Invalid file data given. |
| 105 | Internal error occurred. |
| 106 | Internal error occurred while converting the import file to CSV format. |
| 107 | Internal error occurred while scheduling import job. |

## Entity Properties

### Import Options Properties

**Import Options Properties**

**handle\_duplicates** `string`

Handle duplicates. Allowed: "create", "drop", "break".

**send\_email\_on\_complete** `integer`

Flag whether send email on task complete.

**email** `string`

Email address to send email after task complete. The email will only be sent if "send\_email\_on\_complete" flag is set to 1.

**hold\_orders** `string`

Order status. Allowed: "hold".

### Import Properties

**Import Properties**

**task\_id** `integer`

The internal import ID.

**status** `string`

Status. Allowed: "pending", "running", "complete".

**progress** `integer`

Progress percent.

**num\_records** `integer`

Total number of records.

**num\_parse\_success** `integer`

Number of successfully parsed records.

**num\_parse\_failures** `integer`

Number of parse failures.

**num\_submit\_success** `integer`

Number of successfully submitted records.

**num\_submit\_failures** `integer`

Number of submit failures.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.