Skip to main content
POST
Onboard a Shopify store (Shopify merchants only)

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