Notification Center Configuration (Core)

Endpoints to configure the notification center.

Get notification config

get

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

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

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

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": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Update notification config

put

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

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

201

Notification center configuration was successfully created.

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 endpoint

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: 164

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Call notification action

post

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

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 endpoint

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: 182

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Delete notification channel

delete

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

No content

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

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

Get facility notification config

get

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

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

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

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": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Update facility notification config

put

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

NotificationCenterConfig

createdstring · date-timeRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

201

Notification center facility configuration was successfully created.

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 endpoint

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: 164

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Call facility notification action

post

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

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 endpoint

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: 182

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

{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "created": "2026-07-22T15:57:49.888Z",
  "lastModified": "2026-07-22T15:57:49.888Z",
  "version": 1
}

Delete facility notification channel

delete

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

No content

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

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

List notifications (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NotificationSearchPayload

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

NotificationPaginatedResult

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/notifications/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "category": {
              "eq": "ORDER",
              "in": [
                "ORDER"
              ],
              "notEq": "ORDER"
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-07-22T15:57:49.888Z",
              "gt": "2026-07-22T15:57:49.888Z",
              "gte": "2026-07-22T15:57:49.888Z",
              "lt": "2026-07-22T15:57:49.888Z",
              "lte": "2026-07-22T15:57:49.888Z",
              "notEq": "2026-07-22T15:57:49.888Z"
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "priority": {
              "label": {
                "eq": "LOW",
                "in": [
                  "LOW"
                ],
                "notEq": "LOW"
              },
              "sequence": {
                "eq": 1,
                "gt": 1,
                "gte": 1,
                "in": [
                  1
                ],
                "lt": 1,
                "lte": 1,
                "notEq": 1,
                "notIn": [
                  1
                ]
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "category": {
          "eq": "ORDER",
          "in": [
            "ORDER"
          ],
          "notEq": "ORDER"
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-07-22T15:57:49.888Z",
          "gt": "2026-07-22T15:57:49.888Z",
          "gte": "2026-07-22T15:57:49.888Z",
          "lt": "2026-07-22T15:57:49.888Z",
          "lte": "2026-07-22T15:57:49.888Z",
          "notEq": "2026-07-22T15:57:49.888Z"
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": [
          {
            "and": "[Circular Reference]",
            "category": {
              "eq": "ORDER",
              "in": [
                "ORDER"
              ],
              "notEq": "ORDER"
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-07-22T15:57:49.888Z",
              "gt": "2026-07-22T15:57:49.888Z",
              "gte": "2026-07-22T15:57:49.888Z",
              "lt": "2026-07-22T15:57:49.888Z",
              "lte": "2026-07-22T15:57:49.888Z",
              "notEq": "2026-07-22T15:57:49.888Z"
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "priority": {
              "label": {
                "eq": "LOW",
                "in": [
                  "LOW"
                ],
                "notEq": "LOW"
              },
              "sequence": {
                "eq": 1,
                "gt": 1,
                "gte": 1,
                "in": [
                  1
                ],
                "lt": 1,
                "lte": 1,
                "notEq": 1,
                "notIn": [
                  1
                ]
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "priority": {
          "label": {
            "eq": "LOW",
            "in": [
              "LOW"
            ],
            "notEq": "LOW"
          },
          "sequence": {
            "eq": 1,
            "gt": 1,
            "gte": 1,
            "in": [
              1
            ],
            "lt": 1,
            "lte": 1,
            "notEq": 1,
            "notIn": [
              1
            ]
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "category": {
      "eq": "ORDER",
      "in": [
        "ORDER"
      ],
      "notEq": "ORDER"
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-07-22T15:57:49.888Z",
      "gt": "2026-07-22T15:57:49.888Z",
      "gte": "2026-07-22T15:57:49.888Z",
      "lt": "2026-07-22T15:57:49.888Z",
      "lte": "2026-07-22T15:57:49.888Z",
      "notEq": "2026-07-22T15:57:49.888Z"
    },
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "or": [
      {
        "and": "[Circular Reference]",
        "category": {
          "eq": "ORDER",
          "in": [
            "ORDER"
          ],
          "notEq": "ORDER"
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-07-22T15:57:49.888Z",
          "gt": "2026-07-22T15:57:49.888Z",
          "gte": "2026-07-22T15:57:49.888Z",
          "lt": "2026-07-22T15:57:49.888Z",
          "lte": "2026-07-22T15:57:49.888Z",
          "notEq": "2026-07-22T15:57:49.888Z"
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": "[Circular Reference]",
        "priority": {
          "label": {
            "eq": "LOW",
            "in": [
              "LOW"
            ],
            "notEq": "LOW"
          },
          "sequence": {
            "eq": 1,
            "gt": 1,
            "gte": 1,
            "in": [
              1
            ],
            "lt": 1,
            "lte": 1,
            "notEq": 1,
            "notIn": [
              1
            ]
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "priority": {
      "label": {
        "eq": "LOW",
        "in": [
          "LOW"
        ],
        "notEq": "LOW"
      },
      "sequence": {
        "eq": 1,
        "gt": 1,
        "gte": 1,
        "in": [
          1
        ],
        "lt": 1,
        "lte": 1,
        "notEq": 1,
        "notIn": [
          1
        ]
      }
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    }
  },
  "size": 10,
  "sort": [
    {
      "created": "ASC",
      "status": "ASC"
    }
  ]
}

{
  "notifications": [
    {
      "category": "ORDER",
      "created": "2026-07-22T15:57:49.888Z",
      "event": "text",
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastModified": "2026-07-22T15:57:49.888Z",
      "payload": {
        "titleLocalized": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "subjectLocalized": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "messageLocalized": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "entityLinks": [
          {
            "ref": "text",
            "type": "ORDER"
          }
        ],
        "message": "text",
        "subject": "text",
        "title": "text"
      },
      "priority": {
        "label": "LOW",
        "sequence": 1
      },
      "status": "OPEN",
      "type": "EMAIL",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}