Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Insurance
SPI Payment
SPI Product Recommendations
SPI Product Search
SPI RFID
SPI Tax Free
Journals v3
Purchase Prices v3
Shipments v3

POS Profiles

Add POS Profile

post /sites/{site_id}/posprofiles.json

Add a profile to be used by POS devices. Used for configuring specific settings for a group of POS devices or stores.

PARAMETERS
site_id
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter).

REQUEST BODY
object
REQUIRED

A POS profile.

PosProfile
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/posprofiles.json
{
  "name": "Concept Store Profile"
}
RESPONSE JSON
2
HTTP Status Code Summary
200Successful. Returns ID of the added POS profile.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Get POS Profiles

get /sites/{site_id}/posprofiles.json

Returns all POS profiles. Use the fields parameter to query only the fields you are interested in.

PARAMETERS
start
integer
query

The index of the item to start from. Used for pagination.

Default: 0
num
integer
query

Number of items to return.

Default: 10
searchtext
string
query

Search filter matching string fields for a POS Profile.

sort
string
query

Sort the result.

Available values:
  • id
  • -id
  • name
  • -name
  • autologouttimer
  • -autologouttimer
  • logotype
  • -logotype
  • num_registers
  • -num_registers
Default: "id"
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See PosProfile object for all fields.

Default: [ "id", "name", "logotype", "receipt_pre", "receipt_post", "receipt_addbarcodeid", "receipt_showsku", "receipt_item_rendering", "receipt_salestax_rendering", "autologouttimer", "productdisplaymode", "stockstatusdisplaymode", "printreceipt", "printgiftreceipt", "rebuy_reasoncode", "return_policy", "dashboardid", "override_paymenttypes", "custom_metrics", "salesassociate_mode", "shipments_show_costprice", "auto_logout_after_commit", "extra_sign_return_receipt", "pos_inventory_features", "pos_theme_id", "pos_theme_data", "sco_v2_configuration_id", "tax_free_options", "num_registers" ]
site_id
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter).

Returns

Successful. Returns an envelope for PosProfile objects.

PosProfile
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/posprofiles.json?num=1
RESPONSE JSON
{
  "totalcount": 15,
  "items": [
    {
      "id": 1,
      "name": "POS Profile #1",
      "logotype": "my-brand-logo.png",
      "receipt_pre": "www.example.com",
      "receipt_post": "Please come again!",
      "receipt_addbarcodeid": true,
      "receipt_showsku": true,
      "receipt_item_rendering": null,
      "receipt_salestax_rendering": null,
      "autologouttimer": 0,
      "auto_logout_after_commit": false,
      "productdisplaymode": 10,
      "stockstatusdisplaymode": 10,
      "printreceipt": 10,
      "printgiftreceipt": null,
      "rebuy_reasoncode": null,
      "dashboardid": null,
      "override_paymenttypes": [],
      "custom_metrics": null,
      "salesassociate_mode": 10,
      "shipments_show_costprice": false,
      "extra_sign_return_receipt": [],
      "pos_inventory_features": null,
      "pos_theme_id": null,
      "pos_theme_data": null,
      "tax_free_options": null
    }
  ]
}
HTTP Status Code Summary
200Successful. Returns an envelope for PosProfile objects.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Get POS Profile

get /sites/{site_id}/posprofiles/{pos_profile_id}.json

Returns the POS profile for the provided ID.

PARAMETERS
site_id
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter).

pos_profile_id
integer
path
REQUIRED

POS Profile ID.

Returns

Successful. Returns the POS profile for the provided ID.

PosProfile
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/posprofiles/1.json
RESPONSE JSON
{
  "id": 1,
  "name": "POS Profile #1",
  "logotype": "my-brand-logo.png",
  "receipt_pre": "www.example.com",
  "receipt_post": "Please come again!",
  "receipt_addbarcodeid": true,
  "receipt_showsku": true,
  "receipt_item_rendering": null,
  "receipt_salestax_rendering": null,
  "autologouttimer": 0,
  "auto_logout_after_commit": false,
  "productdisplaymode": 10,
  "stockstatusdisplaymode": 10,
  "printreceipt": 10,
  "printgiftreceipt": null,
  "rebuy_reasoncode": null,
  "dashboardid": null,
  "override_paymenttypes": [],
  "custom_metrics": null,
  "salesassociate_mode": 10,
  "shipments_show_costprice": false,
  "extra_sign_return_receipt": [],
  "pos_inventory_features": null,
  "pos_theme_id": null,
  "pos_theme_data": null,
  "tax_free_options": null
}
HTTP Status Code Summary
200Successful. Returns the POS profile for the provided ID.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Update POS Profile

