Configurations (Core)

Endpoints to update and read general configuration of the fulfillmenttools platform.

Get GDPR config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Gdpr configuration was found & you were allowed to access it. The result is in the body.

application/json

GdprConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Gdpr configuration not found

application/json

get

/api/configurations/gdpr

HTTPcURLJavaScriptPython

GET /api/configurations/gdpr HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Update GDPR config

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

GdprConfiguration

Responses

200

Gdpr configuration was written successfully

application/json

GdprConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Gdpr configuration not found

application/json

put

/api/configurations/gdpr

HTTPcURLJavaScriptPython

PUT /api/configurations/gdpr HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Get locale config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The locale Configuration can be found in the body.

application/json

LocaleConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/configurations/locale

HTTPcURLJavaScriptPython

GET /api/configurations/locale HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countryLanguageMapping": {
    "DE": "de_DE",
    "RU": "ru_RU",
    "US": "en_US"
  },
  "id": "text",
  "locale": "de_DE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update locale config

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LocaleConfiguration

Responses

200

The locale Configuration was successfully set.

application/json

LocaleConfiguration

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

put

/api/configurations/locale

HTTPcURLJavaScriptPython

PUT /api/configurations/locale HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "countryLanguageMapping": {
    "DE": "de_DE",
    "RU": "ru_RU",
    "US": "en_US"
  },
  "id": "text",
  "locale": "de_DE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "countryLanguageMapping": {
    "DE": "de_DE",
    "RU": "ru_RU",
    "US": "en_US"
  },
  "id": "text",
  "locale": "de_DE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List supported locales

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The supported locales can be found in the body.

application/json

SupportedLocales

itemsstring · enumOptional

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)

Example: de_DEPossible values:

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/configurations/supportedlocales

HTTPcURLJavaScriptPython

GET /api/configurations/supportedlocales HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "de_DE"
]

Get tenant config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Tenant configuration was found & you were allowed to access it. The result is in the body.

application/json

TenantConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Tenant configuration not found

application/json

get

/api/configurations/tenant

HTTPcURLJavaScriptPython

GET /api/configurations/tenant HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clearName": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update tenant config

put

Upsert tenant configuration

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

TenantConfigurationForUpsert

Responses

200

Tenant configuration was written successfully

application/json

TenantConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Tenant configuration not found

application/json

put

/api/configurations/tenant

HTTPcURLJavaScriptPython

PUT /api/configurations/tenant HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "clearName": "text",
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

{
  "clearName": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}