Skip to main content
API docs by Redocly

Config API (1.0)

Download OpenAPI specification:Download

URL: https://docs.newstore.net/

The API to request, add and change configurations of Team Web Platform's services.

email

Endpoints for managing email configuration.

Retrieve configuration options for the email service.

The values smtp_pass and smtp_user are considered as secrets and will always be returned as ***********.

Responses

Response samples

Content type
application/json
{
  • "configuration_options": [
    ]
}

Change configuration for the email service.

Email configuration can be created or updated. It is possible to just set a subset of the configuration values.

Request Body schema: application/json
feature_toggle
string
Enum: "enabled" "disabled"

Toggle to turn email sending on or off, if missing it is turned on by default.

smtp_port
string non-empty

The SMTP port used to send email.

from_address
string non-empty

The address of the sender that appears in the sent messages.

from_name
string non-empty

The name of the sender that appears in the sent messages.

smtp_user
string

The username required to access the SMTP server.

smtp_host
string non-empty

The host of the SMTP server.

smtp_pass
string

The password for 'smtp_user' (the user to access the server).

Responses

Request samples

Content type
application/json
{
  • "feature_toggle": "enabled",
  • "smtp_port": "string",
  • "from_address": "string",
  • "from_name": "string",
  • "smtp_user": "string",
  • "smtp_host": "string",
  • "smtp_pass": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

nom

Endpoints for managing NOM configuration.

Retrieve configuration options for NOM.

There are many configurations for managing NOM. This is a list of all NOM configurations that currently have not been assigned to a particular domain. This is not an exceptional list, other NOM configurations can be found in coresponding domains (order management, checkout, etc.)

Responses

Response samples

Content type
application/json
{
  • "configuration_options": [
    ]
}

Change configuration options for NOM.

When you send a request to change configuration for a specific key, it replaces the previous value, not patches it. So you cannot set individual keys inside top-level options since it will delete the other keys inside this option, you need to provide the whole value of the top-level option to change an individual key inside it. The exception is "releaseToggles": you can set individual options inside "releaseToggles" without replacing values for other options inside.

Request Body schema: application/json
userLocalTimezone
boolean
Default: false

Defines if date/time values are displayed in NOM according to the user's local timezone (true), or the tenant's configured timezone (false). Defaults to false.

timezone
string
Default: "America/New_York"

The timezone used for NOM, defaults to 'America/New_York'.

currency
string <= 3 characters
Default: "USD"

Currency code shown and used in NOM, defaults to 'USD'.

cognitoFormsURL
string

CognitoForms URL of support case submission form.

cognitoFormsID
string

CognitoForms ID of support case submission form.

object

Defines if certain features of NOM should be activated for a tenant or not.

idleTimeout
integer
Default: 1800

Defines the amount of seconds of idle time before users are automatically logged out of NOM.

Responses

Request samples

Content type
application/json
{
  • "userLocalTimezone": false,
  • "timezone": "America/New_York",
  • "currency": "USD",
  • "cognitoFormsURL": "string",
  • "cognitoFormsID": "string",
  • "releaseToggles": {
    },
  • "idleTimeout": 1800
}

Response samples

Content type
application/json
{
  • "message": "string"
}