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
  • Ship from Store
  • Detailed information
Edit on GitHub
  1. Getting Started
  2. Integration tutorial

Checkout options

Last updated 4 months ago

More Fulfillability-API information can be found here:

Have you ever shopped online and 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 for providing information about 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 options are interesting for the web shop of LU.XY to give their customers the best experience possible. This works using this API call:

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/fulfillability
{
  "estimatedOrderDate": "2024-02-05T11:45:00Z", 
  "shipping": {  
    "serviceLevels": [ 
      "DELIVERY" 
    ], 
    "targetAddress": { 
      "postalCode": "1052 XM", 
      "country": "NL" 
    } 
  } 
}
200 OK response
{
    "shipping": {
        "DELIVERY": {
            "available": true
        }
    }
}

Detailed information

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

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/fulfillability/shipfromstore
{
    "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:

200 OK response
{
    "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.

REST API documentation - Fulfillability