REST Standard REST APIs DataImport REST API

3.16.0

The DataImport REST API is used to; import data into the system via Microsoft Excel spreadsheets and query the status of the import process.

Data import files sizes are currently limited to 500k in size. If you need to import larger amounts of data you will have to break up the data into multiple data import requests.

On successful posting of a new request, an import ID will be returned. This ID can be used to retrieve the original posted data file as well as track the status of the import process.

The original imported source file will automatically be deleted from our system after 14 days. However, the status of the import process will be available for 30 days.

On this page:

Related pages:

REST Object Definitions Data Import Related Objects DataImport Object

The type of object being imported is determined by the spreadsheet tab name.

The DataImport API currently supports importing the following object types:

Accounts
Account Locations
Products
TaxRate
Users
Work Orders

Resource URL Summary

Submit a new data import request

POST /seiapi/v3/DataImport

Retrieve the status of all submitted data import requests

GET /seiapi/v3/DataImport/

Retrieve the original submitted data import file

GET /seiapi/v3/DataImport/${ImportID}

Retrieve the status of a specific data import request

GET /seiapi/v3/DataImport/${ImportID}/status

URL Parameters

Parameter	Description
`${ImportID}`	Identifies a specific data import file.

Supported HTTP Methods

Method	Description
GET	Returns the account specific pricing for the account identified by the ${AccountNum} URL path
POST	Creates a new data import request.

HTTP Headers

Property Method Description

Content-Type

POST

Must be set to multipart/form-data

x-access-token

GET, POST

Must contain a valid JSON Web Token (JWT)

Submitting a new Data Import Request

URL

POST /seiapi/v3/DataImport

When submitting a new data import request the following rules must be met:

Set Content-Type to multipart/form-data
Set the form-data name field to "file"
The posted data file size must be less than 500k

HTTP Response

On success an HTTP response code of 200 will be returned and the response body will contain a unique data import ID. This ID can be used to retrieve the processing status of the request.

Retrieve the Status of All Data Import Requests

When retrieving the status of all data import requests, the response will contains a collection of ImportData Objects. When retrieving the status of a specific data import request, a single ImportData Object will be returned.

[
	{
		// ImportData object
	},
	{
		// ImportData object
	}
]

GET Specific Status Response Body

When retrieving the status of a specific import request, the response will contains an ImportData Object.

JSON Format

{
    "_t" : "dataimport",
	"_v" : "1.0",
	"ImportID" : "",
	"MimeType" : "",
	"ObjType" : "",
	"OriginalName" : "",
	"Size" : "",
	"Status" : 1001,
	"SubmitDate" : "",
	"ProcessingStart" : "",
	"ProcessingEnd" : "",
	"Results" : {
		"Success" : 0,
		"Errors" : 0,
		"Messages" : [
			{
				"row" : "",
				"error" : ""
			}
		]
	}
}

GET Posted File Response Body

When retrieving the original posted file for a specific data import request, the response body will contain the originally posted MS Excel spreadsheet data file.