Checking on features

Our highly individualizable, modular platform offers unparalleled customization through a robust feature system.

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

Our platform's extensive feature system allow for easy customization to meet your needs. Checking on the the current state of features through REST or GraphQL endpoints enables quick reactions in your clients. This level of configurability ensures a personalized experience for optimal efficiency.

Retrieve features' status via RESTful API

Getting the current status of all features:

curl -sSL 'https://your.api.fulfillmenttools.com/api/features' \
  --header 'Authorization: <TOKEN>'

Upon successful request, you will receive a response similar to the following example:

[
  {
    "name": "routing",
    "version": 42,
    "status": "enabled"
  },
  ...
]

The name field denotes the feature name, while the status field indicates whether the corresponding feature is currently enabled, disabled or inactive. If a feature is inactive it cannot be enabled or disabled. The version field indicates the current version of the corresponding feature document.

Getting the current status of a feature by feature name:

curl -sSL 'https://your.api.fulfillmenttools.com/api/features/<FEATURE-NAME>' \
  --header 'Authorization: <TOKEN>'

Enter the feature name you want to query in the URL in <FEATURE-NAME>. Upon successful request, you will receive a response similar to the following:

{
    "name": <FEATURE-NAME>,
    "version": <VERSION>,
    "status": <FEATURE-STATUS>
}

Specify the feature you want to edit in the URL in <FEATURE-NAME>, enter the document version in <DOCUMENT-VERSION> and input the desired status (enabled, disabled or inactive) in <STATUS>

Using GraphQL to get status of features

You can also use GraphQL to query for details of features of the system.

Be aware, that the fulfillmenttools GraphQL API is currently in Alpha state.

Getting the current status of all features:

features {
  name
  status
  version
}

Upon successful request, you will receive a response similar to the following example:

{
  "data": {
    "features": [
      {
        "name": "packing",
        "status": "enabled",
        "version": 42
      },
      ...
    ]
  }
}

Getting the current status of a feature by feature name:

feature(featureName: "<FEATURE-NAME>") {
  name
  status
  version
}

Enter the feature name you want to query in the query parameter in <FEATURE-NAME>. Upon successful request, you will receive a response similar to the following:

{
  "data": {
    "feature": {
      "name": <FEATURE-NAME>,
      "version": <VERSION>,
      "status": <FEATURE-STATUS>
    }
  }
}

Feature Status

Enabled

All functions and endpoints related to this feature will be available.

Disabled

All functions and endpoints related to this feature will not be available.

Inactive

This is a transitional state recommended for disabling a feature. Entities that are already in the processing pipeline of the targeted feature can still be processed, but new entities won't trigger the feature. For example, if an order has been created but a pick job has not been generated yet, setting the picking feature to inactive would allow a pick job to be created for that order. However, any new orders created after setting the feature to inactive would not trigger the creation of pick jobs.