Get an import job

GET/v1/api/store/{team_slug}/imports/{hash_id}

v1Operation ID v1_public_imports_show

Returns one import job: its status and how many items succeeded, failed or were skipped.

completed, completed_with_errors and failed are final. A service pricing upload is already final when its upload request returns, so you never need to poll it: its job is always completed, with one item and failed_item_count 0, because a failed upload saves nothing and leaves no job.

Permission

Any member who can import at least one kind of record: customers (permission to create and to update all customers), vendors (create and update vendors), products (create and update products) or service pricing (update services). When the Printavo importer is on, members who can manage settings qualify too. Each job is visible only to members with the permissions its kind needs: the ones above, and create and update services for a service pricing job that created a service. Printavo jobs also need the Printavo importer turned on for the team; Printavo jobs for records other than customers and vendors need permission to manage settings.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The import job's id, from the import jobs list or the upload answer. A hash id; unique keys and document numbers are refused with 404.

  • Example L4wYdA6Rav79IZ

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (20)

  • created_atstring (date-time)required
  • display_statusstringrequired

    A status slug formatted for UI display: matches status, or is imported_with_unresolved_rows when some items succeeded and some failed.

  • entity_typestringrequired

    What was imported. For CSV imports: service_pricing (the CSV type supported via API), or older uploader types (customer, vendor, simple_product, variant_product, custom_product). For Printavo imports: Printavo record types (such as customer, vendor).

  • failed_item_countintegerrequired

    Items that failed. Always 0 on service pricing imports: they are all or nothing, and any error fails with 422 without creating an import job. Only Printavo imports and retired CSV uploader jobs can have failed items.

  • idstringrequired

    The import job's id (a hash id).

  • source_typestringrequired

    Where the data came from.

    • One of: "csv", "printavo"
  • statusstringrequired

    completed, completed_with_errors and failed are final.

    • One of: "pending", "staged", "ready_to_commit", "committing", "completed", "completed_with_errors", "failed"
  • success_item_countintegerrequired

    Items saved.

  • total_item_countintegerrequired

    Rows (items) in the job. A service pricing job has one item: the whole price table.

  • already_imported_countinteger

    Items skipped because they were imported before.

  • auto_commitboolean

    True when the job saves its rows without a separate review step.

  • completed_atstring (date-time) | null

    When the job reached a final status.

  • display_status_labelstring | null

    A human-readable status label: "Imported with unresolved rows" when display_status is imported_with_unresolved_rows, otherwise null.

  • duplicate_countinteger

    Items skipped as duplicates within the job.

  • error_csv_urlstring | null

    Web app download URL for a failed-rows CSV. Null for service pricing and Printavo jobs, and for new imports. Only retired CSV uploader jobs (pre-September 2026) may have a link. Because this is a web app link that API keys cannot open, download the file via the API using GET /v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csv. Check failed_item_count to see if items failed.

  • legacy_statusstring | null

    An older status word kept for the web app, such as import_success or validation_failed. Prefer status.

  • source_account_refstring | null

    The connected source account, for Printavo jobs.

  • target_modestring | null

    Service pricing jobs: existing_service or create. Otherwise usually null.

  • unresolved_item_countinteger

    Failed items: the same number as failed_item_count.

  • updated_atstring (date-time) | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  You lack the permissions this job's kind needs (a plain {"message": "Insufficient Permission"} body), or it is a Printavo job and the Printavo importer is off for the team (printavo_importer_disabled).

  Fix

  Ask a team admin for the permissions, or read jobs you can see in the list.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No import job of this team has this id.

  Fix

  Use an id from the list.

Related

• GETList import jobs/v1/api/store/{team_slug}/imports
• GETDownload an import job's failed rows/v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csv

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/imports/L4wYdA6Rav79IZ' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "already_imported_count": 0,
    "auto_commit": true,
    "completed_at": "2026-11-03T09:30:02+00:00",
    "created_at": "2026-11-03T09:30:00+00:00",
    "display_status": "completed",
    "display_status_label": null,
    "duplicate_count": 0,
    "entity_type": "service_pricing",
    "error_csv_url": null,
    "failed_item_count": 0,
    "id": "L4wYdA6Rav79IZ",
    "legacy_status": "import_success",
    "source_account_ref": null,
    "source_type": "csv",
    "status": "completed",
    "success_item_count": 1,
    "target_mode": "existing_service",
    "total_item_count": 1,
    "unresolved_item_count": 0,
    "updated_at": "2026-11-03T09:30:02+00:00"
  },
  "status": 200,
  "success": true
}