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

Settings

Get Settings

get /sites/{site_id}/settings.json

Endpoint for reading settings for a site in Sitoo. Use the fields parameter to query only the fields you are interested in.

PARAMETERS
fields
array (string)
query

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

site_id
integer
path
REQUIRED

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

Returns

Successful. Returns Settings object.

Settings
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/settings.json
RESPONSE JSON
{
  "eshopid": 1,
  "eshopname": "Sitoo Example",
  "eshoptype": "main",
  "emailfrom": "info@example.com",
  "emailfromdisplay": "",
  "doroundoff": false,
  "creditnotesalestype": 20,
  "creditnotevalidmonths": 12,
  "creditnoterequirespin": false,
  "giftcardsalestype": 20,
  "giftcardvalidmonths": 12,
  "giftcardrequirespin": false,
  "giftcardproductids_email": [],
  "giftcardproductids_sms": [],
  "paymenttypeid_split": 36,
  "warehouseid": 2,
  "numdaysreserved": 14,
  "currencycode": "USD",
  "currency_rates": [],
  "timezone": "Europe/Stockholm",
  "pricesstoredwithvat": true,
  "uistrings": {},
  "permissions": {
    "store_manager": {
      "manual_price": "on",
      "validated_return": "on",
      "validated_return_any_payment": "on",
      "manual_return": "on",
      "salestax_exemption": "on",
      "explicit_open_cash_drawer": "on",
      "cash_management": "on",
      "inventory_management": "on"
    },
    "store_staff": {
      "manual_price": "on",
      "validated_return": "on",
      "validated_return_any_payment": "on",
      "manual_return": "on",
      "salestax_exemption": "on",
      "explicit_open_cash_drawer": "on",
      "cash_management": "on",
      "inventory_management": "on"
    }
  },
  "other_delivery_online": "enable_all",
  "other_delivery_stores": "enable_all",
  "cart_item_price_display_mode": "default",
  "cart_print_pick_list_mode": "disabled",
  "cash_counting_mode": "enter-total-amount",
  "bank_bag_id_mode": "disabled",
  "copy_discounts_to_exchange_sale": "enabled",
  "transfer_gift_receipt_customer": "enabled",
  "receipt_staff_display": null,
  "pickup_printout_barcode": "order-id",
  "compress_variant_info": false,
  "limit_open_cash_drawer": false,
  "mixed_delivery_disabled": false,
  "warn_close_with_open_orders": false,
  "scanner_ean13_remove_leading_zero": false,
  "num_days_until_pickup_expires": 7,
  "customattributes_list": [],
  "customattributes_info": [],
  "customattributes_details": [],
  "customattributes_receipt": [],
  "customattributes_in_store_replenishment": [],
  "allow_store_manager_campaigns": false,
  "campaigns_exclude_product_groups": [],
  "dashboard_ignore_product_groups": [],
  "shipment_print_confirmation_receipt": "disabled",
  "shipment_print_delivery_note": "disabled",
  "shipment_auto_generate_barcodes": "disabled",
  "required_fields_booking": [
    "name-first",
    "name-last",
    "phone",
    "email"
  ],
  "required_fields_pickup": [
    "name-first",
    "name-last"
  ],
  "required_fields_delivery": [
    "name-first",
    "name-last"
  ],
  "payments_refund_manual": [],
  "payments_refund_validated": [],
  "payments_refund_validated_omni": [],
  "payments_sales_gift_card": [],
  "payments_sales_non_delivered": [],
  "pin_days_valid": 60,
  "pin_days_warning": 10,
  "pin_hours_offline": 72
}
HTTP Status Code Summary
200Successful. Returns Settings object.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
403User is not authorized to perform operation.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Update Settings

put /sites/{site_id}/settings.json

Endpoint for updating settings for a site in Sitoo. 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).

REQUEST BODY
object
REQUIRED

The Settings object.

Settings
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/settings.json
{
  "cart_item_price_display_mode": "price-to-pay",
  "pin_days_valid": 60,
  "pin_days_warning": 10,
  "pin_hours_offline": 72
}
RESPONSE JSON
true
HTTP Status Code Summary
200Successful. Returns true.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
403User is not authorized to perform operation.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Objects

CrmChannel
object

Settings for a CRM channel.

PROPERTIES
id
string
REQUIRED

