Skip to main content
POST
Initialize shopify sandbox with data

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Query Parameters

init_default_data
boolean
default:false

If true, use default test data for initialization

Body

application/json

Complete Shopify sandbox data structure.

Orders reference customers and products by their index in the respective lists. Products and customers are created first, then orders are created with proper references.

products
ShopifyProduct · object[] | null

List of products to create

customers
ShopifyCustomer · object[] | null

List of customers to create

orders
ShopifyOrder · object[] | null

List of orders to create

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied,
error
message
string
required

Initialization result message