Skip to main content
POST
Bulk Import Categories

Headers

domain
string
required

The brand domain name (for example, vessel.com or containerstore.com) used to scope the request to a specific brand's data and configuration. The authenticated principal must be authorized for the specified brand.

Example:

"vessel.com"

Body

multipart/form-data
file
file
required

CSV file containing categories (e.g. categories.csv)

name
string

Human friendly import name

Example:

"Spring catalog category import"

notify_email
boolean
default:true

Send an email when the import completes.

Example:

true

Response

Import accepted for asynchronous processing

import_id
string<uuid>
required

Identifier for the import job.

Example:

"a0cf63a0-55b8-4a25-9218-d972d4d65a79"

status
string
required
Example:

"PENDING"

message
string
required

Status message for the queued import.

Example:

"Import queued. Use GET /categories/import/{import_id} to track progress."

created_at
string<date-time>
required

Timestamp when the import was created.

Example:

"2026-03-12T17:58:13.605818Z"