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

Was this helpful?

  1. Connecting to fulfillmenttools
  2. Integration Tutorial

Checkout Options

End customers love knowing more about the possible delivery option when ordering online. Our fulfillability endpoint enables you to show this information on the shop frontend.

PreviousPlacing ordersNextDistributed Order Management System (Routing)

Last updated 5 months ago

Was this helpful?

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

Have you ever shopped online, filled your shopping cart only to see that the items are not available in your region in the checkout process? Our fulfillability endpoint gives LU.XY a tool to avoid this feeling for their customers.

Ship from Store

The platform has two options to provide the information whether an order is fulfillable to the customer's location. Either only by address and date or by address, date and the requested items. Both are made using the .

Best Effort

Both options are interesting for the web shop of LU.XY to give their customers the best experience possible. This works using this API call:

curl -sSL -X POST 'https://your.api.fulfillmenttools.com/api/fulfillability' \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "estimatedOrderDate": "2024-02-05T11:45:00Z", 
  "shipping": {  
    "serviceLevels": [ 
      "DELIVERY" 
    ], 
    "targetAddress": { 
      "postalCode": "1052 XM", 
      "country": "NL" 
    } 
  } 
}'

The response then clarifies what is possible:

{
    "shipping": {
        "DELIVERY": {
            "available": true
        }
    }
}

Detailed information

curl --location 'https://your.api.fulfillmenttools.com/api/fulfillability/shipfromstore' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "articles": [
        {
            "tenantArticleId": "SNEAK-W-4891"
        }
    ],
    "deliveryCountry": "NL",
    "deliveryPostalCode": "1052 XM",
    "deliveryPreferences": {
        "shipping": {
            "serviceLevel": "DELIVERY"
        }
    }
}'

We give an information of where to ship and which articles are desired. If the delivery is possible, we'll receive a 200 OK response providing a list of possible options:

{
    "fulfillability": [
        {
            "articleAvailabilities": [],
            "targetTime": "2024-02-07T11:00:00.000Z",
            "address": {
                "companyName": "lu.xy logistics B.V.",
                "country": "NL",
                "postalCode": "3044 AH",
                "city": "Rotterdam",
                "street": "Breevarstraat",
                "houseNumber": "12",
                "phoneNumbers": [
                    {
                        "value": "+1 20 96365846",
                        "type": "PHONE",
                        "label": "Landline"
                    }
                ],
                "emailAddresses": [
                    {
                        "value": "lu.xy.warehouse.NL@example.com",
                        "recipient": "LU.XY Warehouse NL"
                    }
                ],
                "resolvedCoordinates": {
                    "lat": 51.9281592,
                    "lon": 4.4259523
                },
                "resolvedTimeZone": {
                    "offsetInSeconds": 3600,
                    "timeZoneId": "Europe/Amsterdam",
                    "timeZoneName": "W. Europe Standard Time"
                }
            },
            "closingDays": [],
            "facilityName": "LU.XY Warehouse The Netherlands",
            "facilityRef": "fed73e8d-269e-47d8-9ce5-86a9331a1523",
            "pickingTimes": {
                "monday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "tuesday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "wednesday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "thursday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "friday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "saturday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ]
            },
            "tenantFacilityId": "23"
        },
        {
            "articleAvailabilities": [],
            "targetTime": "2024-02-07T11:00:00.000Z",
            "address": {
                "companyName": "lu.xy logistics GmbH",
                "country": "DE",
                "postalCode": "63303",
                "city": "Dreieich",
                "street": "Landsteinerstraße",
                "houseNumber": "5",
                "phoneNumbers": [
                    {
                        "value": "+49 69 96358078",
                        "type": "PHONE",
                        "label": "Landline"
                    }
                ],
                "emailAddresses": [
                    {
                        "value": "lu.xy.warehouse.FRA@example.com",
                        "recipient": "LU.XY Warehouse FRA"
                    }
                ],
                "resolvedCoordinates": {
                    "lon": 8.7170880894357,
                    "lat": 50.0105339089947
                },
                "resolvedTimeZone": {
                    "offsetInSeconds": 3600,
                    "timeZoneId": "Europe/Berlin",
                    "timeZoneName": "W. Europe Standard Time"
                }
            },
            "closingDays": [],
            "facilityName": "LU.XY Warehouse Frankfurt",
            "facilityRef": "946f17d0-2d14-48f0-a912-d358f2c70e8f",
            "pickingTimes": {
                "monday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "tuesday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "wednesday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "thursday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "friday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ],
                "saturday": [
                    {
                        "start": {
                            "hour": 5,
                            "minute": 0
                        },
                        "end": {
                            "hour": 23,
                            "minute": 59
                        },
                        "capacity": 100
                    }
                ]
            },
            "tenantFacilityId": "21"
        }
    ]
}

In this case, the Dutch and German central warehouses are possible options to fulfill the order from.

To get more details of what is possible, there is a second endpoint the LU.XY shop frontend can send data to in order to receive more information of the possible ship from store options. The call to the can look like this:

https://docs.fulfillmenttools.com/documentation
fulfillability endpoint
ship from store fulfillability endpoint