put /sites/{site_id}/posprofiles/{pos_profile_id}.json

Updates the POS profile for the provided ID. Please note that the endpoint will accept a partial object to update only the properties that are sent in the request (like a PATCH). Also note that a call to this endpoint will automatically trigger data synchronisation for all POS clients that are connected to the site, and therefore it is recommended to only make a request for it when there is an actual change needed.

PARAMETERS
site_id
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter).

pos_profile_id
integer
path
REQUIRED

POS Profile ID.

REQUEST BODY
object
REQUIRED

A POS profile.

PosProfile
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/posprofiles/2.json
{
  "name": "Concept Store Profile"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Successful. Returns true.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Delete POS Profile

delete /sites/{site_id}/posprofiles/{pos_profile_id}.json

Deletes the POS profile for the provided ID.

PARAMETERS
site_id
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter).

pos_profile_id
integer
path
REQUIRED

POS Profile ID.

deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/posprofiles/2.json
RESPONSE JSON
true
HTTP Status Code Summary
200Successful. Returns true.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Objects

PosProfile
object

Profile (collection of settings) to be used by POS devices.

PROPERTIES
id
integer
READ ONLY
REQUIRED

ID for the POS profile in Sitoo. NOTE! A POS profile is connected to a POS via the storesettingid property on the POS (Cash Register) object.

Minimum: 1
name
string

Display name for the POS profile in Sitoo. The name cannot be empty and must be unique among POS profiles for a site.

Min Length: 1
logotype
string
nullable

Sitoo resource ID for the logotype image to be used for printed receipts.

Example: ""logo.png""
receipt_pre
string

Content printed in the header of a receipt. Use newline characters to separate lines.

Default: ""
receipt_post
string

Content printed in the footer of a receipt. Use newline characters to separate lines.

Default: ""
receipt_addbarcodeid
boolean

A boolean value indicating if a barcode containing the receipt ID should be printed on the receipt. Using a scanner, the barcode can then be used to initiate a return in the POS.

Default: false
receipt_showsku
boolean

A boolean value indicating if the SKU should be rendered for each product in the cart and printed on receipts. For rendering custom properties for products, please refer to the following properties for the Settings object:

  • customattributes_list
  • customattributes_info
  • customattributes_details
  • customattributes_receipt
Default: false
receipt_item_rendering
integer
nullable

Nullable enum which controls how items and discounts will be rendered on the receipt

  • null Default - One line rendered for each discount
  • 10 Compressed - SKU and variant on same line. All discounts applied on the item will be aggregated, showing the total discount
VALUES
10
receipt_salestax_rendering
integer
nullable

Nullable enum which controls how sales tax will be rendered on the receipt. Only applies to accounts using the Sitoo Sales Tax engine instead of VAT

  • null Default - All applied sales taxes are aggregated and shown as a total value
  • 10 Detailed - One line per applied sales tax
VALUES
10
autologouttimer
integer

The number of seconds of inactivity before a POS user will be automatically logged off. A value of 0 will turn the feature off. Allowed range is 0-1800 seconds.

Default: 0
Minimum: 0
Maximum: 1800
auto_logout_after_commit
boolean

If true, the POS user will be logged off after each completed sale or return.

Default: false
productdisplaymode
integer

Enum value which controls how the product search widget will be displayed in the POS (This setting does not affect the product search page available when using a custom theme for UI).

  • 10 Tiles - Products are displayed as tiles with page views to navigate
  • 20 List - Products are displayed as a list
Default: 10
VALUES
10
20
stockstatusdisplaymode
integer

Enum value which controls how product stock availability will be displayed for products in the POS.

  • 10 Do not show stock status
  • 20 Show stock status
Default: 10
VALUES
10
20
printreceipt
integer

