Skip to content

Import products with embeddings

POST
/api/products/import
curl --request POST \
--url https://example.com/api/products/import \
--header 'Content-Type: application/json' \
--data '{ "content": "example" }'

CSV file contents to parse, embed, and upsert.

Media type application/json

CSV file contents for product import.

object
content
required
string
>= 1 characters
Example generated
{
"content": "example"
}

Number of products imported.

Media type application/json
object
count
required
integer
errors
required
Array<object>
object
index
integer
sku
string
message
required
string
Example generated
{
"count": 1,
"errors": [
{
"index": 1,
"sku": "example",
"message": "example"
}
]
}

The import body was invalid.

Media type application/json

Plain error payload (single error string).

object
error
required
string
Example generated
{
"error": "example"
}

The import failed while embedding or writing products.

Media type application/json

Plain error payload (single error string).

object
error
required
string
Example generated
{
"error": "example"
}