Skip to main content
POST
Bulk Import Products from JSON or CSV

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

products
object[]
required
Required array length: 1 - 5000 elements
targetMarketplaces
enum<string>[]
required
Minimum array length: 1
Available options:
shopee,
lazada,
tiktok,
shopify,
whatsapp,
zalora,
amazon,
ebay
marketplaceStoreSelections
object
required

Required: select at least one connected store. One store per marketplace, not an array of store IDs.

title
string | null
Maximum string length: 120
organizationId
string
Required string length: 1 - 120
csvText
string
documentId
string
Required string length: 1 - 255
fileName
string
Maximum string length: 500
selectedRowIndexes
integer[]
Required range: 0 <= x <= 9007199254740991
lane
enum<string>
Available options:
standard,
enterprise
targetCountries
string[]
Required string length: 1 - 80
fieldMapping
object
dedupPolicy
enum<string>
Available options:
keep_first,
keep_last,
merge_fields_prefer_non_empty,
fail_job
autoApproveThreshold
number | null
Required range: 0 <= x <= 1
spendCeilingUsd
number | null
Required range: x >= 0
model
string
Required string length: 1 - 120
imageAnnotationTemplateId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
imageAnnotationScope
enum<string>
Available options:
primary,
all_gallery
workflow
object

Response

Bulk import workflow accepted

ok
boolean
apiVersion
string
default:developer_v1
operationId
string
status
string
jobId
string

Bulk import job ID with bulk_ prefix.

warnings
string[]
recommendations
string[]
data
object