Enum value which controls the option to print purchase/return receipts when completing a transaction. NOTE! Some legal requirements may require that receipts are printed and will therefore override this setting.

  • 10 Print Automatically
  • 20 Print Option - Preselected
  • 30 Print Option - Deselected
Default: 10
VALUES
10
20
30
printgiftreceipt
integer
nullable

Enum value which controls the option to print gift receipts when completing a transaction.

  • 10 Print Automatically
  • 20 Print Option - Preselected
  • 30 Print Option - Deselected
  • 50 Print Option - Specific Products
VALUES
10
20
30
50
rebuy_reasoncode
string
nullable

Set this property with the reasoncode property of the reason code to be used for triggering the rebuy feature when performing a validated return.

Max Length: 32
Min Length: 1
return_policy
ReturnPolicy
nullable

Defines a return policy for return of items in the POS.

dashboardid
string
nullable

Set this property with the ID for the dashboard that should be used in the POS.

Min Length: 1
override_paymenttypes
array
(integer)

Array of POS payment type IDs to be used in the POS. If array is empty, all payment types will be available.

Default: []
custom_metrics
object
nullable

Enter key as property and display name for the custom metrics that it should be possible to enter values for from the POS UI. NOTE! The custom metrics must be pre-configured and exist.

<*>
string
The property name should be the custom metrics `key` property and the value should be the display name to be used in the POS.
salesassociate_mode
integer

Enum value which controls Sales Associate feature in the POS.

  • 10 Feature not active
  • 20 Assign sales associate to entire cart
  • 21 Assign sales associate to entire cart (required to complete purchase)
  • 30 Assign sales associate to specific items
  • 31 Assign sales associate to specific items (required to complete purchase)
Default: 10
VALUES
10
20
21
30
31
shipments_show_costprice
boolean

If true, cost prices will be shown for shipments in the POS. NOTE! Only applies when using Shipments v3.

Default: false
extra_sign_return_receipt
array
(string)

Array of titles for extra signature lines to be printed on return receipts in POS. Duplicate values are not allowed.

Default: []
pos_inventory_features
array
(string/enum)
nullable

NOTE! If this property is set, it will override the pos_inventory_features property in the Settings object. An array of inventory features that should be available in the POS. An empty array means no features are available. A null value indicates that the general settings object property should be used.

  • manual-in Manual In
  • manual-out Manual Out
  • move Move
  • stocktaking Stocktaking
  • shipment-in Inbound Shipments
  • shipment-out Outbound Shipments
VALUES
manual-in
manual-out
move
stocktaking
shipment-in
shipment-out
pos_theme_id
string
nullable

Override of the POS default theme, to be used for the POS UI, set in the Settings object. A null value indicates that the general settings object property should be used.

Min Length: 1
pos_theme_data
object
nullable

Variables used by the POS theme if the pos_theme_id has been configured. The variables are defined by the theme instance and the values can be of type string, integer, number, or boolean.

<*>
object
tax_free_options
array
(string/enum)
nullable

An array of tax free features that should be available in the POS. If set to null, all features will be available, and empty array means no tax free features will be available.

  • tax-free-export Tax Free Export
  • duty-free Duty Free
  • tax-refund Tax Refund
VALUES
tax-free-export
duty-free
tax-refund
num_registers
integer
READ ONLY

Read only field which contains the current number of cash registers that are using this POS Profile.

Minimum: 0

ReturnPolicy
object

Defines a return policy for return of items in the POS.

PROPERTIES
default_days
integer
nullable

The default number of days that items can be returned after a purchase. A value of 0 means that returns are not allowed.

Example: ""30""
Minimum: 0
last_date
string
(date)
nullable

Used to override the default_days with a specific date, for example having a more generous last return date during Christmas sale. This is only applied for purchases done between start_date and end_date.

Example: """2025-01-31"""
start_date
string
(date)
nullable

The start date for a period when the last_date policy should be applied. Required if last_dateis set.

Example: """2024-11-30"""
end_date
string
(date)
nullable

The end date (inclusive) for a period when the last_date policy should be applied. Required if last_dateis set.

Example: """2024-12-25"""
Copyright © 2025 Sitoo AB. All rights reserved.