Shops
Invite to the team (email, deprecated)
POST
/
api
/
v2
/
shops
/
{shopId}
/
team
/
invitations
Invite to the team (email, deprecated)
curl --request POST \
--url https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "kolega@example.com",
"roles": [
"support"
],
"customPermissions": [
"orders:read"
]
}
'import requests
url = "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations"
payload = {
"email": "kolega@example.com",
"roles": ["support"],
"customPermissions": ["orders:read"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'kolega@example.com',
roles: ['support'],
customPermissions: ['orders:read']
})
};
fetch('https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'kolega@example.com',
'roles' => [
'support'
],
'customPermissions' => [
'orders:read'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations"
payload := strings.NewReader("{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"message": "<string>"
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}Authorizations
apiKeyAuthbearerAuth
Path Parameters
Shop ID (ObjectId)
Body
application/json
Invitee email
Example:
"kolega@example.com"
Roles with permission presets: owner, admin, manager, support, viewer (and legacy view/edit/full).
Maximum array length:
10Example:
["support"]
Extra single permissions resource:action (e.g. 'products:write'), wildcards 'orders:' / ''. Granted ON TOP of roles.
Maximum array length:
64Example:
["orders:read"]
Was this page helpful?
⌘I
Invite to the team (email, deprecated)
curl --request POST \
--url https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "kolega@example.com",
"roles": [
"support"
],
"customPermissions": [
"orders:read"
]
}
'import requests
url = "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations"
payload = {
"email": "kolega@example.com",
"roles": ["support"],
"customPermissions": ["orders:read"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'kolega@example.com',
roles: ['support'],
customPermissions: ['orders:read']
})
};
fetch('https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'kolega@example.com',
'roles' => [
'support'
],
'customPermissions' => [
'orders:read'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations"
payload := strings.NewReader("{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.itemshop.dev/api/v2/shops/{shopId}/team/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"kolega@example.com\",\n \"roles\": [\n \"support\"\n ],\n \"customPermissions\": [\n \"orders:read\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"message": "<string>"
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}{
"success": false,
"statusCode": 400,
"error": "Error message",
"timestamp": "2023-11-07T05:31:56Z",
"path": "/api/v2/..."
}