Skip to main content
POST
/
v2
/
workspace
/
onboard
/
shopify
onboarding shopify store
curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v2/workspace/onboard/shopify \
  --header 'Content-Type: application/json' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "name": "The Leather Co.",
  "currencyCode": "INR",
  "timezone": "Asia/Kolkata",
  "supportContacts": {
    "phoneNumber": "+91-9876543210",
    "email": "support@brand.com"
  },
  "trustSignals": {
    "valuePropositionOneLiner": "Handcrafted in Jaipur using 100% sustainable vegan leather.",
    "customersTillDate": 15400,
    "totalOrdersFulfilled": 50000,
    "storeRating": 4.8
  },
  "policyFramework": {
    "returnPolicy": {
      "windowDays": 7,
      "processingFee": {
        "amount": 50
      },
      "refundTimelineDays": 3
    },
    "shippingPolicy": {
      "deliveryTimeline": {
        "minDays": 3,
        "maxDays": 5
      },
      "freeShippingMinOrderValue": 999
    },
    "codPolicy": {
      "enabled": true,
      "additionalFee": {
        "amount": 50
      }
    }
  }
}
'
{
  "workspace": "4524239459234",
  "status": "active",
  "billing": {
    "type": "prepaid",
    "creditBalance": 100,
    "negativeCreditAllowance": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.miraiminds.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-public-key
string
header
required
​
x-private-key
string
header
required

Headers

​
x-public-key
string
required
​
x-private-key
string
required

Body

application/json
​
name
string
required
Example:

"The Leather Co."

​
currencyCode
string
required
Example:

"INR"

​
timezone
string
required
Example:

"Asia/Kolkata"

​
supportContacts
object
required
​
trustSignals
object
required
​
policyFramework
object
required

Response

Workspace Created & Billing Configured

​
workspace
string

The unique key for all future API calls.

Example:

"4524239459234"

​
status
enum<string>
Available options:
active,
pending_verification,
suspended
Example:

"active"

​
billing
object