curl --request POST \
--url https://api.exowpee.com/v1/order/cash-registers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cashiers": {
"agent_ids": [
"<string>"
],
"user_profile_ids": [
"<string>"
]
},
"is_seller": true,
"auto_print_invoice": true,
"linear_pos": true
}
'import requests
url = "https://api.exowpee.com/v1/order/cash-registers"
payload = {
"name": "<string>",
"cashiers": {
"agent_ids": ["<string>"],
"user_profile_ids": ["<string>"]
},
"is_seller": True,
"auto_print_invoice": True,
"linear_pos": True
}
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({
name: '<string>',
cashiers: {agent_ids: ['<string>'], user_profile_ids: ['<string>']},
is_seller: true,
auto_print_invoice: true,
linear_pos: true
})
};
fetch('https://api.exowpee.com/v1/order/cash-registers', 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",
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([
'name' => '<string>',
'cashiers' => [
'agent_ids' => [
'<string>'
],
'user_profile_ids' => [
'<string>'
]
],
'is_seller' => true,
'auto_print_invoice' => true,
'linear_pos' => true
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/order/cash-registers")
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 \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"is_seller": true,
"auto_print_invoice": true,
"linear_pos": true,
"is_locked": true,
"session_status": "<string>",
"cash_account_id": "<string>",
"last_closed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cashiers": "<array>"
}{
"message": "<string>",
"errors": {}
}Create a cash register
Creates a new cash register with its cashiers. It starts closed and unlocked with a default cash payment method.
curl --request POST \
--url https://api.exowpee.com/v1/order/cash-registers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cashiers": {
"agent_ids": [
"<string>"
],
"user_profile_ids": [
"<string>"
]
},
"is_seller": true,
"auto_print_invoice": true,
"linear_pos": true
}
'import requests
url = "https://api.exowpee.com/v1/order/cash-registers"
payload = {
"name": "<string>",
"cashiers": {
"agent_ids": ["<string>"],
"user_profile_ids": ["<string>"]
},
"is_seller": True,
"auto_print_invoice": True,
"linear_pos": True
}
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({
name: '<string>',
cashiers: {agent_ids: ['<string>'], user_profile_ids: ['<string>']},
is_seller: true,
auto_print_invoice: true,
linear_pos: true
})
};
fetch('https://api.exowpee.com/v1/order/cash-registers', 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",
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([
'name' => '<string>',
'cashiers' => [
'agent_ids' => [
'<string>'
],
'user_profile_ids' => [
'<string>'
]
],
'is_seller' => true,
'auto_print_invoice' => true,
'linear_pos' => true
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/order/cash-registers")
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 \"name\": \"<string>\",\n \"cashiers\": {\n \"agent_ids\": [\n \"<string>\"\n ],\n \"user_profile_ids\": [\n \"<string>\"\n ]\n },\n \"is_seller\": true,\n \"auto_print_invoice\": true,\n \"linear_pos\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"is_seller": true,
"auto_print_invoice": true,
"linear_pos": true,
"is_locked": true,
"session_status": "<string>",
"cash_account_id": "<string>",
"last_closed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cashiers": "<array>"
}{
"message": "<string>",
"errors": {}
}cash_registers.create
Conditions
- The name must be unique among the company’s registers.
- Cashiers are required: at least one agent account or user profile id, each belonging to the same company and organization.
- Cashiers ids must be 27-character strings without duplicates.
- Creates a ledger account for the register (credit normal balance, in the company currency).
- Creates a cash account named after the register and stores its id as cash_account_id.
- Creates a cash register payment method labelled cash, with no money account.
- Creates a cashier for each listed agent account or user profile, and a seller record for each (active only if is_seller is true).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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, name, is_seller, auto_print_invoice, linear_pos, is_locked, session_status, cash_account_id, last_closed_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: cashiers.
Body
Name of the register, up to 250 characters, unique among the company's registers. Required on creation; optional on update.
250Cashiers to assign. Required on creation, with at least one id; prohibited on update.
Show child attributes
Show child attributes
Whether cashiers of this register are also sellers. Defaults to false on creation; unchanged when omitted on update.
Whether the invoice is printed automatically after a sale. Defaults to false on creation.
Whether the register uses the linear point-of-sale layout. Defaults to false on creation.
Response
Resource (only with response=resource).
Identifier of the cash register (27-character KSUID).
Name of the register, unique within the company.
True when the cashiers of this register are also sellers who can be credited with sales.
True when the point of sale prints the invoice automatically after a sale.
True when the register uses the linear point-of-sale layout; it is copied to the register's seller records.
True when the register is locked and cannot be opened or edited.
Whether a register session is running: open or closed.
Identifier of the cash account created for this register.
Closing time of the most recently opened register session of this register (ISO 8601); null when no register session was ever opened or while that session is still open. Omitted when the register session was not loaded (for example in the public available list).
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).
Cashiers assigned to this register, as summaries with their id.