fulfillmenttools
  • Welcome to the fulfillmenttools Platform Documentation
  • Getting Started
    • Setup your access to fulfillmenttools
    • Make your first API Calls
      • Add your first facility
      • Add your first listing
      • Place your first order
    • Core concepts & terminology
      • Order Flow
    • Postman Collection
    • Client SDKs
    • FAQ
  • Clients
    • Backoffice
      • First steps - Registration
      • Network view
        • Home
        • Orders
          • Unroutable orders
          • Pre-orders & Backorders
          • Order History
        • Inventory Management
          • Stock Overview
          • Channel Inventory
        • Facilities
        • Users
        • Returns
        • DOMS configuration
        • Settings
        • Analytics
          • DOMS Pages
          • Fulfillment Operations Pages
          • Inventory Pages
          • Downloads Page
      • Facility view
        • Home
        • Inbound
        • Tasks
        • Listings
        • Storage Locations
        • Facility
        • Users
    • Inventory app
      • Registration Inventory App
      • App sections
        • Inbound
        • Storage and relocation
    • Operations app
      • Android
        • Manual Registration
        • Android Enterprise Registration
        • Sections
          • Picking
            • Load Units (legacy)
            • Substitute items
            • Weighed or measured products
            • Scanning configuration
            • Picking Methods
              • Batch Picking
              • Multi Order Picking
          • Packing
          • Handover
          • Returns (legacy)
        • Printing
        • Notifications
      • Webapp
        • Packing
      • Overview features Android & Webapp
    • Technical requirements
      • Zebra Hardware Scanner Configuration
      • Honeywell Hardware Scanner Configuration
      • Supported barcodes for camera scanning
      • Requirements for fft applications
      • Zebra printer
    • Returns app
      • Handle unannounced returns
      • Handle announced returns
  • Products
    • Core Functionality
      • Process
        • External actions
      • Add and manage facilities
      • Notification Center
      • Checking on features
      • Tags and Stickers Concept
      • GDPR
      • Remote Configuration
      • Expiry
      • Target time
      • Time calculation for queries of future availabilities (LPS-calculation)
      • Interfacility Transfer
    • Carrier Management
      • Overview
        • Available Carriers
      • Concepts
        • Carrier Country Service Mapping (CCSM)
        • Non-delivery-days
        • Custom Carrier & Headless operation of Carriers
      • Providing needed data
    • Fulfillment Options
      • Fulfillability Check
      • Checkout Options
        • Available fulfillment options based on basket
        • Earliest possible delivery date
        • Available delivery dates within time-period
        • Availability for delivery date
      • Delivery Promise
    • Inventory Management
      • Configurations
      • Entities
        • Listing
        • Stock
          • Stock Properties
        • Storage Location
        • Zone
      • Global Inventory
        • Stock availability
        • Channel Inventory
        • Expected stock
        • Inbound Process
        • Reservations
        • Safety Stock
      • Inventory Control
        • Inventory Traits
        • Measurement Units
        • Outbound Inventory Tracking
        • Storage Location Recommendations
    • Order Fulfillment
      • Headless Order Fulfillment
      • Pick Jobs
      • Zone picking
      • Load Units
      • Custom Service
      • Handover Jobs
      • Add External Documents
      • Configurations
        • Picking Configuration
          • Picking methods
          • Short Pick Reasons
        • Packing Configuration
          • Packing Container Types
        • Print / Document Configuration
        • Tag Configurations
          • Parcel Tag Configuration
        • Handover Configuration
        • Operative Container Types
    • Order Routing
      • Entities
        • Ship-from-Store Orders
        • Click-and-Collect Orders
        • Locked Orders
        • Custom Services Orders
          • Simple Custom Service Order
          • Complex Custom Service Order
      • Fences
      • Ratings
      • Order Split
        • Order split - initial routing
        • Order split after shortpick
        • Item bundles
      • Reroute
      • Shape the routing with the DOMS Toolkit
      • Decision logs
    • Returns Management
      • Returns legacy
        • Available status
      • Returns 2.0
        • Return Reasons
        • Item Conditions
        • Integrating Returns with Events
    • Use Cases
      • Demand-Driven Replenishment
      • Expected stock in availability
      • Multi Order Picking
      • Interfacility transfer
      • Assigned Users
  • Connecting to fulfillmenttools
    • General Topics
      • Use external identity providers to authenticate to fulfillmenttools
        • Microsoft Entra ID / Azure Active Directory (AD)
      • Public Event Export
      • Available Regions
      • Backup Policies
    • GraphQL API
    • RESTful API
      • General Topics
        • API Release Life Cycle
        • Versioning
        • Authorization
        • Customization via Attributes
        • Update Guarantees
        • Rate Limits
        • Resource Timestamps
        • Pagination Interface
        • Localization
        • Custom Attributes
      • OpenAPI Specification
        • Swagger UI
        • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an Event
      • Available Events
      • Tutorial
    • commercetools Connect
    • Integration Tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout Options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
  • Incident Reporting
    • How to report incidents in fulfillmenttools
    • How to define incident priorities
  • Release Notes
    • Release Summary – May 2024
    • Release Summary – June 2024
    • Release Summary – July 2024
    • Release Summary – August 2024
    • Release Summary – September 2024
    • Release Summary – October 2024
