Imports API

Base URL: https://app.skuflow.ai/api. Every call needs Authorization: Bearer skf_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Import sources and fieldsCopy Anchor Link

What can be imported: the sources (DECONETWORK, SPREADSHEET = "Other spreadsheet": any other tool such as Printavo or InkSoft, or a hand-made sheet), each with the steps to export every dataset it has a preset for, and the SKUFlow fields of each dataset (mapping targets). DecoNetwork's presets (customers, the order items export as invoices, the payments export) were checked against real exports (verified); unknown columns go to AI mapping. Read-only. Next: POST /imports.

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/migration/sources" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

List importsCopy Anchor Link

The business's imports, newest first (the last 50), with files, progress, results and whether undo is still possible. Read-only.

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Start an importCopy Anchor Link

Creates a draft import from one source. Nothing is written to customers, quotes or invoices until it is applied. Next: add files (POST /imports/{importId}/files), check the mapping, preview, apply. A re-run on cutover day is a new import on fresh exports: records match by their source id (then email/phone, address, code, number) and are updated in place, never duplicated.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"DECONETWORK"}'

ResponseCopy Anchor Link

Get an importCopy Anchor Link

One import: its files with their detected dataset and column mapping, the last preview, progress while it runs (progress.done of progress.total rows), the summary and problems when finished, and the undo deadline. Poll it while status is QUEUED or RUNNING. Read-only.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Delete a draft importCopy Anchor Link

DELETES the draft import and its uploaded files. Only an import never applied (DRAFT); an applied one is undone instead (POST …/undo).

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X DELETE "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Add a file (content in the request)Copy Anchor Link

Adds an export to the import in one call: text for CSV / TSV, or contentBase64 for any file including .xlsx (each sheet becomes a file of the import). It is stored privately, read, and sniffed: the dataset it holds (customers, contacts, properties, pricebook, quotes, invoices, payments, notes) and the mapping from the source's preset, the saved mapping and the name heuristic. Several files may hold one dataset (a list split into several exports). The browser uses POST …/uploads instead. Returns the import.

ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/files" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName":"string"}'

ResponseCopy Anchor Link

Get an upload URLCopy Anchor Link

Step 1 of a browser upload: a signed URL to PUT the file to (10 minutes, with the same Content-Type). Then POST …/uploads/{uploadId}/confirm to read and sniff it.

ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/uploads" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName":"string","contentType":"string","sizeBytes":1}'

ResponseCopy Anchor Link

Confirm an uploadCopy Anchor Link

Step 2 of a browser upload: reads the uploaded file, sniffs each sheet and maps its columns. Returns the import.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/uploads/{uploadId}/confirm" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Set a file's dataset or mappingCopy Anchor Link

Confirms or corrects what a file holds (dataset; null skips the file; changing it re-maps the columns) and its column mapping (mapping: header → field key from GET /migration/sources, custom:<label> for a new custom field on customers or properties, or null to skip). Confirmed columns are remembered for the next upload of that kind of file. Clears the preview. Returns the import.

ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X PATCH "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/files/{fileId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dataset":"pricebook","mapping":{}}'

ResponseCopy Anchor Link

Remove a file from an importCopy Anchor Link

DELETES the file (sheet) from the draft import; its stored upload goes when no sheet uses it. Returns the import.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X DELETE "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/files/{fileId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

AI column mappingCopy Anchor Link

Columns the preset and the saved mapping do not know go to Claude (headers and up to three sample values each), which proposes a field, a custom field or skip with a confidence; anything below 0.7 is listed in needsReview. Never changes columns the owner set. Uses AI credits. Without AI configured the name heuristic answers (mode HEURISTIC). Returns the file.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/files/{fileId}/suggest-mapping" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Preview an import (dry run)Copy Anchor Link

The dry run: counts per entity (to create, to update, duplicates, kept because edited in SKUFlow), every problem with its file, row, column and severity, sample records, opening balances to write and customers who will need a card. Writes no records (only the preview on the import). Required before applying.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/preview" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Apply an importCopy Anchor Link

Writes customer and money records: runs the previewed import in the background in dependency order (pricebook → customers → contacts → properties → quotes → invoices → payments → notes). Sends nothing to customers: imported records emit no events and are held back from automations, reminders and dunning until cutover (POST /migration/cutover/release); webhooks get one import.completed. Invoices keep their numbers, issue dates, tax as charged and balances (an opening-balance payment where only a balance was exported); counters move past the highest imported number. Poll GET /imports/{importId}. Undo within 7 days.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/apply" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Undo an importCopy Anchor Link

DELETES what this import created (within 7 days of finishing), in reverse order. Records edited in SKUFlow since, or used by work added since (a new quote, invoice or payment), are kept and listed in undoReport. Records the import only updated stay as they are. Returns the import (status UNDONE).

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/imports/{importId}/undo" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Cutover checklistCopy Anchor Link

What is left after importing: imported records still held back from automations (heldRecords), customers to ask for a card (customersNeedingCard), active automations, and the last import. Read-only.

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/migration/cutover" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Release imported records (cutover)Copy Anchor Link

Customer-visible from now on: imported customers, quotes and invoices join automations, reminders and dunning. Do it once the old system has stopped sending (cutover day). Sends nothing by itself. Returns how many records were released.

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/migration/cutover/release" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Customers to ask for a cardCopy Anchor Link

Customers who paid by card on file or autopay in the old system (needsPaymentMethod): saved cards are not copied, so they are sent the update-card link. The flag clears when they save a card. Read-only.

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/migration/needs-card" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Send update-card linksCopy Anchor Link

Sends to customers: emails or texts each customer flagged needsPaymentMethod (or only customerIds) a link to their portal to add a card for automatic payments (Stripe Checkout in setup mode; nothing is charged). Consent, quiet hours and the message log apply; batchKey makes a retry send nothing twice. Needs online payments (Settings → Payments): 409 otherwise.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/migration/update-card-links" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"EMAIL_OR_SMS","customerIds":["customer_id"],"batchKey":"string"}'

ResponseCopy Anchor Link