Skip to content
Bottle

How copying the website is going

GET
/storefront/import
curl --request GET \
  --url https://example.com/storefront/import \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The latest copy of the business’s WooCommerce website into its shop: its step, how far through, what it made, and notes for the owner. Also the connected websites eligible to copy and whether starting one now would replace work in the shop.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The latest import

Media typeapplication/json
object
import
required
object
id
required

UUID v7

string format: uuid
shopId
required

UUID v7

string | null format: uuid
status
required

Queued: waiting to start. running: under way. done: finished. failed: stopped; starting again carries on. undone: what it made was taken out again.

string
Allowed values: queued running done failed undone
step
required

Fetching: reading the website. pictures: copying its pictures. converting: making pages and blog posts. drafting: setting up the look, home page and menus. done: finished.

string
Allowed values: fetching pictures converting drafting done
progress
required
object
done
required
integer
total
required
integer
counts
required
object
pages
required
integer
posts
required
integer
menus
required
integer
pictures
required
integer
picturesFailed
required
integer
draftedByAi
required
boolean
notes
required
Array<object>
object
key
required
string
<= 80 characters
values
object
key
additional properties
Any of:
string
error
required
string | null
canUndo
required
boolean
createdAt
required
string format: date-time
finishedAt
required
string | null format: date-time
sources
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
replacesWork
required
boolean

Example 

{
  "import": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "shopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "status": "queued",
    "step": "fetching",
    "notes": [
      {
        "values": {}
      }
    ]
  },
  "sources": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

402

Section titled “402”

The plan does not include a shop

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a person signed in as an owner or admin, or without the permission

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}