Create an employee

curl --request POST \
  --url https://api.vori.com/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "authentication_rule": {
    "methods": []
  },
  "badge_barcode": null,
  "email_address": null,
  "pin": null,
  "roles": [
    {
      "name": "manager",
      "store_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.vori.com/v1/employees"

payload = {
    "first_name": "<string>",
    "last_name": "<string>",
    "authentication_rule": { "methods": [] },
    "badge_barcode": None,
    "email_address": None,
    "pin": None,
    "roles": [
        {
            "name": "manager",
            "store_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    last_name: '<string>',
    authentication_rule: {methods: []},
    badge_barcode: null,
    email_address: null,
    pin: null,
    roles: [{name: 'manager', store_id: '<string>'}]
  })
};

fetch('https://api.vori.com/v1/employees', 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.vori.com/v1/employees",
  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([
    'first_name' => '<string>',
    'last_name' => '<string>',
    'authentication_rule' => [
        'methods' => [
                
        ]
    ],
    'badge_barcode' => null,
    'email_address' => null,
    'pin' => null,
    'roles' => [
        [
                'name' => 'manager',
                'store_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.vori.com/v1/employees"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.vori.com/v1/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "authentication_rule": {
    "methods": [
      "barcode"
    ],
    "operator": "and"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "editable": true,
  "email_address": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "roles": [
    {
      "id": "<string>",
      "name": "everyone",
      "store_id": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "virtual": true,
  "badge_barcode": "<string>",
  "pin": "<string>"
}

{
  "error_code": "pin_already_assigned"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

POST

employees

Create an employee

curl --request POST \
  --url https://api.vori.com/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "authentication_rule": {
    "methods": []
  },
  "badge_barcode": null,
  "email_address": null,
  "pin": null,
  "roles": [
    {
      "name": "manager",
      "store_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.vori.com/v1/employees"

payload = {
    "first_name": "<string>",
    "last_name": "<string>",
    "authentication_rule": { "methods": [] },
    "badge_barcode": None,
    "email_address": None,
    "pin": None,
    "roles": [
        {
            "name": "manager",
            "store_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    last_name: '<string>',
    authentication_rule: {methods: []},
    badge_barcode: null,
    email_address: null,
    pin: null,
    roles: [{name: 'manager', store_id: '<string>'}]
  })
};

fetch('https://api.vori.com/v1/employees', 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.vori.com/v1/employees",
  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([
    'first_name' => '<string>',
    'last_name' => '<string>',
    'authentication_rule' => [
        'methods' => [
                
        ]
    ],
    'badge_barcode' => null,
    'email_address' => null,
    'pin' => null,
    'roles' => [
        [
                'name' => 'manager',
                'store_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.vori.com/v1/employees"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.vori.com/v1/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"authentication_rule\": {\n    \"methods\": []\n  },\n  \"badge_barcode\": null,\n  \"email_address\": null,\n  \"pin\": null,\n  \"roles\": [\n    {\n      \"name\": \"manager\",\n      \"store_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "authentication_rule": {
    "methods": [
      "barcode"
    ],
    "operator": "and"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "editable": true,
  "email_address": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "roles": [
    {
      "id": "<string>",
      "name": "everyone",
      "store_id": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "virtual": true,
  "badge_barcode": "<string>",
  "pin": "<string>"
}

{
  "error_code": "pin_already_assigned"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Values for creating an employee.

first_name

string

required

Employee's first name.

last_name

string

required

Employee's last name.

authentication_rule

object | null

How the employee signs in at the point of sale, or null to sign in with a PIN. Every method the rule names must have its credential set on the employee.

Show child attributes

badge_barcode

string | null

Barcode on the badge the employee scans to sign in at the point of sale, or null for none. Unique within the banner. A deactivated employee cannot hold one unless the same request reactivates them.

email_address

string<email> | null

Employee's email address, or null for none. Unique within the banner.

Maximum string length: 254

string | null

Numeric PIN the employee enters to sign in at the point of sale, or null for none. Six digits, and unique within the banner. A deactivated employee cannot hold one unless the same request reactivates them.

Required string length: 6

Pattern: ^[0-9]+$

roles

object[]

Roles the employee holds. Supplying this replaces every role the employee holds.

Maximum array length: 200

Show child attributes

Response

A staff member at a store, to whom point-of-sale activity can be attributed.

string

required

Unique identifier for the record.

authentication_rule

object | null

required

Effective rule that determines how the employee authenticates at the POS.

Show child attributes

created_at

string<date-time>

required

When the record was created.

deactivated_at

string<date-time> | null

required

When the employee was deactivated, or null when the employee is active.

editable

boolean

required

Whether the employee can be changed. Employees Vori creates and manages are not editable.

email_address

string<email> | null

required

Employee's email address, or null when none is configured.

Maximum string length: 254

first_name

string

required

Employee's first name.

last_name

string

required

Employee's last name.

roles

object[]

required

Roles assigned to the employee.

Show child attributes

updated_at

string<date-time>

required

When the record was last changed.

virtual

boolean

required

Whether the employee exists only to attribute orders and cannot sign in at a terminal.

badge_barcode

string | null

Barcode on the badge the employee scans to sign in at the point of sale, or null when none is configured. Returned only when requested with include=badge_barcode by a caller holding the employees:read_credentials permission, and absent from the response otherwise.

string | null

Numeric PIN used by the employee for POS authentication, or null when none is configured. Returned only when requested with include=pin by a caller holding the employees:read_credentials permission, and absent from the response otherwise.

Required string length: 6

Pattern: ^[0-9]+$