Skip to content
Crossmart Docs

Import history of a workspace, newest first

GET
/api/v1/workspaces/{workspaceId}/import-jobs
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/import-jobs?status=PROCESSING&format=shopify_csv&direction=desc&limit=20'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: PROCESSING COMPLETED FAILED
format
string
Allowed values: shopify_csv inventory_csv shopify_api

Where the records came from: a file of this format, or a channel

direction
string
Allowed values: asc desc
cursor
string format: uuid

nextCursor from the previous page

page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 20 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
mode
required
string
Allowed values: create update inventory create_or_link
format
required
string
Allowed values: shopify_csv inventory_csv shopify_api
fileName
required

The file name, or the channel account a channel import read

string
connectionId
required

The channel connection a channel import reads; null for file imports

string format: uuid
nullable
totalCount
required

Records the source holds, when it reports them, to show progress

number
nullable
status
required
string
Allowed values: PROCESSING COMPLETED FAILED
counts
required

Products for create and update imports; stock rows for inventory imports

object
created
required
number
linked
required

Channel products linked to catalog products they matched; zero for file imports

number
updated
required

Products replaced by an update import, variants whose stock an inventory import set, or products a channel import found already linked

number
skipped
required
number
failed
required
number
errorMessage
required

Why the whole file was rejected

string
nullable
actor
required
object
userId
required
string format: uuid
nullable
userName
required

The user who sent the file; null for API keys and deleted users

string
nullable
apiKeyId
required
string format: uuid
nullable
apiKeyName
required

The API key that sent the file, if one did

string
nullable
createdAt
required
string format: date-time
finishedAt
required
string format: date-time
nullable
nextCursor
required

Null on the last page

string
nullable
total
required

How many match in all, for page numbers

number

Example 

{
  "items": [
    {
      "mode": "create",
      "format": "shopify_csv",
      "status": "PROCESSING"
    }
  ]
}