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
  • Order
  • Facility
  • Routing
  • Listing
  • Stock

Was this helpful?

  1. Getting Started

Core concepts & terminology

This page aims to give you an overview of the core concepts you will see when working with our platform and this documentation.

PreviousPlace your first orderNextOrder Flow

Last updated 5 months ago

Was this helpful?

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

Order

We see an order as something that comes from your shop system and needs to be fulfilled in one of your locations. An order contains information on the customer, their delivery preferences, the items which are ordered and optional some additional information.

{
  "consumer": {
    "addresses": [
      {
        "firstName": "Michael",
        "lastName": "Miller",
        "street": "Schillerweg",
        "houseNumber": "12B",
        "postalCode": "40213",
        "city": "Düsseldorf",
        "country": "DE"
      }
    ],
    "email": "michael@miller.com"
  },
  "deliveryPreferences": {
    "shipping": {
      "serviceLevel": "DELIVERY"
    }
  },
  "orderDate": "2023-10-23T08:45:50.525Z",
  "tenantOrderId": "de-cgn-584163fAWR",
  "orderLineItems": [
    {
      "article": {
        "tenantArticleId": "8504",
        "title": "Oranges - 5 kg net"
      },
      "quantity": 5
    },
    {
      "article": {
        "tenantArticleId": "9761",
        "title": "Gaffel Kölsch - 24x0.33l"
      },
      "quantity": 1
    }
  ]
}

Facility

A facility is one of your locations where you fulfill orders. This might be your warehouse or one of your stores. This one of the core entities of our platform.

{
  "name": "dreams agency cologne 1",
  "address": {
    "companyName": "dreams fulfilling GmbH",
    "street": "Butzweilerstraße",
    "houseNumber": "35-39",
    "postalCode": "50829",
    "city": "Köln",
    "country": "DE"
  },
  "locationType": "STORE",
  "status": "ONLINE",
  "services": [{ "type": "SHIP_FROM_STORE" }]
}

Routing

One of the things making our platform unique is our dynamic routing which finds the best option to fulfill an order at the current time. We distinguish between fences - these are criteria that have to be fulfilled and so-called ratings, dynamic criteria. A fence might be that the facility has to be in the same country as the customer. A rating could be the geodistance between the facility and the customer. Also, the order could optionally be split and fulfilled in more than one facility.

Listing

When placing orders as mentioned above, you can give additional information such as the size, the color or other data about an article item. When having a fixed set of articles you provide in a facility, you might those information to be mapped automatically. To offer this functionality, you can add listings. Listings are created for an existing facility and typically represent an type of item which is sold in that facility. It contains all relevant attributes, which are the same for each unit. It does not contain item-specific information and/or information about the current stock levels.

{
  "title": "Slim fit chino pants",
  "tenantArticleId": "1752930",
  "imageUrl": "https://images.your-shop.com/chino.jpg",
  "price": 79.95,
  "attributes": [
    {
      "category": "descriptive",
      "key": "color",
      "value": "beige"
    },
    {
      "category": "descriptive",
      "key": "waist",
      "value": "29"
    },
    {
      "category": "descriptive",
      "key": "length",
      "value": "30"
    }
  ],
  "scannableCodes": ["4012345678901", "1752930", "CHINO-175-29-30"]
}

Stock

All sellable items in the facility are represented as stock, and stocks most importantly contain information on how many items are present. Stock is typically linked to a listing (which describes the attributes of the items). Most of the attributes will be described via the listing. However, there might be stock-specific information, which differs from item to item, like best-before-dates.

{
    "tenantArticleId": "1752930",
    "facilityRef": "0dee02e8-f6a7-4080-b5ab-ffa477132f35",
    "value": 83
}
https://docs.fulfillmenttools.com/documentation