fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy (context-based multi-config DOMS)
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Configuration
  • Configuration on network level
  • Configurations on facility level
  • Create notification before time triggered reroute is performed
  • 1. Define when the notification should be triggered
  • 2. Set up the notification in the notification center
Edit on GitHub
  1. More Integration Guides

Notifications

Configuration

To set up notifications, you need to put a corresponding configuration in place. The notification configuration has the following attributes:

  • channels: A channel defines the source and the target of notifications. We recommend to define different channels for different receiver groups and/or facilities. See below for a detailed description.

  • enabled: Defines the state of the channel. Set to true if notifications should be sent and to false if notifications should be paused.

A channel is a JSON Object which contains the following attributes:

  • type: The type of the notification you will receive. Currently, only EMAIL is supported.

  • events: The events upon which the notification is triggered. Currently we support:

    • PICK_JOB_CREATED: An order was assigned to a facility and is ready to be picked.

    • ROUTING_PLAN_NOT_ROUTABLE: An order could not be assigned to a facility and is in "unroutable" state.

    • ROUTING_PLAN_WAITING: A routing plan is waiting

  • receiver: Who will receive the notification. This is an array of objects. The attributes of the objects change based on the TYPE:

    • Type EMAIL:

      • email: The email address of the recipient

      • language: The language of the email. Currently, this is either de_DE or en_US. It is possible to define a different language for each receiver email address.

You can define, whether you want to receive notifications on network level or only for specific facilities.

Configuration on network level

Create a new configuration

Create a configuration on network level if you want to receive notifications globally, i.e. for all events no matter which facility they apply to. To create a new configuration on network level, use the below endpoint to create one or several channel(s). If you want to send the same events to the same user group, it is sufficient to create one channel. Please speficy type, event(s), and receiver(s) as specified above and set enabled to true.

Configurations on facility level

Create a new configuration

Create a configuration on facility level if you want to receive notifications only for specific facilities, e.g., only for orders that are routed to a specific facility. To create a new configuration on facility level, use the below endpoint to create one or several channel(s). If you want to send the same events to the same user group in the same facility, it is sufficient to create one channel. Please specify facilityRef, type, event(s), and receiver(s) as specified above and set enabled to true.

Create notification before time triggered reroute is performed

Before a time triggered reroute will happen it might make sense to inform e.g., a supervisor that a reroute due to inactivity is about to happen. This might trigger an operational action like reminding the store manager to start picking.

This is how you can set up such a notification:

1. Define when the notification should be triggered

With the API call: PUT/api/configurations/routing/reroutetimetriggered you can not only set up the timespan when a task is going to be rerouted in case of inactivity but you can also set the time span how many minutes before this reroute is being performed a user should receive a notification.

This call might look like this:
{
    "version": 1,
    "clickAndCollectReroute": {
        "active": false,
        "rerouteTargetTimeHours": 48,
        "rerouteAfterMinutes": 120,
        "leadTimeBeforeTimeTriggeredReroute": 30
    },
    "shipFromStoreDeliveryReroute": {
        "active": false,
        "rerouteTargetTimeHours": 101,
        "rerouteAfterMinutes": 120,
        "leadTimeBeforeTimeTriggeredReroute": 30
    }
}

In this example it is defined that the task is being rerouted after 120 minutes of inactivity and 30 minutes before the reroute would happen (in this case after 90 minutes being inactive) a notification is sent to a defined group of people.

2. Set up the notification in the notification center

With the API call: PUT/api/configurations/notifications you can define in our notification center which addresses should receive an email if the time triggered reroute is about to happen. Therefore use the event UPCOMING_TIME_TRIGGERED_REROUTE.

This call might look like this:
{
    "channels": [
        {
            "enabled": true,
            "events": [
                "UPCOMING_TIME_TRIGGERED_REROUTE"
            ],
            "type": "EMAIL",
            "receiver": [
                {
                    "email": "PUT-IN-YOUR-EMAIL-ADDRESS",
                    "language": "de_DE"
                },
                {
                    "email": "PUT-IN-YOUR-EMAIL-ADDRESS",
                    "language": "en_US"
                }
            ]
        }
    ],
    "enabled": true,
    "version": 1
}

The set CRON_JOB in your tenant is responsible for triggering sending emails. Depending on the set intervals of this job it might be that there is a delay between the actual expiry of the previously set time and the email being sent.

Last updated 4 months ago