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

Plugins

Get Plugin Settings

get /sites/{site_id}/plugins/{plugin_id}/settings.json

Endpoint for reading settings for a plugin in Sitoo. The plugin_id parameter indicates which plugin to get settings for.

PARAMETERS
site_id
integer
path
REQUIRED

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

plugin_id
string
path
REQUIRED

Plugin ID, indicates which plugin that is addressed in the request. See PluginId for mapping.

PluginId
Returns

Successful. Returns a specific PluginSettings object depending on the plugin ID.

PluginSettings
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/plugins/taxfree/settings.json
RESPONSE JSON
{
  "id": "taxfree",
  "active": false
}
HTTP Status Code Summary
200Successful. Returns a specific PluginSettings object depending on the plugin ID.
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 Plugin Settings

put /sites/{site_id}/plugins/{plugin_id}/settings.json

Endpoint for updating settings for a plugin in Sitoo. The plugin_id parameter indicates which plugin to update settings for. 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 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).

plugin_id
string
path
REQUIRED

Plugin ID, indicates which plugin that is addressed in the request. See PluginId for mapping.

PluginId
REQUEST BODY
object
REQUIRED

Object containing a specific object depending on the plugin ID.

PluginSettings
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/plugins/taxfree/settings.json
{
  "id": "taxfree",
  "active": false
}
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

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.

Money
string

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

PluginAdyenApi
object

Settings for Adyen API.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (adyenapi).

Default: "adyenapi"
merchantaccount
string
nullable

Merchant Account in Adyen.

keyidentifier
string
nullable

Key Identifier for encrypted communication with Adyen Terminal API.

keypassphrase
string
nullable
WRITE ONLY

Key Passphrase for encrypted communication with Adyen Terminal API.

keyversion
integer
nullable

Key Version for encrypted communication with Adyen Terminal API.

istestmode
boolean

Boolean indicating whether to run Adyen Terminal API in test mode.

Default: false

PluginAdyenTapToPay
object

Settings for Adyen Tap to Pay.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (adyentaptopay).

Default: "adyentaptopay"
merchant_account
string
nullable

Merchant Account in Adyen.

api_key
string
nullable
WRITE ONLY

Key for Adyen API.

is_test_mode
boolean

Boolean indicating whether to run Adyen Tap to Pay in test mode.

Default: false

PluginCtuNorway
object

Settings for CTU Norway.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (ctunorway).

Default: "ctunorway"
companyId
string

The registered company identification number for Norway.

companyName
string

Name of tax responsible company.

currencyCode
string

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

taxRegistrationNumber
string
nullable

VAT Number in Norway if applicable. (Organization number from The Brønnøysund Register Centre followed by "MVA", e.g. 999999999MVA).

taxRegistrationCountry
string

The tax country code. Use "NO" for Norway.

dateFiscalFirst
Timestamp
nullable

Date for start of the first fiscal year for the company (used to calculate the current fiscal year for the report).

dateFiscalSecond
Timestamp
nullable

Date for start of the second fiscal year for the company (used to calculate the current fiscal year for the report).

PluginCtuPortugal
object

Settings for CTU Portugal.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (ctuportugal).

Default: "ctuportugal"
companyId
string

The name of the commercial registry office and the commercial registration number, separated by a space. When there is no commercial registration, the Tax Registration Number shall be inserted.

taxRegistrationNumber
integer
nullable

The Portuguese Tax Identification Number/Tax Registration Number without spaces and without country prefixes.

companyName
string

Social designation of the company name.

companyAddress
string

Street name, building number and floor, if applicable.

companyZip
string

Postal Code.

companyCity
string

City.

currencyCode
string

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

taxEntity
string
nullable

The establishment the produced file refers to, if applicable.

taxCountryRegion
string

The tax country region.

  • PT Portugal
  • PT-AC Azores
  • PT-MA Madeira
