Create an import and get a single-file upload URL
Create an import row for one file and return a presigned URL to PUT its bytes to; check uploadMode for how to deliver the file. Set importType to PRODUCT_UPDATES for a product bulk-update .xlsx workbook. Requires file upload v2 for the target organization. userId is required and non-empty with an API key and ignored for signed-in sessions, which record the authenticated user.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-10-06.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Body
Original file name of the upload.
Declared file size in bytes.
MIME type of the file to upload.
Import source (a connector name, or IMPORT for a manual upload).
Required and non-empty when authenticating with an API key: the id of the person or process performing the upload, recorded for audit. Ignored for signed-in sessions, which record the authenticated user.
SALE or PURCHASE for the whole file; blank per-row direction cells take this value.
SALEPURCHASETRANSACTIONS (default) for a sales/purchase CSV. PRODUCT_UPDATES for a product bulk-update workbook: fileName must end in .xlsx and contentType must be the Excel workbook MIME type.
TRANSACTIONSPRODUCT_UPDATESResponse
Id of the created import.
URL to PUT the file bytes to; a path on this API when uploadMode is local_internal.
When uploadUrl expires.
How to deliver the file. presigned sends it to the returned URL directly. local_internal only appears in local development: send it to the returned path on this API with your credential.
presignedlocal_internalSuccessful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
The request failed validation.