Pular para o conteúdo principal
POST
/
api
/
workspace
/
{workspaceId}
/
catalog
/
products
/
import
Bulk import products
curl --request POST \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/catalog/products/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form format=csv
{
  "jobId": "<string>",
  "backgroundJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queue": "ingest",
  "jobName": "<string>",
  "status": "queued",
  "notify_email": true
}

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 /api/workspace/{workspaceId}/jobs/{backgroundJobId} for status.

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
​
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.

Last modified on February 16, 2026