Create an invite link

POST

api

shops

{shopId}

team

invite-links

Create an invite link

curl --request POST \
  --url https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "expiresInHours": 168,
  "maxUses": 10,
  "roles": [
    "support"
  ],
  "customPermissions": [
    "orders:read"
  ]
}
'

import requests

url = "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links"

payload = {
    "expiresInHours": 168,
    "maxUses": 10,
    "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({
    expiresInHours: 168,
    maxUses: 10,
    roles: ['support'],
    customPermissions: ['orders:read']
  })
};

fetch('https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links', 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/invite-links",
  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([
    'expiresInHours' => 168,
    'maxUses' => 10,
    '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/invite-links"

	payload := strings.NewReader("{\n  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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/invite-links")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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/invite-links")

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  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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

X-API-Key

string

header

required

Path Parameters

shopId

string

required

Shop ID (ObjectId)

Body

application/json

expiresInHours

number

Validity in hours (0 = never expires)

Required range: 0 <= x <= 8760

Example:

168

maxUses

number

Max uses (0 = unlimited)

Required range: 0 <= x <= 10000

Example:

10

roles

string[]

Roles with permission presets: owner, admin, manager, support, viewer (and legacy view/edit/full).

Maximum array length: 10

Example:

["support"]

customPermissions

string[]

Extra single permissions resource:action (e.g. 'products:write'), wildcards 'orders:' / ''. Granted ON TOP of roles.

Maximum array length: 64

Example:

["orders:read"]

Response

success

boolean

Example:

true

data

object

message

string

Create an invite link

curl --request POST \
  --url https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "expiresInHours": 168,
  "maxUses": 10,
  "roles": [
    "support"
  ],
  "customPermissions": [
    "orders:read"
  ]
}
'

import requests

url = "https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links"

payload = {
    "expiresInHours": 168,
    "maxUses": 10,
    "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({
    expiresInHours: 168,
    maxUses: 10,
    roles: ['support'],
    customPermissions: ['orders:read']
  })
};

fetch('https://api.itemshop.dev/api/v2/shops/{shopId}/team/invite-links', 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/invite-links",
  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([
    'expiresInHours' => 168,
    'maxUses' => 10,
    '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/invite-links"

	payload := strings.NewReader("{\n  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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/invite-links")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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/invite-links")

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  \"expiresInHours\": 168,\n  \"maxUses\": 10,\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/..."
}

Getting started

Basics

Payments

Order fulfillment

Configuration

API Keys

Shops

Servers

Products

Payment Methods

Blacklist

Discounts

Vouchers

Stats

Storage

Orders

Payments

Components

Metrics

Authorizations

Path Parameters

Body

Response