Pular para o conteúdo principal
POST
Bulk import products

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Parâmetros de caminho

workspaceId
string
obrigatório

The workspace ID

Pattern: ^ws_[a-z0-9]+$

Parâmetros de consulta

catalog_id
string

Corpo

multipart/form-data
file
file
obrigatório

CSV or JSON file with products

format
enum<string>
padrão:csv
Opções disponíveis:
csv,
json

Resposta

Import job enqueued. Poll statusUrl for the import; when pipeline is queued, poll pipelineStatusUrl for the chained Silver/Gold pipeline (ADR 015).

Returned when a background job is successfully enqueued for async processing (202 Accepted). Poll GET /api/workspace/{workspaceId}/jobs/{backgroundJobId} for status updates. An in-app toast notification is shown when the job reaches a terminal state. Pass notify_email: true in the request to also receive an email on completion or failure.

jobId
string
obrigatório

BullMQ job ID (matches backgroundJobId for correlation)

backgroundJobId
string<uuid>
obrigatório

Internal background_jobs record ID. Use this to poll the jobs status endpoint.

queue
enum<string>
obrigatório

Worker queue the job was added to

Opções disponíveis:
ingest,
catalog,
media
jobName
string
obrigatório

Job type identifier (e.g. pipeline_run, platform_sync, workflow_batch)

status
enum<string>
obrigatório

Initial status. Transitions to active → completed | failed as the worker processes it.

Opções disponíveis:
queued
catalog_id
string<uuid>
obrigatório
productCount
integer
obrigatório
pipeline
enum<string>
obrigatório

Whether the Bronze→Silver→Gold pipeline is chained after this import. The worker enqueues pipeline_run once the products are saved; not_queued only when no catalog could be resolved.

Opções disponíveis:
queued,
not_queued
notify_email
boolean

Whether the user opted in to receive an email notification when the job completes or fails. Defaults to false if not provided in the request.

catalog_slug
string | null
pipelineJobId
string<uuid> | null

Deterministic background_jobs id of the chained pipeline_run (dedupe key pipeline_run:import:<jobId>).

pipelineStatusUrl
string | null
Última modificação em 16 de fevereiro de 2026