Onboard a vendor

Requires manage partner vendors, or partner:vendors:write for a partner API key. The vendor is attached to this partner for good and
has no widget, API, integrations or billing surface of its own; those routes answer
403 with code: OYS-PARTNER-1000. Onboarding is marked complete from vendor_type, so
its staff skip the signup quiz. When owner is given, that person is invited as the
vendor's owner and receives the usual staff invitation email.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255
string
required
string
required
length ≤ 20
string
enum
required
Allowed:
string

Defaults to the partner's currency. Cannot be changed afterwards through the partner API.

string

Defaults to the partner's language.

string | null

Your own ID for this vendor, unique among your vendors. Makes onboarding safe to retry:
a second call with a reference you have already used creates nothing and answers 200
with the vendor the first call made, whatever the other fields say.

owner
object | null
Responses

403

Missing manage partner vendors.

422

Validation failed, or a vendor with this business email exists.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json