Onboard a custom brand (v1)
v1’s onboarding call, same path and same body, so a script written for v1 only needs a new base URL and key. It creates a sub-workspace of kind custom: currencyCode and timezone become its currency and timezone, and supportContacts, trustSignals and policyFramework go into its profile.
The answer keeps v1’s status, workspace and billing fields and adds the new brand as sub_workspace. workspace is the id to send in the Mirai-Workspace header. billing is your account’s wallet, which the brand spends from. For new integrations, Create a sub-workspace does the same with an external_id.
Authorizations
Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.
Body
1 - 100Your own id for the brand (external_id).
128v1's {returnPolicy, shippingPolicy, codPolicy {enabled, additionalFee {amount}}}.
v1's {phoneNumber, email}.
v1's {customersTillDate, totalOrdersFulfilled, storeRating, valuePropositionOneLiner}.
Response
Onboarded