Powered by GitBook
On this page
  • Available resources
  • Step 1: Import or create fulfillmenttools environments in Postman
  • Step 2: Import fulfillmenttools API collection into Postman
  • Step 3: Define authentication Postman Vault values
  • Step 4: Make your first API Call using Postman
  • Have fun!

Was this helpful?

  1. Getting Started

Postman Collection

Requests ready to be used in one of the more common formats: Postman

PreviousOrder FlowNextClient SDKs

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

As of 26. July 2024, there have been changes in the use of the environments. Please import the environments as specified in this documentation AND the updated fulfillmenttools API collection.

During development of fulfillmenttools as an API-First product the design, documentation and testing of the APIs are taking a high priority. Therefore, a wholesome collection is in use and frequently updated with new requests as they appear in the API.

This page shares this resource to developers or other technical personnel in order to ease the access to the fulfillmenttools RESTful API and share concrete examples.

Available resources

Postman divides its functionality into several categories such as collections, environments, mock servers, etc... For documentation purpose fulfillmenttools provides a template environment and the collection of calls towards fulfillmenttools RESTful API. In order to work with the collection you need to import the environment into Postman and fill in the data as described below.

Step 1: Import or create fulfillmenttools environments in Postman

The environments contain variables that tell Postman where to address certain calls and which data should be used. If you want to try out an existing fulfillmenttools system using our Postman collection it is recommended to import and setup environments.

In case you just want to get a glimpse at the calls you don't necessarily need to set up an environment.

Two environments are necessary to work with Postman, one global and one tenant specific. To create the global one, and import it into Postman. See Postman documentation how to import an environment into Postman.

The same step must be done with the tenant specific environment, an example file is (don't forget to replace the ocff-example-prd with the correct projectId).

Theoretically projectId and host can be added to one environment. However, if additional tenant environments are added, the split can help.

The tenant specific environment has to contain the projectId:

Variable
Description
Example Value

projectId

The id of the used project.

ocff-example-prd

The global environment must contain the host value:

Variable
Description
Example Value

host

The Host of your fulfillmenttools platform environment

https://{{projectId}}.api.fulfillmenttools.com/ ------ {{projectId}} is right here, leave it like it is.

When using Postman more variables will occur in the environment. Be advised, that especially authTokens & refreshTokens will be stored in the environment of the Postman Instance you are using.

Step 2: Import fulfillmenttools API collection into Postman

fulfillmenttools API and thus the collection of calls is constantly growing. Therefore, it is a good idea to update your collection of calls sometimes to stay up to date with the latest changes.

Once you successfully imported the collection you are presented with a view similar to this:

Step 3: Define authentication Postman Vault values

To prevent the sync from sensitive data into the Postman Cloud, we use the Postman Vault. This is a local encrypted storage that is not synced to Postman. Accessible is Postman Vault in the Postman IDE in the bottom right corner with the Vault-Button.

Now three following variables has to be set. Replace {projectId} with the real project id in the shape of ocff-example-prd, so that the variables look like e.g. ocff-example-prd-user.

Variable
Description
Example Value

{projectId}-user

The user that exists in the system, usually in the form of an email. Please include the host part of the login.

user@ocff-example-prd.com

{projectId}-password

The password of the user.

{projectId}-api-key

The api key to our IdentityProvider to generate a AuthToken

AIZaSyCvIDK187vJWfl5EICJ_g_bNyvdARhdeXw

Sometimes Postman get in trouble if the password contains quotation marks or a backslash. In this case add a backslash to escape the character.

Example: My"Nice\Password -> My\"Nice\\Password

Step 4: Make your first API Call using Postman

After the call has successfully been executed the response is received from the IdentityProvider containing (among other data) the actual authToken and a refreshToken which are used for calls against the fulfillmenttools API.

Both values are stored as environment variables - you do not need to copy those!

Now we can execute every call in the collection - in this example we will request the list of facilities:

Have fun!

Now you are good to go to adapt and execute the other calls or create new requests.

Similar to setting up an environment you can import the collection of Requests into Postman. Please to download the needed file and import it into Postman as described .

The documentation on how to says we need to issue at least two calls in order to communicate with the API: First, we need to get an Auth Token and then use this Auth Token in our call towards the fulfillmenttools API. Let's do exactly this using Postman:

https://docs.fulfillmenttools.com/documentation
Postman
download our Globals environment template
here
available for download
use this link
here
Make your first API Call
List of fulfillmenttools products and their respective REST calls
Request to get a fresh authToken by using the environment variables apiKey, login and password.
The result of the request to get all facilities