Skip to content
Bottle

Invite a colleague

POST
/storefront/sites/{host}/account/customers/{customerId}/invitations
curl --request POST \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/invitations \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "role": "manager" }'

Deliberately without a staff session: a shopper on the business’s own shop. A manager asks somebody to buy for this customer with their own sign-in and a role. They are emailed a link that works for 7 days.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string
Example
northgate.shop.getbottle.app
customerId
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string format: email
<= 200 characters
role
required

Manager: orders, sees invoices, invites and removes colleagues. buyer: orders and sees their own orders. accounts: invoices and statements, cannot order.

string
Allowed values: manager buyer accounts

Responses

Section titled “Responses”

201

Section titled “201”

Invited

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
email
required
string
role
required

Manager: orders, sees invoices, invites and removes colleagues. buyer: orders and sees their own orders. accounts: invoices and statements, cannot order.

string
Allowed values: manager buyer accounts
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "role": "manager"
}

400

Section titled “400”

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

A real shop not selling now (shop_closed)

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

429

Section titled “429”

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}