Remote configuration

Our Remote Config is a simple configuration key-value store for clients. Based on a key, different values and value types can be saved here. Furthermore every entry can be contain a specific scope, this means that configurations can only be made available to certain user groups or clients.

More Remote-Config-API information can be found here: REST API documentation - Remote Config

Create Remote Config

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/remoteconfigs

A example remote config can look like the following one.

{
    "key": "SHOW_RETURN_SECTION",
    "value": false,
    "valueType": "BOOLEAN",
    "groups": [
        "FULFILLMENT_APPLICATION",
        "BACKOFFICE"
    ],
    "scopes": [
        {
            "id": "SCOPE-ID-0001",
            "facilityRefs": [
                "FACILITY-ID-001"
            ],
            "userRefs": [
                "USER-ID-001",
                "USER-ID-003"
            ]
        }
    ]
}

GET Remote Config

The different filter parameter of the GET endpoint can be used to get specific remote configs for the use case. For example: In your client you are in the context of the group FULFILLMENT_APPLICATION with user-scope USER-ID-003. Then use the search parameter userId=USER-ID-003 and groups=FULFILLMENT_APPLICATION.

GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/remoteconfigs