An import with its skipped and failed records

GET

/api/v1/workspaces/{workspaceId}/import-jobs/{jobId}

const url = 'https://api.crossmart.io/api/v1/workspaces/example/import-jobs/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.crossmart.io/api/v1/workspaces/example/import-jobs/example

Parameters

Path Parameters

workspaceId

required

string

jobId

required

string

Responses

200

application/json

object

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

issues

required

Skipped and failed records, in file order

Array<object>

object

code

required

string

Allowed values: already_exists duplicate_sku invalid_value missing_value invalid_options not_found unknown_sku not_tracked duplicate_row unmatched_variant already_linked

message

required

string

handle

string

sku

string

row

Spreadsheet row number; the header is row 1

number

outcome

required

string

Allowed values: SKIPPED FAILED

Example

{
  "mode": "create",
  "format": "shopify_csv",
  "status": "PROCESSING",
  "issues": [
    {
      "code": "already_exists",
      "outcome": "SKIPPED"
    }
  ]
}