The ID of the CRM channel. A unique ID to use for this CRM channel, required together with the customer ID for identifying a customer. Matches the crm-channelid additionaldata set on orders. Note that if the ID for a channel is changed, the secret/password for the handler needs to be provided in the request (if required by the handler), since it will otherwise be lost.

title
string
REQUIRED

The title for the CRM channel. Shown in POS UI when searching for a customer.

client_settings
CrmClientSettings
REQUIRED

POS client settings for the CRM channel.

handler
CrmHandler
REQUIRED

The handler to implement the service for this CRM channel. One (and only one) of the handler properties should be set.

CrmClientSettings
object

POS client settings for a CRM channel.

PROPERTIES
lookup_type
CrmSearchKeyType

The search type to use for performing a CRM Lookup when adding a new customer not found in the CRM. The search type needs to match one of the items in the search_types property.

member_number_title
string

The title presented for the member number in the POS UI (also printed on the customer receipt).

Example: """Member Number"""
hide_age
boolean

A bool indicating if the age of a customer should be hidden in the POS UI (the birthday can still be shown).

search_types
array
(CrmSearchKeyType)
REQUIRED

A list of search types (and the order of them) to be used when searching for a customer in the POS UI. The first one will be default.

fields_add
CrmFieldConfig

Field configuration to be used when adding a new customer.

fields_add_lookup_override
CrmFieldConfig

Field configuration to be used for overriding adding a new customer, when a lookup has been made to pre-fill the form with customer details.

fields_edit
CrmFieldConfig

Field configuration to be used when updating an existing customer.

CrmFieldConfig
object

Configuration for which CRM fields should be used in the POS UI. All properties are optional.

PROPERTIES
email
CrmFieldSetting

Email for a customer.

member_number
CrmFieldSetting

Member number for a customer.

name
CrmFieldSetting

Name of a customer.

personal_id
CrmFieldSetting

Personal ID property for a customer.

company
CrmFieldSetting

Company name for a customer.

company_id
CrmFieldSetting

Company ID for a customer.

mobile
CrmFieldSetting

Mobile phone for a customer.

phone
CrmFieldSetting

Phone property for a customer.

invoice_address
CrmFieldSetting

Invoice address for a customer.

delivery_address
CrmFieldSetting

Delivery address for a customer.

gender
CrmFieldSetting

Gender of a customer.

birthday
CrmFieldSetting

Birthday of a customer.

accepts_email
CrmFieldSetting

Preference for accepting email for a customer.

accepts_sms
CrmFieldSetting

Preference for accepting SMS for a customer.

accepts_mail
CrmFieldSetting

Preference for accepting postal correspondence for a customer.

consents
CrmFieldSetting

Consents for a customer.

additional_options
CrmFieldSetting

Additional options for a customer.

CrmFieldSetting
string

An enum to decide how a CRM fields should be presented in the POS UI.

  • editable Field is shown and editable
  • editable_required Field is shown, editable and required
  • readonly Field is shown, but NOT editable
  • hidden Field is NOT shown, but sent in request to backend API

CrmHandler
object

An object defining which handler is to be used for a CRM channel. One, and only one of the properties must be set. NOTE! crm_v1 has been deprecated and when implementing a custom CRM, the crm_v2 handler should be used.

PROPERTIES
sitoo
CrmHandlerSitoo

Handler when using Sitoo Users API as CRM.

voyado
CrmHandlerVoyado

Handler when using Voyado as CRM (with built-in integration by Sitoo).

crm_v1
CrmHandlerSpi

Handler when using a CRM SPI v1 (deprecated).

crm_v2
CrmHandlerSpi

Handler when using a CRM SPI v2. See documentation here.

CrmHandlerSitoo
object

Handler when using Sitoo users as CRM.

PROPERTIES
active
boolean
REQUIRED

Set this value to true to activate Sitoo CRM handler.

CrmHandlerSpi
object

Handler when using a CRM Service Provider Interface (SPI).

PROPERTIES
api_url
string
REQUIRED

Base URL for API service implementation.

token
string
WRITE ONLY
REQUIRED

API Token (basic authentication header) for the SPI (e.g. Authorization: Basic <token>).

CrmHandlerVoyado
object

Handler when using Voyado as CRM (with built-in integration by Sitoo).

PROPERTIES
api_url
string
REQUIRED

