Show sticker to clients

To display sticker in the backoffice network order overview or other fulfillmentools clients two possible ways are available.

Both options can be used together.

Sticker to order

The first option is to attach a sticker to an order at creation. If this order reaches fulfillmenttools it will, for example, be displayed in the backoffice application, and an additional filter will allow you to filter orders based on those stickers.

Such an order could look like this:

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"
    }
  ],
  ...
}

Tag to order

The second option is to attach a tag to an order and configure the sticker configuration so that the sticker is added to the order automatically upon entering the system. Furthermore, configurations for other entities can add a sticker for other entities.

In this example, we consider all the used tags to be present in the system, such as:

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
}

Now we need to create a configuration that adds stickers based on tags for orders. Consider the following 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"
            }
          ]
        },
        ...
      ]
    }
  ...
}

Now new orders can be tagged with Channel and automatically get the CustomerType sticker attached:

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

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