Skip to main content
POST
/
sandbox
/
shopify
/
{sandbox_id}
/
initialize
Initialize shopify sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/shopify/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {
      "title": "<string>",
      "vendor": "<string>",
      "product_type": "<string>",
      "variants": [
        {
          "price": "<string>",
          "sku": "<string>",
          "inventory_quantity": 1
        }
      ],
      "body_html": "<string>",
      "status": "active"
    }
  ],
  "customers": [
    {
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>",
      "addresses": [
        {
          "address1": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip": "<string>",
          "country": "<string>"
        }
      ]
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Body

application/json

Complete Shopify sandbox data structure

Note: Orders are created automatically by the sandbox based on products and customers. The initialize method will generate orders that link customers to products.

products
ShopifyProduct · object[] | null

List of products to create

customers
ShopifyCustomer · object[] | null

List of customers 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
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type