Create a terminal reader
curl --request POST \
--url https://api.yorlet.com/v1/terminal/readers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"registration_code": "<string>",
"label": "<string>",
"location": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/terminal/readers"
payload = {
"registration_code": "<string>",
"label": "<string>",
"location": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({registration_code: '<string>', label: '<string>', location: '<string>'})
};
fetch('https://api.yorlet.com/v1/terminal/readers', 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.yorlet.com/v1/terminal/readers",
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([
'registration_code' => '<string>',
'label' => '<string>',
'location' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.yorlet.com/v1/terminal/readers"
payload := strings.NewReader("{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.yorlet.com/v1/terminal/readers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/terminal/readers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "terminal.reader",
"device_type": "<string>",
"label": "<string>",
"location": {
"id": "<string>",
"created": 123,
"object": "terminal.location",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"display_name": "<string>",
"marketing": {
"brand": {
"color": "<string>",
"icon": "<string>"
},
"description": "<string>",
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"subtype": "bar",
"type": "food_and_beverage",
"account": "<string>",
"deleted": false,
"metadata": {}
},
"serial_number": "<string>",
"account": "<string>",
"deleted": false
}Terminal Readers
Create a terminal reader
Create a terminal reader.
POST
/
v1
/
terminal
/
readers
Create a terminal reader
curl --request POST \
--url https://api.yorlet.com/v1/terminal/readers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"registration_code": "<string>",
"label": "<string>",
"location": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/terminal/readers"
payload = {
"registration_code": "<string>",
"label": "<string>",
"location": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({registration_code: '<string>', label: '<string>', location: '<string>'})
};
fetch('https://api.yorlet.com/v1/terminal/readers', 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.yorlet.com/v1/terminal/readers",
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([
'registration_code' => '<string>',
'label' => '<string>',
'location' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.yorlet.com/v1/terminal/readers"
payload := strings.NewReader("{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.yorlet.com/v1/terminal/readers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/terminal/readers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"registration_code\": \"<string>\",\n \"label\": \"<string>\",\n \"location\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "terminal.reader",
"device_type": "<string>",
"label": "<string>",
"location": {
"id": "<string>",
"created": 123,
"object": "terminal.location",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"display_name": "<string>",
"marketing": {
"brand": {
"color": "<string>",
"icon": "<string>"
},
"description": "<string>",
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"subtype": "bar",
"type": "food_and_beverage",
"account": "<string>",
"deleted": false,
"metadata": {}
},
"serial_number": "<string>",
"account": "<string>",
"deleted": false
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
application/json
A code generated on the reader used to pair it with this account.
Minimum string length:
1Custom label given to the reader for easier identification.
Minimum string length:
1The ID of the location the reader is registered to.
Minimum string length:
1Response
200 - application/json
Create a terminal reader
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
terminal.reader The model of the device.
Custom label given to the reader for easier identification.
The location the reader is registered to.
Show child attributes
Show child attributes
Serial number of the reader.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?