Base URL for Voyado API.

api_key
string
WRITE ONLY
REQUIRED

API Key for accessing Voyado API.

locale
string
REQUIRED

Locale used for the Voyado API.

Example: """"sv-SE""""
currency_code
string
REQUIRED

Currency code (ISO 4217, alpha-3 uppercased).

Example: """"SEK""""
contact_type
string
nullable

Contact type to be used in Voyado (See Voyado documentation for valid values).

voucher_passwords_default
array
(string)

An array of Sitoo campaign (voucher) passwords to be applied when a customer is added to the cart in the POS.

voucher_passwords_from_labels
array
(object)

Mapping from Voyado labels to Sitoo campaign (voucher) passwords to be used for the customer being added to the cart in the POS.

PROPERTIES
label_name
string

Label name in Voyado.

voucher_passwords
array
(string)

An array of Sitoo campaign (voucher) passwords to be applied for the customer.

sections
array
(object)

An array of information sections to be displayed when viewing customer information in the POS.

PROPERTIES
title
string

The title to be displayed for the section.

fields
array
(CrmVoyadoSectionFieldMapping)

An array of fields to be displayed for this section.

CrmSearchKeyType
string

The type of search for the CRM.

  • personal_id Personal identifier
  • mobile Mobile phone number
  • email Email address
  • member_number Member number
  • company_id Company identifier

CrmSelfCheckout
object

Settings for self checkout in the POS.

PROPERTIES
crm_channel_id
string
REQUIRED

The ID of the CRM channel to be used for self checkout.

button_text
string
REQUIRED

Text to be displayed on the CRM button.

button_text_logged_in
string
REQUIRED

Text to be displayed on the CRM button when a customer has been added.

dialog_title
string
REQUIRED

Title to be used for the self checkout dialog.

dialog_field_placeholder
string
REQUIRED

Placeholder text to show for the customer to enter information to identify themselves.

dialog_description
string
REQUIRED

Description to show for the customer to enter information to identify themselves.

message_no_offer
string
REQUIRED

Message shown to the customer when no campaigns or bonus checks are available.

CrmVoyadoSectionFieldMapping
object

An object used to map information in Voyado to section fields in Sitoo.

PROPERTIES
title
string
REQUIRED

Title to be shown for the property.

attribute
string
REQUIRED

Attribute in Voyado from which to get the value to be displayed.

display_true
string
nullable

If set, this string will be shown instead of the value (if there is a value for the property).

display_false
string
nullable

If set, this string will be shown instead of a non value (or a value interpreted as false).

CustomAttributeMapping
object

An object used to indicate mapping between product custom attributes and how they should be displayed.

PROPERTIES
id
string
REQUIRED

The ID of the custom attribute.

show_title
boolean
REQUIRED

Boolean value indicating whether to display the title for the value or not.

additionaldata_name
string

Optional additional data name used to put the value for the custom attribute on the receipt and order. Only used for the customattributes_receipt property.

Error
object

PROPERTIES
statuscode
integer
REQUIRED

A status code for the error. Usually HTTP status code.

errortext
string
REQUIRED

A textual description of the error.

errorcode
string

An optional internal code for the error.

ExchangeRate
string

An exchange rate value (8 fixed decimal points).

Pattern: ^[0-9]+\.[0-9]{8}$
Example: "12.34560000"

Money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$
Example: "123.00"

OtherDeliveryOption
string

The option for which type of other delivery should be available.

  • enable_all Enable All - Both Pickup and Delivery are available
  • pickup Pickup Only - Only Pickup is available
  • delivery Delivery Only - Only Delivery is available
  • disable Disabled - The function for other delivery is turned off

PosOrderField
string

Order field to be required.

  • name-first First name
  • name-last Last lame
  • phone Phone number
  • email Email address
  • phone-or-email Phone number or email address (at least one will be required)

PosPermissionOptionLevel
string

The level for a permission option.

  • on Allowed
  • on_self_auth Requires PIN
  • on_dual_auth Requires two PIN
  • off Not Allowed

PosPermissionOptions
object

Object containing permission levels for different features in the POS.

PROPERTIES
manual_price
PosPermissionOptionLevel

Permission to perform manual price adjustments in the POS.

validated_return
PosPermissionOptionLevel

Permission to perform validated returns in the POS.

