POST

set_settings

Allows to change settings, e.g. in the Shopgate configuration.

Query parameters

action

string

Requested method

required

default : set_settings

shop_number

string

Your shop number. Example: “11413”

required

trace_id

string

Unique request trace ID. Example: “sma-9412”

required

shopgate_settings

object

required

name

string

Name of the setting. Example: “encoding”

required

value

string or number or integer or boolean or null

The new value for the setting (type depending on the setting to be changed). To set a setting null only pass name and do not pass value.

required

Response

application/json

object

error

integer

Error code 0 means no error.

1 validation + required

error_text

null or string

Error text; null means no error.

required

trace_id

string

Request trace-ID, needed as reference for contact. Example: “sma-4f99573d74ae1”

required

shopgate_library_version

string

Shopgate Library version. Example: “2.5.0”

required

plugin_version

string

Plugin version. Example: “2.5.3”

required

shopgate_settings

array[object]

required

Error Codes

Code	Description
2	cannot open/create logfile(s)
10	invalid value in configuration
11	error reading or writing configuration
20	no action specified
21	unknown action requested
22	disabled action requested
23	wrong response format
50	parameter “shopgate_settings” missing
83	database error
100	no connection to server
101	Unknown action
102	error code received from merchant API
120	authentication failed
999	Unknown error

Example

{
  "error": 0,
  "error_text": null,
  "trace_id": "sma-9412",
  "shopgate_library_version": "2.3.10",
  "plugin_version": "2.3.2",
  "shopgate_settings": [
    {
      "name": "encoding",
      "old": "ISO-8859-15",
      "new": "UTF-8"
    },
    {
      "name": "cname",
      "old": "http://mobile.my-shop.com",
      "new": null
    },
    {
      "name": "alias",
      "old": "my-shop",
      "new": "shopname"
    }
  ]
}