Show sticker to clients

There are two methods to display a sticker in fulfillmenttools clients, such as the network order overview in the Backoffice.

Both options can be used together.

Directly assigning stickers during order creation

The first method involves attaching a sticker directly to an order payload during its creation. When fulfillmenttools processes this order, the sticker is displayed in client applications like the Backoffice. This also enables filtering orders based on assigned stickers.

An example order payload with a sticker is shown below.

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

{
  "tenantOrderId": "4711",
  ...
  "stickers": [
    {
      "key": "customercategory",
      "priority": 100,
      "nameLocalized": {
        "de_DE": "A-Kunde",
        "en_US": "A-Customer"
      },
      "color": "#19b6b5"
    }
  ],
  ...
}

Automatically assigning stickers via tags

The second method is to attach a tag to an order and create a configuration that automatically assigns a sticker when the order enters the system. This configuration-based approach can also be used to assign stickers to other entities.

This example assumes a tag is already configured in the system:

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

{
    "id": "Channel",
    "allowedValues": [
        "B2B",
        "B2C"
    ],
    "created": "2023-04-03T09:28:59.336Z",
    "lastModified": "2023-04-03T09:28:59.336Z",
    "version": 1
}

Next, a configuration is created to map specific tag values to stickers for the order entity. The following example demonstrates this configuration:

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/tags/order

{
    "stickerConfiguration": {
      "offeredStickersByTag": [
        {
          "tagRef": "Channel",
          "matchingValues": [
            "B2B"
          ],
          "stickers": [
            {
              "key": "CustomerType",
              "priority": 100,
              "nameLocalized": {
                "de_DE": "Firmenkunde",
                "en_US": "Business Customer"
              },
              "name": "Firmenkunde",
              "color": "#9919b6"
            }
          ]
        },
        ...
      ]
    }
  ...
}

With this configuration in place, new orders created with the Channel tag will automatically have the corresponding CustomerType sticker assigned:

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

{
    "tenantOrderId": "4711",
    ...
    "tags": [
        {
            "id": "Channel",
            "value": "B2B"
        }
    ],
    ...
}