Download Postman collection
Relative URI |
Method |
Success code |
Description |
---|---|---|---|
|
|
|
Get all imports. |
|
|
Create an import. |
|
|
|
|
Get a specific import. |
|
|
Update a specific import. |
|
|
|
Update part of a specific import. |
|
|
|
Delete a specific import. |
|
|
|
|
Clone a specific import. |
|
|
|
Get a log for a specific import. |
|
|
|
Invoke an import. Data and settings can be passed as an array in the request body to invoke the import. |
|
|
|
Replace the import's connection. |
|
|
|
Get all resources using or used by this import. |
The following fields are available to update when using PATCH
:
Field |
Data type |
---|---|
|
|
|
|
GET /v1/imports/594••••••••••••••••••662 HTTP/1.1 Host: api.integrator.io Authorization: Bearer my_api_token
{ "_id":"594••••••••••••••••••662", "lastModified":"2017-11-28T18:38:19.851Z", "name":"Upload File to FTP Site", "_connectionId":"56f••••••••••••••••••77d", "distributed":false, "apiIdentifier":"ib8f75140f", "file":{ "skipAggregation":false, "type":"csv", "csv":{ "rowDelimiter":"\n", "columnDelimiter":",", "includeHeader":false, "wrapWithQuotes":false, "replaceTabWithSpace":false, "replaceNewlineWithSpace":false } }, "ftp":{ "directoryPath":"/test", "fileName":"file-{{timestamp}}.csv" }, "mapping":{ "fields":[ { "extract":"internal_id", "generate":"id" }, { "extract":"item_id", "generate":"sku" }, { "extract":"name", "generate":"name" }, { "extract":"sales_description", "generate":"description" }, { "extract":"rate", "generate":"price" }, { "extract":"qty_on_hand", "generate":"qty" } ] } }
This example demonstrates changes to the import shown above in the GET example.
PUT /v1/imports/594••••••••••••••••••662 HTTP/1.1 Host: api.integrator.io Authorization: Bearer my_api_token { "_id":"594••••••••••••••••••662", "lastModified":"2017-06-23T17:31:04.446Z", "name":"Upload File to FTP Site (updated!)", "_connectionId":"56f••••••••••••••••••77d", "distributed":false, "apiIdentifier":"ib8f75140f", "file":{ "skipAggregation":false, "type":"csv", "lookups":[ ], "csv":{ "rowDelimiter":"\n", "columnDelimiter":",", "includeHeader":false, "wrapWithQuotes":false, "replaceTabWithSpace":false, "replaceNewlineWithSpace":false } }, "ftp":{ "directoryPath":"/test", "fileName":"file-{{timestamp}}.csv" }, "mapping":{ "fields":[ { "extract":"internal_id", "generate":"updated_id" }, { "extract":"item_id", "generate":"sku" }, { "extract":"name", "generate":"name" }, { "extract":"sales_description", "generate":"description" }, { "extract":"rate", "generate":"price" }, { "extract":"qty_on_hand", "generate":"qty" } ] } }
{ "_id":"594••••••••••••••••••662", "lastModified":"2017-11-28T18:47:09.553Z", "name":"Upload File to FTP Site (updated!)", "_connectionId":"56f••••••••••••••••••77d", "distributed":false, "apiIdentifier":"ib8f75140f", "file":{ "skipAggregation":false, "type":"csv", "csv":{ "rowDelimiter":"\n", "columnDelimiter":",", "includeHeader":false, "wrapWithQuotes":false, "replaceTabWithSpace":false, "replaceNewlineWithSpace":false } }, "ftp":{ "directoryPath":"/test", "fileName":"file-{{timestamp}}.csv" }, "mapping":{ "fields":[ { "extract":"internal_id", "generate":"updated_id" }, { "extract":"item_id", "generate":"sku" }, { "extract":"name", "generate":"name" }, { "extract":"sales_description", "generate":"description" }, { "extract":"rate", "generate":"price" }, { "extract":"qty_on_hand", "generate":"qty" } ] } }
If you want to pass settings along with data in an import, you must wrap the details in individual data and settings JSON objects.
Comments
Please sign in to leave a comment.