curl --request POST \
--url https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_ids": [
"<string>"
],
"user_profile_ids": [
"<string>"
]
}
'import requests
url = "https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers"
payload = {
"agent_ids": ["<string>"],
"user_profile_ids": ["<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({agent_ids: ['<string>'], user_profile_ids: ['<string>']})
};
fetch('https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers', 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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers",
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([
'agent_ids' => [
'<string>'
],
'user_profile_ids' => [
'<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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers"
payload := strings.NewReader("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers")
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 \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"cash_register_id": "<string>",
"cashable_id": "<string>",
"status": "<string>",
"cashable": {},
"last_login_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"message": "<string>",
"errors": {}
}Add cashiers to a register
Allows members or agent accounts to work as cashiers on a cash register. A seller record is created for each one.
curl --request POST \
--url https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_ids": [
"<string>"
],
"user_profile_ids": [
"<string>"
]
}
'import requests
url = "https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers"
payload = {
"agent_ids": ["<string>"],
"user_profile_ids": ["<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({agent_ids: ['<string>'], user_profile_ids: ['<string>']})
};
fetch('https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers', 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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers",
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([
'agent_ids' => [
'<string>'
],
'user_profile_ids' => [
'<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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers"
payload := strings.NewReader("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\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.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/order/cash-registers/{cashRegisterId}/cashiers")
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 \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"cash_register_id": "<string>",
"cashable_id": "<string>",
"status": "<string>",
"cashable": {},
"last_login_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"message": "<string>",
"errors": {}
}cashiers.create
Conditions
- The cash register must not be locked.
- At least one identifier must be sent in agent_ids or user_profile_ids.
- Every agent account and user profile must belong to the current company and organization.
- A person who is already a cashier of this register cannot be added again; identifiers must be unique inside each list.
- Creates one active cashier record per person, with no login yet.
- Creates one seller record per person on the same register, copying the register’s linear POS option. The seller is active only when the register has is_seller turned on, otherwise it is created inactive.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the cash register (27-character KSUID string).
Query Parameters
Response mode. Default none; none answers 204 No Content.
none, resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, cash_register_id, cashable_id, status, last_login_at, created_at, updated_at.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: cashable.
Body
Agents to add as cashiers, as 27-character identifiers, each unique. Each must belong to the company and organization and not already be a cashier of this register. At least one of agent_ids or user_profile_ids must hold an identifier.
27User profiles to add as cashiers, as 27-character identifiers, each unique. Same rules as agent_ids.
27Response
Resource (only with response=resource).
Identifier of the cashier record (27-character KSUID string).
Identifier of the register the cashier is attached to.
Identifier of the person who is the cashier: an agent account or a user profile of the company.
Whether the cashier can open the register: active or inactive.
Identity of the person behind the cashier (first_name, last_name, username). Only present when requested with include. An agent account has no username; a user profile carries its member pseudo as username.
Time of the cashier's last register opening, ISO 8601. Null until the cashier has opened a register.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).