EPepilot
erp-imports

createErpImport

Changed on

Register an already-uploaded file (S3 ref) as a pricing-file import job. Returns the job and a file preview. Nothing runs yet: no use case is chosen and no validation starts here. Optionally rank candidates with POST /v2/erp/imports/{importId}:suggest-use-cases, then start validation with POST /v2/erp/imports/{importId}:validate. Pass import_id to repoint an existing import at a different file instead, keeping its id and its place in the history — allowed while the import has written nothing.

post/v2/erp/imports

Request

  • Base URL
    https://integration-toolkit.sls.epilot.io
  • URL
    https://integration-toolkit.sls.epilot.io/v2/erp/imports
  • Auth
    HTTP bearer

Request body

include_previewboolean

Return a sample of the file's first rows in preview. Only controls whether the sample comes BACK — the head is read either way, because that read is how an unreadable file gets refused.

import_idstring

Repoint an EXISTING import at this file instead of registering a new one — same row, same id, so iterating on which file to import leaves one entry in the history rather than one per attempt. Repointing is allowed exactly while the import has written nothing: from PENDING and READY, and from FAILED when error.code is one of VALIDATION_BLOCKED, VALIDATE_TIMEOUT or FILE_FORMAT_UNSUPPORTED. Anything else returns 409 with code IMPORT_NOT_REPLACEABLE. The repoint clears any verdict the import had. An id that names nothing returns 404. It never falls back to registering a new import: a stale id must fail loudly rather than quietly produce a second one.

Response

The named import now points at this file. Returned only when import_id was supplied — no Location, because nothing was created.

Example response

{
  "job": {
    "validation": {
      "entity_details": [
        {
          "condition_attributes": [
            "grid_area"
          ],
          "version_attribute": "valid_from"
        }
      ]
    }
  }
}

Changes

  • b7eb225e41b3Revision changes
    • warning

      added the new VALID_FROM_NOT_MAPPED enum value to the //// response property for the response status

    • warning

      added the new VALID_FROM_NOT_MAPPED enum value to the //// response property for the response status

  • 57a11671a74dRevision changes
    • warning

      added the new UNIQUE_ID_NOT_IN_SCHEMA enum value to the //// response property for the response status

    • warning

      added the new UNIQUE_ID_NOT_IN_SCHEMA enum value to the //// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status