Skip to main content
GET
/
v1
/
imports
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/imports/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "4725c2a6-949c-41b2-8243-1750328a6bde",
  "object": "import",
  "import_type": "customers",
  "live_mode": false,
  "rows_imported": 0,
  "rows_uploaded": 0,
  "status": "pending",
  "created_at": 1767909706,
  "updated_at": 1767909706
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
import_type
string

The type of record imported – one of customer, product, coupon, purchase, or subscription.

​
import_rows
array

A list of associated import rows.

​
rows_imported
integer

The number of rows successfully imported.

​
status
string

The status of the import – one of completed, invalid, pending, or processing.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.