Retrieve an import

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/imports/{id}

Costs 1 rate-limit point · Rate limits

Read one CSV import: its state (queued, running, stalled, failed, completed) and row progress.

state is queued (accepted, waiting in the job queue for a worker), running (rows are finishing), stalled (nothing moved for stall_after_seconds; stalled_reason not_started means it never left the queue, no_progress means it started and stopped), failed or completed. A queued import with rows_done 0 is waiting, not broken: when the queue is busy an import can wait several minutes before its first row. Stalled imports are retried automatically within about 10 minutes. rows_done = rows_succeeded + rows_failed; a completed import can have failed rows (bad SKU, invalid email). Timestamps are UTC; waited_seconds is the time from created_at to started_at (or until now while queued), idle_seconds the time since anything last moved. state=open lists every import not yet completed or failed.

Also searched asimport statuscheck importpoll importimport progress

Path parameters

idstringRequired

Errors

401

Missing or invalid X-Auth-Token.

404

The resource does not exist for this shop, or the action path is not registered.

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

GET/account/imports/{id}

curl "https://app.stoqapp.com/api/v2/external/account/imports/{id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/imports/{id}", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/account/imports/{id}",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/imports/{id}")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}