Remote configuration

The Remote Configuration feature provides a key-value store for clients. It allows for storing different values and value types, each identified by a unique key.

Each entry can also contain a specific scope, which restricts its availability to certain user groups or clients. This ensures that configurations are only available in the intended context.

For detailed endpoint descriptions, refer to the REST API documentation for Remote Config.

Creating a remote configuration

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/remoteconfigs

The following example shows the payload for creating a remote configuration.

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

Retrieving remote configurations

The GET endpoint provides filter parameters to retrieve specific configurations based on the use case. For instance, to get configurations applicable to a specific user and group, the userId and groups query parameters can be combined.

An example is retrieving all configurations for user USER-ID-003 that belong to the FULFILLMENT_APPLICATION group by using the query parameters userId=USER-ID-003 and groups=FULFILLMENT_APPLICATION.

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/remoteconfigs