VALUES
PT
PT-AC
PT-MA
dateFiscalFirst
Timestamp
nullable

Date for start of the first fiscal year for the company (used to calculate the current fiscal year for the report).

dateFiscalSecond
Timestamp
nullable

Date for start of the second fiscal year for the company (used to calculate the current fiscal year for the report).

PluginCustomGiftCard
object

Settings for Gift Card Service Provider Interface (SPI).

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (customgiftcard).

Default: "customgiftcard"
api_url
string
(url)

Base URL for the handler of the SPI. Relative paths to API endpoints will be appended to it in requests.

api_key
string
WRITE ONLY

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

PluginCustomPayment
object

Settings for Payment Service Provider Interface (SPI) and POS UI.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (custompayment).

Default: "custompayment"
api_url
string
(url)

Base URL for the handler of the SPI. Relative paths to API endpoints will be appended to it in requests.

api_key
string
WRITE ONLY

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

icon_payment
string
nullable

Sitoo resource ID for the large icon used for the payment type. Needs to be in PNG-format with the size 940x210 pixels.

icon_payment_small
string
nullable

Sitoo resource ID for the small icon used for the payment type. Needs to be in PNG-format with the size 240x240 pixels.

bg_payment
string
(^#[0-9a-fA-F]{6}$|^#[0-9a-fA-F]{3}$)

Background color used for the large icon. The color is sent in hexadecimal format.

bg_payment_small
string
(^#[0-9a-fA-F]{6}$|^#[0-9a-fA-F]{3}$)

Background color used for the small icon. The color is sent in hexadecimal format.

required_customer_info
array
(string/enum)

Array of customer information collected for the payment before the payment transaction is started (the reason for it being array is to be able to add new customer information fields in the future).

  • mobile Mobile phone number
VALUES
mobile

PluginCustomProductSearch
object

Settings for External Product Search Service Provider Interface (SPI).

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (customproductsearch).

Default: "customproductsearch"
api_url
string
(url)

Base URL for the handler of the SPI. Relative paths to API endpoints will be appended to it in requests.

api_key
string
WRITE ONLY

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

PluginGivex
object

Settings for Givex.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (givex).

Default: "givex"
userId
string

The user ID used for the connection to Givex.

userPassword
string
WRITE ONLY

The password used for the connection to Givex.

hostPrimary
string

The primary host to use for the connection to Givex.

hostSecondary
string

The secondary host to use for the connection to Givex.

extendedLogging
boolean

Boolean to activate extended logging for the Givex proxy.

Default: false

PluginId
string

ID for a plugin settings object, mapping as follows:

PluginKlarnaV3
object

Settings for Klarna v3.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (klarnav3).

Default: "klarnav3"
username
string

User Name for Klarna API connection.

password
string
WRITE ONLY

Password for Klarna API connection.

region
string

Region for Klarna.

  • europe Europe
  • north-america North America
  • oceania Oceania
Default: "europe"
VALUES
europe
north-america
oceania
profileid
string

Profile for Klarna user interface.

  • ac0ef585-b1b1-4951-ab0f-f250f44f6b08 QR code or SMS touchpad - targeting buyer
  • 4baf6592-2675-4ed7-93cc-783b8f73de5e SMS touchpad or QR code - targeting buyer
  • 78417431-3bf2-456e-9f18-95c3313db874 Input field for SMS or Email - targeting seller
  • e205530c-37b5-4843-a228-871b5fd80c97 Input field for SMS - targeting seller
Default: "ac0ef585-b1b1-4951-ab0f-f250f44f6b08"
VALUES
ac0ef585-b1b1-4951-ab0f-f250f44f6b08
4baf6592-2675-4ed7-93cc-783b8f73de5e
78417431-3bf2-456e-9f18-95c3313db874
e205530c-37b5-4843-a228-871b5fd80c97
profileid_selfcheckout
string

Profile for Klarna user interface in self checkout.

  • ac0ef585-b1b1-4951-ab0f-f250f44f6b08 QR code or SMS touchpad - targeting buyer
  • 4baf6592-2675-4ed7-93cc-783b8f73de5e SMS touchpad or QR code - targeting buyer
Default: "ac0ef585-b1b1-4951-ab0f-f250f44f6b08"
VALUES
ac0ef585-b1b1-4951-ab0f-f250f44f6b08
4baf6592-2675-4ed7-93cc-783b8f73de5e

PluginNetsBaxiLogs
object

Settings for Nets BAXI log feature.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (netsbaxilogs).

Default: "netsbaxilogs"
region
string

The region where the S3 bucket resides.

bucket
string

The name of the bucket where log files will be uploaded.

access_key_id
string

The Access Key ID for S3 authentication.

access_key_secret
string
WRITE ONLY

The Access Key Secret for S3 authentication.

path
string

Format for the path where uploaded files will be stored.

  • account-register /\<Account ID>/\<Register Key>
  • account-store-register /\<Account ID>/\<Store External ID>/\<Register Key>
VALUES
account-register
account-store-register
url
string
(url)

URL when using a provider other than AWS that offers an S3 compatible service. Leave blank for using S3 on AWS.

PluginNetsCurrencyConversion
object

Settings for Nets Currency Conversion feature.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (netscurrencyconversion).

Default: "netscurrencyconversion"
payment_types
array
(object)

Nets payment types to configure currency conversion for.

PROPERTIES
payment_type_id
integer

ID for a Sitoo POS payment using method Nets (2200).

currency_code
string

Currency that the payment will be converted to and sent to Nets for this payment type (ISO 4217, alpha-3 uppercased).

bax_number
string

Nets BAX-number (merchant account) connected to this payment option.

PluginNosto
object

Settings for Nosto product recommendations.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (nosto).

Default: "nosto"
graphQLToken
string
nullable
WRITE ONLY

Authentication token for requests to Nosto Apps API (using GraphQL).

graphQLRecordRequests
boolean

Boolean to decide if requests to Nosto Apps API (GraphQL) should be recorded or not (using header X-Nosto-Ignore).

PluginProductSearch
object

Settings for POS Product Search feature.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (productsearch).

Default: "productsearch"
external_search_active
boolean

Activates external product search functionality to achieve endless aisle by integrating products from an external source in the POS. This feature requires a setup of and implementation of the Sitoo Product Search SPI.

Default: false
external_scan_to_cart
boolean

Activate functionality to have barcode scanner also make an external product search and add to the cart.

Default: false
external_search_title
string
nullable

Title for the external product search in the POS. Maximum length is 16 characters.

Max Length: 16
Min Length: 1
filters
array
(object)

Filters to use in local search for the POS. If no filters are selected here, the default filters in the POS will be Categories, Brands, In Stock and In Campaign.

PROPERTIES
id
string

ID for the filter (refers to custom product attribute ID). System IDs for built-in filters:

  • system_categories Filter on categories
  • system_brands Filter on brands (manufacturers)
  • system_in_stock Filter for products in stock
  • system_in_campaign Filter products that have an active campaign
title
string
nullable

If set, then this will be the title to be used for the filter. If set to null, then name of custom attribute or localized system filter name will be used.

type
string

Type of filter.

  • single-enum Drop list with 1 option
  • multi-enum Drop list with multiple options
  • bool Boolean value (on/off)

PluginRetain24
object

Settings for Retain24 gift card provider.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (retain24).

Default: "retain24"
certificate_public
string
nullable

The public certificate used to connect to Retain24.

Min Length: 1
certificate_private
string
nullable
WRITE ONLY

The private certificate used to connect to Retain24.

Min Length: 1
template_giftcard_printout
string
nullable

The Retain24 template identifier to be used for gift cards delivered by printout.

Min Length: 1
template_giftcard_email
string
nullable

The Retain24 template identifier to be used for gift cards delivered by email.

Min Length: 1
template_giftcard_sms
string
nullable

The Retain24 template identifier to be used for gift cards delivered by SMS.

Min Length: 1
template_creditnote_printout
string
nullable

The Retain24 template identifier to be used for credit notes delivered by printout.

Min Length: 1

PluginSelfCheckout
object

Settings for POS Self Checkout feature.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (selfcheckout).

Default: "selfcheckout"
active
boolean

Activate self checkout functionality in POS.

Default: false
checkout_user
string
nullable

Sitoo User ID for the staff user that will be logged on when running self checkout in POS.

logotype
string
nullable

Sitoo resource ID for the logotype image to be used for self checkout.

color_background
string
(^#[0-9a-fA-F]{6}$|^#[0-9a-fA-F]{3}$)
nullable

Background color used for self checkout. The color is sent in hexadecimal format.

color_text
string
(^#[0-9a-fA-F]{6}$|^#[0-9a-fA-F]{3}$)
nullable

Text color used for self checkout. The color is sent in hexadecimal format.

featured_products
array
(integer)

An array of Sitoo product IDs that will be used to present featured products (e.g. bags) in self checkout.

PluginSettings

Specific object depending on the plugin ID. See PluginId for mapping.

oneOf:

PluginSwish
object

Settings for Swish.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (swish).

Default: "swish"
payee_alias
string

Swish-number for the recipient of the payment (e.g. 12345678).

message_payment
string

Message sent with payments to be shown in the Swish app (Max 50 characters).

Max Length: 50
message_refund
string

Message sent with refunds to be shown in the Swish app. The string can contain the replacement tag {refundedid} (Max 50 characters in total after replacement has been done, might be truncated).

Max Length: 50
moneylimitmin
Money
nullable

The minimum amount required for Swish payment to be available to use. A null value will not enforce a limit.

selfcheckoutenabled
boolean

If selected, Swish is activated as payment method for self checkout.

Default: false
certificate_public
string
nullable

The public certificate used to connect to Swish.

Min Length: 1
certificate_private
string
nullable
WRITE ONLY

The private certificate used to connect to Swish.

Min Length: 1

PluginSwitchboard
object

Switchboard for selecting handler for gift cards and product recommendations.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (switchboard).

Default: "switchboard"
handler_giftcards
string
nullable

Gift card provider to be used.

  • giftcardsitoo Sitoo Gift Cards
  • customgiftcard Gift Card Service Provider Interface (SPI)
  • givex Givex
  • retain24 Retain24
VALUES
giftcardsitoo
customgiftcard
givex
retain24
handler_recommendations
string
nullable

Product recommendations provider to be used (this feature has been deprecated in favor of the Product Recommendations SPI).

  • recommendationssitoo Sitoo Recommendations (using Sitoo related products)
  • nosto Nosto
VALUES
recommendationssitoo
nosto

PluginTaxFree
object

Settings for Tax Free Service Provider Interface (SPI).

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (taxfree).

Default: "taxfree"
active
boolean

Activates external tax free functionality. This feature requires a setup of and implementation of the Sitoo Tax Free SPI.

Default: false

PluginZebra
object

Settings for Zebra label printing.

PROPERTIES
id
PluginId
READ ONLY

The plugin ID for this object (zebra).

Default: "zebra"
templates
array
(object)

Array of Zebra templates to be used when printing labels.

PROPERTIES
id
integer

The ID for the template, must be unique within the array.

Minimum: 1
Maximum: 10
name
string

The name of the template to be displayed in user interfaces.

type
integer

The type of template for the label.

  • 10 Product label
  • 20 Address label
data
string

The template data that the Zebra Printer uses to print the label, configured using the Zebra Programming Language (ZPL).

Timestamp
integer

Number of seconds since the Unix Epoch.

Copyright © 2024 Sitoo AB. All rights reserved.