Configurations (Core)

Endpoints to update and read general configuration of fulfillmenttools.

get

Authorizations

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

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

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

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"
}

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

GdprConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

Responses

200

Gdpr configuration was written successfully

application/json

GdprConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The locale Configuration can be found in the body.

application/json

LocaleConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

idstringOptional

localestring · enumRequired

This part of the API is in Beta status. For details, see the API release lifecycle 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/locale

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

LocaleConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

idstringOptional

localestring · enumRequired

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

Example: de_DEPossible values:

Responses

200

The locale Configuration was successfully set.

application/json

LocaleConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

idstringOptional

localestring · enumRequired

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

Example: de_DEPossible values:

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

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

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, see the API release lifecycle 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

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

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

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

clearNamestringRequired

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

TenantConfigurationForUpsert

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versionnumberRequired

clearNamestringRequired

Responses

200

Tenant configuration was written successfully

application/json

TenantConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

clearNamestringRequired

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

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
}

List remote configurations (search)

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for RemoteConfiguration

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RemoteConfigurationSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

Example: 10

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

RemoteConfigurationPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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

post/api/remoteconfigurations/search

POST /api/remoteconfigurations/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1934

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "groups": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "key": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "scopes": {
              "contains": {
                "facilityRefs": [
                  "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                  "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
                ],
                "userRefs": [
                  "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                  "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
                ]
              }
            }
          }
        ],
        "groups": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "key": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "groups": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "key": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "scopes": {
              "contains": {
                "facilityRefs": [
                  "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                  "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
                ],
                "userRefs": [
                  "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
                  "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
                ]
              }
            }
          }
        ],
        "scopes": {
          "contains": {
            "facilityRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ],
            "userRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ]
          }
        }
      }
    ],
    "groups": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "key": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "groups": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "key": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "scopes": {
          "contains": {
            "facilityRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ],
            "userRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ]
          }
        }
      }
    ],
    "scopes": {
      "contains": {
        "facilityRefs": [
          "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
        ],
        "userRefs": [
          "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
        ]
      }
    }
  },
  "size": 10
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "remoteConfigurations": [
    {
      "created": "2026-07-22T22:40:29.023Z",
      "flattenScopeIds": [
        "INVENTORY",
        "67151fc3-3ce1-400e-8b23-23c29e0cde90"
      ],
      "groups": [
        "INVENTORY"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "key": "PICKING_SHOW_NEW_SCAN_VIEW",
      "lastModified": "2026-07-22T22:40:29.023Z",
      "scopes": [
        {
          "facilityRefs": [
            "928f3730-bc48-4d85-b83f-3fd86b776178"
          ],
          "id": "LGMl2DuvPnfPoSHhYFOm",
          "userRefs": [
            "928f3730-bc48-4d85-b83f-3fd86b776178"
          ]
        }
      ],
      "value": "text",
      "valueType": "BOOLEAN",
      "version": 1
    }
  ],
  "total": 1
}

Last updated 10 hours ago

Get GDPR config

Update GDPR config

Get locale config

Update locale config

List supported locales

Get tenant config

Update tenant config

List remote configurations (search)