Sign in
erp-imports

abortErpImport

Ask a running import to stop. Valid while the job is VALIDATING or PROCESSING; any other status returns 409. The stop is cooperative: the job passes through CANCELLING and typically reaches CANCELLED within seconds. Rows already published to the platform are kept: this is a stop, not a rollback. Aborting during VALIDATING has published nothing, so it is always clean; aborting during PROCESSING leaves a partial import, and the rows that landed are visible in monitoring under the job's correlation_id.

post/v2/erp/imports/{importId}:abort

Path parameters

importIdstring required

Response

The stop was recorded. The job is still finishing up — poll GET /v2/erp/imports/{importId} to observe CANCELLED.

import_idstring required

imp_{ULID} — time-ordered, also used as the job's correlation_id.

org_idstring required
created_bystring
integration_idstring

The integration owning the chosen use case. Absent until the first :validate.

use_case_slugstring

The inbound use case whose mapping drives both phases. Absent until the first :validate, and MUTABLE — re-validating with a different use case replaces it.

format'csv' | 'xlsx' required
status'PENDING' | 'VALIDATING' | 'READY' | 'PROCESSING' | 'IMPORTED' | 'FAILED' | 'CANCELLING' | 'CANCELLED' required

PENDING → VALIDATING → READY → PROCESSING → IMPORTED, with FAILED reachable from any working status, and CANCELLING → CANCELLED reachable from VALIDATING or PROCESSING via :abort. Only IMPORTED and CANCELLED are terminal. READY and FAILED both accept a further :validate, which is how a wrong use case is corrected without re-uploading the file. IMPORTED means every row was handed to the platform, not that the platform finished — per-row outcomes live in monitoring, filtered by correlation_id. A file that fails validation is FAILED with error.code = VALIDATION_BLOCKED. READY is legitimately idle for as long as the user takes to confirm, so it carries no running work and never goes stale. CANCELLING is transient and cooperative: the abort has been recorded but the worker only notices at its next batch boundary. Rows already published stay published — a stop is not a rollback.

size_bytesinteger

Size of the uploaded file, recorded at registration. Present on every job registered from version 1.17.0 onwards; absent on older rows, which were written before it was captured.

column_countinteger

How many effective columns the file's header yielded — the length of the preview.columns returned at registration, kept so a job loaded later can still describe its file. The preview ROWS are deliberately not stored: they are a sample for the person about to choose a mapping, not job state. Present on every job registered from version 1.17.0 onwards.

correlation_idstring

Scopes this run in monitoring. Always equal to import_id.

activity_idstring
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 5 of the 8 revisions of this API.418

  • a765dc1273591See the full diff
    • ●

      added the new BLANK_ROWS_SKIPPED enum value to the validation/issues/items/code response property for the response status 202

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cf02c9310c0f2See the full diff
    • ○

      added the optional property column_count to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property size_bytes to the response with the 202 status

      response-optional-property-added

  • a567add0c3f523See the full diff
    • ▲

      the validation/issues/items/columns/items/ response's property type/format changed from string/ to object/ for status 202

      response-property-type-changed

    • ▲

      removed the required property validation/issues/items/message from the response with the 202 status

      response-required-property-removed

    • ○

      added the optional property validation/issues/items/columns/items/entity to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property validation/issues/items/row to the response with the 202 status

      response-optional-property-added

    • ○

      added the required property validation/issues/items/columns/items/name to the response with the 202 status

      response-required-property-added

  • 68961a011db022See the full diff
    • ▲

      the response property integration_id became optional for the status 202

      response-property-became-optional

    • ▲

      removed the required property error/type from the response with the 202 status

      response-required-property-removed

    • ○

      added the optional property validation/issues to the response with the 202 status

      response-optional-property-added

    • ○

      added the required property error/code to the response with the 202 status

      response-required-property-added

  • c24837d750961See the full diff
    • ○

      endpoint added

      endpoint-added