Notification center endpoints

Network-level configurations

Get notification config

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Returns the notification center configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The notification center configuration was successfully returned.

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

application/json

404

The requested entity was not found

application/json

get

/api/configurations/notifications

HTTPcURLJavaScriptPython

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Update notification config

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Update the notification center configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

Responses

200

Notification center configuration was successfully updated.

application/json

201

Notification center configuration was successfully created.

application/json

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

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

application/json

409

A version conflict occurred.

application/json

put

/api/configurations/notifications

HTTPcURLJavaScriptPython

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Call notification action

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Executes an action to manipulate the notification center configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

Responses

200

Notification center configuration action was successfully executed.

application/json

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

application/json

409

A version conflict occurred.

application/json

post

/api/configurations/notifications/actions

HTTPcURLJavaScriptPython

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

{
  "channel": {
    "enabled": true,
    "events": [
      "PICK_JOB_CREATED"
    ],
    "receiver": [
      {
        "email": "[email protected]",
        "language": "de_DE"
      }
    ],
    "type": "EMAIL"
  },
  "name": "ADD_CHANNEL",
  "version": 1
}

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Delete notification channel

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Delete the notification channel.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelIdstringRequired

Query parameters

versionnumberRequired

Responses

200

Notification center config channel was successfully deleted.

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

delete

/api/configurations/notifications/channels/{channelId}

HTTPcURLJavaScriptPython

DELETE /api/configurations/notifications/channels/{channelId}?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Facility-level configurations

Get facility notification config

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Returns the notification center facility configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

Responses

200

The notification center facility configuration was successfully returned.

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

application/json

404

The requested entity was not found

application/json

get

/api/facilities/{facilityRef}/configurations/notifications

HTTPcURLJavaScriptPython

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Call facility notification action

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Executes an action to manipulate the notification center facility configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

Body

application/json

or

Responses

200

Notification center facility configuration action was successfully executed.

application/json

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/facilities/{facilityRef}/configurations/notifications/actions

HTTPcURLJavaScriptPython

POST /api/facilities/{facilityRef}/configurations/notifications/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "channel": {
    "enabled": true,
    "events": [
      "PICK_JOB_CREATED"
    ],
    "receiver": [
      {
        "email": "[email protected]",
        "language": "de_DE"
      }
    ],
    "type": "EMAIL"
  },
  "name": "ADD_CHANNEL",
  "version": 1
}

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Update facility notification config

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Update the notification center facility configuration.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

Body

application/json

or

Responses

200

Notification center facility configuration was successfully updated.

application/json

201

Notification center facility configuration was successfully created.

application/json

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

put

/api/facilities/{facilityRef}/configurations/notifications

HTTPcURLJavaScriptPython

PUT /api/facilities/{facilityRef}/configurations/notifications HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-03-13T18:31:48.210Z",
  "lastModified": "2026-03-13T18:31:48.210Z",
  "version": 1
}

Delete facility notification channel

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Delete the notification facility channel.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

channelIdstringRequired

Query parameters

versionnumberRequired

Responses

200

Notification center facility config channel was successfully deleted.

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

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

delete

/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}

HTTPcURLJavaScriptPython

DELETE /api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content