Skip to main content
POST
Onboard a Shopify brand (v1)

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Body

application/json
name
string
required
Required string length: 1 - 100
currencyCode
string
default:INR
externalId
string | null

Your own id for the brand (external_id).

Maximum string length: 128
policyFramework
object | null

v1's {returnPolicy, shippingPolicy, codPolicy {enabled, additionalFee {amount}}}.

supportContacts
object | null

v1's {phoneNumber, email}.

timezone
string
default:Asia/Kolkata
trustSignals
object | null

v1's {customersTillDate, totalOrdersFulfilled, storeRating, valuePropositionOneLiner}.

Response

200 - application/json

Onboarded