Tags

For more details about the Tags endpoint, refer to the REST API reference.

Create tags

A tag's allowedValues can only be extended. Once a value is added, it cannot be removed.

To create a tag, send a POST request to the /api/tags endpoint.

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

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

The field id must be unique across all tags.

Get tags

To retrieve all defined tags, send a GET request to the /api/tags endpoint.

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

The response body contains an array of tag objects:

{
    "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 a tag is created, new values can be added to its allowedValues array.

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

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

A successful request returns an HTTP 200 OK response with the updated tag object in the body:

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

The value amazon can now be used for the channel tag.