Skip to main content
POST
Create invitation

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

Body

application/json

Invites someone to become a reseller of this store's stock.

email
string<email>
required

Who to invite. The invite can only be redeemed by an account on this address.

Required string length: 1 - 320
variantIds
string<uuid>[]
required

Products to set them up with. They land on a dashboard already able to sell these rather than on an empty page.

grantsReferralCommission
boolean
required

Whether accepting also earns the inviter referral commission.

expiresInDays
integer<int32> | null

How long the invite stays usable. Defaults to a fortnight.

Required range: 1 <= x <= 90

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
object

An invitation a store has sent.

Last modified on August 22, 2026