validated_return_any_payment
PosPermissionOptionLevel

Permission to use all (including unvalidated) payment options when performing validated returns in the POS. NOTE! Only allows options on and off.

manual_return
PosPermissionOptionLevel

Permission to perform manual (unvalidated) returns in the POS.

salestax_exemption
PosPermissionOptionLevel

Permission to remove sales tax from the cart in the POS. NOTE! Only allows options on and off.

explicit_open_cash_drawer
PosPermissionOptionLevel

Permission to use functions for explicitly opening the cash drawer in the POS. NOTE! Only allows options on and off.

cash_management
PosPermissionOptionLevel

Permission to use cash management features in the POS. This includes withdrawal and deposit of cash and also closing of the cash register.

inventory_management
PosPermissionOptionLevel

Permission to use inventory management features in the POS.

PosPermissions
object

POS Permissions for store manager and store staff.

PROPERTIES
store_manager
PosPermissionOptions
REQUIRED

The permission to be used for store managers (and above).

store_staff
PosPermissionOptions
REQUIRED

The permission to be used for store staff.

PosUi
object

POS UI Configuration.

PROPERTIES
order_list_tags
array
(PosUiOrderListTag)
REQUIRED

Array of tags to put on orders when displayed in lists.

order_detail_tags
array
(PosUiOrderDetailTag)
REQUIRED

Array of tags to put on orders when displayed in detailed view.

PosUiColor
string

Color used for a tag.

  • black Black
  • gray Gray
  • red Red
  • green Green
  • blue Blue
  • orange Orange

PosUiOrderDetailTag
object

An object defining which order additional data property and what color should be used to display a tag.

PROPERTIES
title
string
REQUIRED

The title to be displayed for the additional data property.

additional_data_field
string
REQUIRED

The name of the additional data property of the order to get the display value for the tag from.

color
PosUiColor
REQUIRED

The color to use for the tag.

PosUiOrderListTag
object

An object defining which order additional data property and what color should used to display a tag.

PROPERTIES
additional_data_field
string
REQUIRED

The name of the additional data property of the order to get the display value for the tag from.

color
PosUiColor
REQUIRED

The color to use for the tag.

Settings
object

A settings object.

PROPERTIES
eshopid
integer
READ ONLY

The site (eshop) ID for these settings.

eshopname
string

The name of the site (organisation).

eshoptype
string

The type of the site (organisation).

  • main A main site (default)
  • franchise A franchise site
  • common A common site used for shared resources (products, prices, ...) for franchise sites
VALUES
main
franchise
common
commoneshopid
integer
nullable

Reference to a common site used for franchise organisations to share a common set of products and prices.

emailfrom
string
(email)

The sender email address used for sending digital receipts, delivery notes and order confirmations.

emailfromdisplay
string

The sender name used for sending digital receipts, delivery notes and order confirmations.

doroundoff
boolean

If set to true, then roundoff will be applied to orders added in the API. It is recommended to have this value set to false.

creditnotesalestype
integer

The sales type for credit notes.

  • 10 Custom - Manual handling.
  • 20 Vouchers - Credit Note will be printed on the receipt printer
  • 30 Pre-printed cards - Activated at time of sale
VALUES
10
20
30
creditnotevalidmonths
integer
nullable

The number of months that a credit note should be valid. NOTE! Only applies to Sitoo Credit Notes.

creditnoterequirespin
boolean

A boolean value indicating whether PIN is required to redeem a credit note.

giftcardsalestype
integer

The sales type for gift cards.

  • 10 Custom - Manual handling. (No gift cards are created by the cash register)
  • 20 Vouchers - Voucher for gift card will be printed on the receipt printer
  • 30 Pre-printed cards - Activated at time of sale
VALUES
10
20
30
giftcardvalidmonths
integer
nullable

The number of months that a gift card should be valid. NOTE! Only applies to Sitoo Gift Cards.

giftcardrequirespin
boolean

A boolean value indicating whether PIN is required to redeem a gift card.

giftcardproductids_email
array
(integer)
nullable

Array of Sitoo Product IDs to be used for when delivering gift cards using email.

giftcardproductids_sms
array
(integer)
nullable

Array of Sitoo Product IDs to be used for when delivering gift cards using SMS.

productid_downpayment
integer
nullable

ID for product used to register down payment purchases.

