Tags endpoints

Create tag

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

TagForCreation

allowedValuesstring[] · min: 1Required

idstringRequired

Responses

201

The tag was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/tags

HTTPcURLJavaScriptPython

POST /api/tags HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "allowedValues": [
    "text"
  ],
  "id": "text"
}

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "allowedValues": [
    "text"
  ]
}

List tags

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

The current list of available tags

application/json

StrippedTags

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

No more elements available

application/json

get

/api/tags

HTTPcURLJavaScriptPython

GET /api/tags HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 42,
  "tags": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "allowedValues": [
        "text"
      ],
      "id": "text"
    }
  ]
}

Get tag

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tagRefstringRequired

Id of the tag you want to get

Responses

200

Tag was found & you were allowed to access it. The result is in the body.

application/json

Tag

and

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

User not found

application/json

get

/api/tags/{tagRef}

HTTPcURLJavaScriptPython

GET /api/tags/{tagRef} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "allowedValues": [
    "text"
  ]
}

Update tag

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tagRefstringRequired

Id of the tag you want to update

Body

application/json

TagPatchActions

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

Tag was found & you were allowed to access it. The result is in the body.

application/json

Tag

and

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Tag not found

application/json

patch

/api/tags/{tagRef}

HTTPcURLJavaScriptPython

PATCH /api/tags/{tagRef} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "actions": [
    {
      "action": "AddAllowedValueToTag",
      "allowedValue": "text"
    }
  ],
  "version": 42
}

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "allowedValues": [
    "text"
  ]
}