Skip to main content
POST
import store products

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
store_url
string
required

The shop: a domain or any page on it.

dry_run
boolean

Read and plan only. Returns the folders, file count and estimated size, and degraded when part of the shop would not answer.

images_per_product
integer

Default 3. A store gallery is mostly the same angle again.

Required range: 1 <= x <= 10
include_videos
boolean

Shopify stores only. Adds each product's videos, which are much larger than images.

max_products
integer
Required range: 1 <= x <= 1000
max_files
integer

Default 400, videos included.

Required range: 1 <= x <= 2000
root_folder
string

Where it lands. Defaults to the brand name.

context
string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]