Locations

Type	Base Path	Trigger Name
REST resource	~{realm}/locations/	locations

This resource holds all sales locations. Cash registers, bookable resources (like dinner tables), tabs, stock balances etc. may be associated with a location. A location also defines how the receipts will look.

Endpoints

Name	Method	Relative Path	Payload	Response	Description
addLocation	POST	~{realm}/locations/	Location	Stored_Location	Adds a new location to the list.
listLocations	GET	~{realm}/locations/	N/A	Stored_Location[]	Retrieves a list of locations.
getLocation	GET	~{realm}/locations/{id}	N/A	Stored_Location	Retrieves a location.
putLocation	PUT	~{realm}/locations/{id}	Location	Stored_Location	Replaces a location.
updateLocation	PATCH	~{realm}/locations/{id}	Partial_Location	Stored_Location	Updates specified location fields.
removeLocation	DELETE	~{realm}/locations/{id}	N/A	N/A	Deletes a location.

Permissions

Permission	Description
edit-locations	Client is allowed to add new locations and to modify or delete existing locations.
show-locations	Client is allowed to query the location list and to fetch individual locations.

Entities

Interface Location

interface Location {
    'name': string;
    'account-config'?: AccountConfig;
    'take-out-config'?: TakeOutConfig;
    'company-name'?: string;
    'address'?: string;
    'phone-number'?: string;
    'web-address'?: string;
    'email'?: string;
    'receipt-header'?: string;
    'receipt-footer'?: string;
    'receipt-logo-mono'?: Base64String;
    'receipt-logo-gray'?: Base64String;
    'customer-screen-logo'?: File;
    'config'?: LocationConfig;
    'id'?: number;
    'created'?: DateTime;
    'updated'?: DateTime;
    'deleted'?: DateTime;
    'updated-by'?: number;
    'updated-from'?: number;
    'tags'?: string[];
    'labels'?: number[];
}

Property	Data Type	Description
name	String	Name of location.
account-config	AccountConfig?	Account configuration overrides for devices bound to this location. See the documentation of the Till entity for a description.
take-out-config	TakeOutConfig?	Take-out/Take-away configuration.
company-name	String?	Company/Store name to be displayed on receipts. If unset, the name from the Company entity is used.
address	String?	Address to be displayed on receipts. If unset, the address from the Company entity is used.
phone-number	String?	Phone number to be displayed on receipts. If unset, the phone-number from the Company entity is used.
web-address	String?	Web address to be displayed on receipts. If unset, the web-address from the Company entity is used.
email	String?	E-mail address to be displayed on receipts. If unset, the email from the Company entity is used.
receipt-header	String?	Optional message to be displayed in the receipt header. May contain multiple lines.
receipt-footer	String?	Optional message to be displayed in the receipt header. May contain multiple lines. If unset, "Welcome back!" will be printed.
receipt-logo-mono	Base64String?	Deprecated. Use receipt-logo instead.
receipt-logo-gray	Base64String?	Deprecated. Use receipt-logo instead.
receipt-logo	File?	An image to be used as receipt logo.
customer-screen-logo	File?	An image to be displayed on customer screens.
config	LocationConfig?	Settings that applies to devices bound to this location only. See below.
id	Int64?	The resource ID of this entity.
created	DateTime?	Date and time when this entity was first created.
updated	DateTime?	Date and time when this entity was last modified.
deleted	DateTime?	Date and time when this entity was deleted.
updated-by	Int64?	ID of User who last modified this entity.
updated-from	Int64?	ID of Till (trusted device) which last modified this entity.
labels	Int64[]?	A list of Label IDs associated with this entity.

Interface LocationConfig

interface LocationConfig {
    'register-customer'?: boolean;
    'customer-screen-registration'?: boolean;
    'auto-close-batch-schedules'?: string[];
    'button-map'?: number;
}

Property	Data Type	Description
register-customer	Boolean?	Remind cashier to register customer information on each transaction.
customer-screen-registration	Boolean?	Enables customer self-registration via the cash register's customer screen.
auto-close-batch-schedules	CronExpr[]?	A location-specific schedule for automatic Z-reports/reconciliations.
button-map	Int64?	A reference to this locations's default button map (if unset, the global default will be used).

Interface TakeOutConfig

interface TakeOutConfig {
    'button-map': number;
    'banner'?: File;
    'logo'?: File;
    'schedules'?: string[];
    'last-order'?: string;
    'order-times'?: string[];
    'customer-message'?: string;
}

Property	Data Type	Description
button-map	Int64	A reference to the button map (with type menu) that specifies the take-out menu.
banner	File?	An image that will be displayed at the top of the order site.
logo	File?	An image/high-resololution icon for the order site. Will also be used to generate the launch image for the order site.
schedules	CronExpr[]?	A schedule that defines when the order site should accept customer orders.
last-order	Duration?	A duration that specifies how long before the order site closes a new order must be placed.
order-times	Duration[]?	A list of durations used on accept order buttons. The times specifies how long it takes to complete an order.
customer-message	String?	A custom message that will be displayed as-is to customers on the order site.

Interface File

interface File {
    'name': string;
    'content-type': string;
    'length': number;
    'blob': Base64String;
}

Property	Data Type	Description
name	String	Name of the file.
content-type	String	MIME type of file.
length	Int64	Length of file, in bytes.
blob	Base64String	Unique file idenfitier calculated from checksums of the the file's content.

See Binary Properties and Direct Property Access for information about how to access the actual content of the file.