fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy (context-based multi-config DOMS)
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Get features status
  • Get specific feature
  • Feature status
  • Enabled
  • Disabled
  • Inactive
Edit on GitHub
  1. Technical Basics

Feature status

Last updated 4 months ago

Our platform's extensive feature system allows for easy customization to meet your needs. Checking 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.

Get features status

More Features-API information can be found here:

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

This will respond with an HTTP 200 OK containing all features for that facility:

[
    {
        "name": "routing",
        "status": "enabled",
        "version": 42
    }
]
feature(featureName: "{featureName}") {
  name
  status
  version
}

Enter the feature name you want to query in the query parameter in {featureName}. You will receive a response similar to the following:

{
    "data": {
        "feature": {
            "name": "routing",
            "status": "enabled",
            "version": 42
        }
    }
}

The name field denotes the feature name, while the status field indicates whether the corresponding feature is 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.

Get specific feature

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

Enter the feature name you want to query in the URL in {featureName}. You will receive a response similar to the following:

{
    "name": "routing",
    "status": "enabled",
    "version": 42
}

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.

REST API documentation - Features