paymenttypeid_split
integer
nullable

ID for payment type used to handle sale and return in the same transaction. (Only cash and custom methods are allowed).

warehouseid
integer

Default warehouse ID. Also used for orders where warehouseid property is null.

numdaysreserved
integer
nullable

The number of days that products should be reserved from stock when put in bookings and non-delivered orders.

currencycode
string

Default currency code for this site (ISO 4217, alpha-3 uppercased).

Example: ""SEK""
currency_rates
array
(object)

Array of currencies and their conversion rates against the default currency for the site.

Example: "[ { "code": "EUR", "rate": "11.92890000" } ]"
PROPERTIES
code
string

Currency code (ISO 4217, alpha-3 uppercased).

rate
ExchangeRate

The exchange rate for the specified currency in comparison to the default currency (i.e. how much will 1 of the specified currency be exchanged to in the default currency). Example when having SEK as the default currency would exchange as 1 EUR = 11.9289 SEK (rate = "11.92890000").

timezone
string

The default time zone for the site (https://www.iana.org/time-zones).

Example: ""Europe/Stockholm""
pricesstoredwithvat
boolean
READ ONLY

Flag indicating if the prices are stored including VAT for this site. (A value of false for this property is deprecated).

uistrings
object

A mapping of properties custom1-5 for the product to be used in the POS. A non-empty value will show as the title for the property.

product_custom1
string

Title to be used for displaying product property custom1 in the POS.

product_custom2
string

Title to be used for displaying product property custom2 in the POS.

product_custom3
string

Title to be used for displaying product property custom3 in the POS.

product_custom4
string

Title to be used for displaying product property custom4 in the POS.

product_custom5
string

Title to be used for displaying product property custom5 in the POS.

permissions
PosPermissions

POS permissions used to control different use cases in the POS.

other_delivery_online
OtherDeliveryOption

Option in POS for handling other delivery to online stores.

other_delivery_stores
OtherDeliveryOption

Option in POS for handling other delivery to stores.

cart_item_price_display_mode
string

Option for how cart item price should be displayed in the cart.

  • default Default - Displays the total price of the cart item before applied discounts
  • price-to-pay Price To Pay - Displays the price of the cart item after discounts have been applied
VALUES
default
price-to-pay
cart_print_pick_list_mode
string

Option for printing a pick list for the items in the cart.

  • disabled Disabled
  • active Active - Functionality for printing a pick list is active
VALUES
disabled
active
cash_counting_mode
string

Option for how to count cash in the POS.

  • enter-total-amount Enter total amount
  • count-denominations-optional Count denominations (optional)
  • count-denominations-required Count denominations (required)
VALUES
enter-total-amount
count-denominations-optional
count-denominations-required
bank_bag_id_mode
string

Option to indicate how to use bank bag identifiers when closing the cash register and withdrawing cash to bank.

  • disabled Not used
  • optional Optional
  • required Required
VALUES
disabled
optional
required
copy_discounts_to_exchange_sale
string

When performing an exchange sale (during a return of a previous purchase), this option controls the possibility to copy vouchers and discounts from the original sales to new sale.

  • disabled Disabled
  • enabled Enabled - Discounts and vouchers can be selectively copied to exchange sale
Default: "enabled"
VALUES
disabled
enabled
transfer_gift_receipt_customer
string

Option to add customer from original sale to return and exchange sale, if a gift receipt is used as basis for the return.

  • disabled Do not transfer customer
  • enabled Transfer customer
Default: "enabled"
VALUES
disabled
enabled
receipt_staff_display
string
nullable

Select how the staff should be displayed on the receipt. The option examples within parenthesis are generated using a staff named "John Doe" with external ID "123456".

  • null Default - The first name on a customer receipt and first and last name on the store copy.
  • externalid:64 Option 1 (123456)
  • firstname:2+lastname:2 Option 2 (JODO)
  • firstname:2+lastname:2+externalid:1 Option 3 (JODO1)
  • firstname:2+lastname:2+externalid:-1 Option 4 (JODO6)
  • firstname:2+lastname:2+externalid:2 Option 5 (JODO12)
  • firstname:2+lastname:2+externalid:-2 Option 6 (JODO56)
  • firstname:2+lastname:2+externalid:3 Option 7 (JODO123)
  • firstname:2+lastname:2+externalid:-3 Option 8 (JODO456)
VALUES
externalid:64
firstname:2+lastname:2
firstname:2+lastname:2+externalid:1
firstname:2+lastname:2+externalid:-1
firstname:2+lastname:2+externalid:2
firstname:2+lastname:2+externalid:-2
firstname:2+lastname:2+externalid:3
firstname:2+lastname:2+externalid:-3
pickup_printout_barcode
string

Option for which order identifier should be used for the barcode that is printed on pick lists for pickup.

  • order-id Sitoo Order ID
  • external-id External Order ID
VALUES
order-id
external-id
compress_variant_info
boolean

Compress the product variant information added to order items to not include the title. Example: "Size: Large" will become "Large".

limit_open_cash_drawer
boolean

Limit the automatic opening of the cash drawer to only open when cash has been used as tender.

mixed_delivery_disabled
boolean

Disable mixed mode for delivery status of items in the cart. If set to true, then all items in the cart have to be either "delivered" or "not delivered".

warn_close_with_open_orders
boolean

Show a warning when closing a POS which has open orders (Parked/Bookings).

scanner_ean13_remove_leading_zero
boolean

Convert EAN-13 codes with a leading zero to UPC-A format when using built-in iOS camera as scanner.

num_days_until_pickup_expires
integer

Number of days until a store pickup is considered to be overdue.

customattributes_list
array
(CustomAttributeMapping)

The attributes that should be shown in the product list of the POS and whether to display the title or not.

customattributes_info
array
(CustomAttributeMapping)

The attributes that should be shown in the product info view of the POS and whether to display the title or not.

customattributes_details
array
(CustomAttributeMapping)

The attributes that should be shown in the additional information view of the POS.

customattributes_receipt
array
(CustomAttributeMapping)

The attributes that should be shown for products on receipts and whether to display the title or not.

customattributes_in_store_replenishment
array
(string)

Custom product attributes available for display in the "In Store Replenishment" feature in the back office.

allowed_sites_booking
array
(integer)
nullable

Array of eshop ID for sites allowed to create bookings against.

allowed_sites_delivery
array
(integer)
nullable

Array of eshop ID for sites allowed to create delivery orders against.

allow_store_manager_campaigns
boolean

Flag indicating if store managers should be allowed to create local campaigns.

campaigns_exclude_product_groups
array
(integer)

Array of product group IDs (vatid). Products belonging to these product groups will be excluded from campaigns/discounts in the POS.

dashboard_ignore_product_groups
array
(integer)

Array of product group IDs (vatid) that should be excluded from dashboard calculations. The POS will add the additionaldata property "dashboard-ignore": "true" to the receipt and order items.

shipment_print_confirmation_receipt
string

Option to use for printing a confirmation slip when receiving items for a shipment. The printout will contain the received items and their respective quantities.

  • disabled Not Used
  • deselected Print Option - Deselected
  • preselected Print Option - Preselected
  • auto Print Automatically
VALUES
disabled
deselected
preselected
auto
shipment_print_delivery_note
string

Option to use for printing delivery note when confirming an outbound shipment.

  • disabled Not Used
  • deselected Print Option - Deselected
  • preselected Print Option - Preselected
  • auto Print Automatically
VALUES
disabled
deselected
preselected
auto
shipment_auto_generate_barcodes
string

Option for automatically generating barcodes for shipment and packages where they have not been provided when confirming an outbound shipment.

  • disabled Disabled
  • active Active - Functionality for generating barcodes for shipment is active
VALUES
disabled
active
pos_inventory_features
array
(string/enum)
nullable

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

  • 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

POS default theme to be used for the POS UI. The theme can be overridden for specific POS profiles.

pos_theme_data
object
nullable

Variables used by the default POS theme (as specified in the theme instance).

<*>
object
required_fields_booking
array
(PosOrderField)

Array of required fields when creating a booking.

required_fields_pickup
array
(PosOrderField)

Array of required fields when creating a pickup order.

required_fields_delivery
array
(PosOrderField)

Array of required fields when creating a delivery order.

payments_refund_manual
array
(integer)

Array of payments allowed for Manual Returns - Used when total to pay is negative and the return is non-validated (manual).

payments_refund_validated
array
(integer)

Array of payments allowed for Validated Returns - Used when total to pay is negative and the return is validated.

payments_refund_validated_omni
array
(integer)

Array of payments allowed for Validated Returns for Web Orders - Used when total to pay is negative and the return is validated, on order which has not been created by a Sitoo POS.

payments_sales_gift_card
array
(integer)

Array of payments allowed for Gift Card Sales - Used when total to pay is greater than or equal to 0 and cart includes item with product of type "Gift Card".

payments_sales_non_delivered
array
(integer)

Array of payments allowed for Non-delivered Sales - Used when total to pay is greater than or equal to 0 and cart includes an item which is marked as "not delivered".

pin_days_valid
integer

Number of days that a newly created PIN will be valid for. NOTE! This setting is only valid when authentication with OIDC or Sitoo Login is used to access the POS.

pin_days_warning
integer

Number of days before the POS will start giving a warning about when the PIN expires. A value of 0 will result in no warning. This value should be set to a value lower than pin_days_valid. NOTE! This setting is only valid when authentication with OIDC or Sitoo Login is used to access the POS.

pin_hours_offline
integer

Number of hours that the PIN is allowed to be used when the POS is offline. Set to 0 for no limit. NOTE! This setting is only valid when authentication with OIDC or Sitoo Login is used to access the POS.

crm
object
nullable

CRM configuration for the POS.

channels
array
(CrmChannel)
REQUIRED

Array of CRM channels to be used by the POS.

self_checkout
CrmSelfCheckout

Self checkout configuration.

web_apps
array
(WebApp)

An array with the web apps to be used in the POS.

tax_free_export
TaxFreeExport
nullable

Configuration for the Tax Free Export feature.

duty_free
TaxFreeDutyFree
nullable

Configuration for the Duty Free feature.

ui
PosUi
nullable

Configuration for POS UI.

TaxFreeCustomerFieldSetting
string

Setting for Tax Free Customer field to be collected.

  • editable Field available, but not required
  • editable_required Required field

TaxFreeDutyFree
object

Configuration for the Duty Free feature.

PROPERTIES
countries_allowed
array
(string)

An array of country IDs for which the feature should be allowed (ISO 3166-1, alpha-2 uppercased).

countries_not_allowed
array
(string)

An array of country IDs for which the feature should NOT be allowed (ISO 3166-1, alpha-2 uppercased).

customer_info_collected
object
nullable

An object defining which customer fields should be collected for the Duty Free feature.

name
TaxFreeCustomerFieldSetting

The name of the customer.

email
TaxFreeCustomerFieldSetting

The email for the customer.

phone
TaxFreeCustomerFieldSetting

The phone number for the customer.

delivery_address
TaxFreeCustomerFieldSetting

The delivery address for the customer.

country
TaxFreeCustomerFieldSetting

The country for the customer.

flight_number
TaxFreeCustomerFieldSetting

The flight number for the customer.

customer_info_receipt
array
(string/enum)

Array of collected customer information that should also be printed on the receipt.

  • name Full name
  • email Email address
  • phone Phone number
  • delivery_address Delivery address
  • country Country
  • flight_number Flight Number
VALUES
name
email
phone
delivery_address
country
flight_number

TaxFreeExport
object

Configuration for the Tax Free Export feature.

PROPERTIES
order_warehouse_id
integer
nullable

Warehouse ID of the warehouse that should be set for the order created by the feature. A value of null will use the register warehouse ID for the order.

countries_allowed
array
(string)

An array of country IDs for which the feature should be allowed (ISO 3166-1, alpha-2 uppercased).

countries_not_allowed
array
(string)

An array of country IDs for which the feature should NOT be allowed (ISO 3166-1, alpha-2 uppercased).

Timestamp
integer

Number of seconds since the Unix Epoch.

WebApp
object

An object defining a web app to be used within the POS. Note that when changing the URL for a web app, any secret previously stored for it will be removed. If a secret is required for the web app, it needs to be provided in the request when changing URL.

PROPERTIES
url
string
REQUIRED

URL for the web app. Needs to be unique within the array of web apps.

secret
string
nullable
WRITE ONLY

Secret used for handling authentication/authorization in the web app.

menu
object
REQUIRED

Object describing how the web app should appear in the menu of the POS.

title
string
REQUIRED

The title of the menu button. Slash ('/') character can be used to create sub menus for the app.

Copyright © 2024 Sitoo AB. All rights reserved.