Tags

More Tags-API information can be found here: REST API documentation - Tags

Create tags

Be aware: A tag is only "progressing forward": Once you introduce an allowed value to a tag, you cannot remove it anymore.

To add a tag, do the following POST call with the JSON body:

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/tags

{
  "id": "channel",
  "allowedValues": [
    "marketplace",
    "webshop"
  ]
}

The field id must be unique for tags.

Get tags

To get all defined tags, do the following GET call:

GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/tags

The response looks like this one:

{
    "tags": [
        {
            "id": "channel",
            "allowedValues": [
                "marketplace",
                "webshop"
            ],
            "created": "2020-02-03T08:45:51.525Z",
            "lastModified": "2020-02-03T09:45:51.525Z",
            "version": 1
        }
    ],
    "total": 1
}

Patch tags

Once created, allowedValues can be modified to receive additional allowed values:

PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/tags/{tagId}

{
    "actions": [
        {
            "action": "AddAllowedValueToTag",
            "allowedValue": "amazon"
        }
    ],
    "version": 1,
}

A successful request is acknowledged by an HTTP 200 OK response with a body similar to this:

{
    "id": "channel",
    "allowedValues": [
        "marketplace",
        "webshop",
        "amazon"
    ],
    "version": 3,
    ...
}

From now on, the value amazon could be used as a value to the tag channel.