Checkout options

For more details on the Fulfillability API, refer to the REST API documentation - Fulfillability.

A common frustration in e-commerce occurs when a customer discovers at checkout that items in their cart cannot be delivered to their region. The fulfillmenttools fulfillability endpoint provides a tool for LU.XY to prevent this scenario for its customers.

Ship from store

The platform offers two ways to provide information about whether an order is fulfillable to a customer's location: one based only on address and date, and another that also includes the requested items.

Both options are valuable for the LU.XY web shop to enhance the customer experience. This is achieved with the following 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 detailed information, the LU.XY shop frontend can query a dedicated endpoint to receive specific ship-from-store options. The call to the ship-from-store fulfillability endpoint is structured as follows:

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"
        }
    }
}

The request specifies the desired articles and the shipping destination. If delivery is possible, the API returns a 200 OK response containing a list of fulfillment 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": "[phone]",
                        "type": "PHONE",
                        "label": "Landline"
                    }
                ],
                "emailAddresses": [
                    {
                        "value": "[email protected]",
                        "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": "[phone]",
                        "type": "PHONE",
                        "label": "Landline"
                    }
                ],
                "emailAddresses": [
                    {
                        "value": "[email protected]",
                        "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 order can be fulfilled from either the Dutch or German central warehouses.