Adding facilities

After we set up our environment, we are ready to create our facilities using the API. Let's add the first facility, the flagship store in Frankfurt, Germany.

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities

{
    "name": "LU.XY Fashion flagship store",
    "address": {
        "companyName": "lu.xy fashion GmbH",
        "country": "DE",
        "postalCode": "60316",
        "city": "Frankfurt",
        "street": "Sandweg",
        "houseNumber": "61",
        "phoneNumbers": [
            {
                "value": "[phone]",
                "type": "PHONE",
                "label": "Landline"
            }
        ],
        "emailAddresses": [
            {
                "value": "[e-mail]",
                "recipient": "LU.XY Frankfurt 1"
            }
        ]
    },
    "locationType": "STORE",
    "tenantFacilityId": "1",
    "status": "ONLINE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        },
        {
            "type": "PICKUP"
        }
    ],
    "pickingTimes": {
        "monday": [{
            "start": { "hour": 8, "minute": 0},
            "end": { "hour": 17, "minute": 0 },
            "capacity":20
        }],
        "tuesday": [{
            "start": { "hour": 8, "minute": 0 },
            "end": { "hour": 17, "minute": 0 },
            "capacity":20
        }],
        "wednesday": [{
            "start": { "hour": 8, "minute": 0 },
            "end": { "hour": 17, "minute": 0 },
            "capacity":20
        }],
        "thursday": [{
            "start": { "hour": 8, "minute": 0 },
            "end": { "hour": 17, "minute": 0 },
            "capacity":20
        }],
        "friday": [{
            "start": { "hour": 8, "minute": 0 },
            "end": { "hour": 17, "minute": 0 },
            "capacity":15
        }],
        "saturday": [{
            "start": { "hour": 8, "minute": 0 },
            "end": { "hour": 17, "minute": 0 },
            "capacity":10
        }]
    }
}

Before looking at the response, let’s dive deeper into the properties:

• name: That is the name you use for that facility, might be an internal name like "Frankfurt flagship store"

• address: Where the facility is located.

• locationType: The type of location, could be either STORE, EXTERNAL or WAREHOUSE. Warehouses do not offer Click&Collect services.

• tenantFacilityId: ID of that facility in your systems, optional but must be unique.

• status: Status of the facility after creation: ONLINE facilities are ready to fulfill new orders. SUSPENDED facilities can fulfill the current workload but don't accept new orders. OFFLINE facilities cannot fulfill new or current orders.

• services: The services this facility is offering (e.g. PICKUP or SHIP_FROM_STORE). Warehouses usually don't allow the customer to pick up the goods.

• pickingTimes: The times when the employees can pick up incoming orders. They can differ from the opening hours. For each picking time, a certain capacity can be defined, which defines the number of orders that can be processed within this timeframe.

The platform should respond with a 201 CREATED response, indicating everything worked well and containing the facility in it's payload:

201 CREATED response

{
    "name": "LU.XY Fashion flagship store",
    "address": {
        "companyName": "lu.xy fashion GmbH",
        "country": "DE",
        "postalCode": "60316",
        "city": "Frankfurt",
        "street": "Sandweg",
        "houseNumber": "61",
        "phoneNumbers": [
            {
                "value": "[phone]",
                "type": "PHONE",
                "label": "Landline"
            }
        ],
        "emailAddresses": [
            {
                "value": "[e-mail]",
                "recipient": "LU.XY Frankfurt 1"
            }
        ]
    },
    "locationType": "STORE",
    "tenantFacilityId": "1",
    "status": "ONLINE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        },
        {
            "type": "PICKUP"
        }
    ],
    "pickingTimes": {
        "monday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "tuesday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "wednesday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "thursday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "friday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 15
            }
        ],
        "saturday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 10
            }
        ]
    },
    "fulfillmentProcessBuffer": 240,
    "capacityEnabled": false,
    "created": "2023-11-14T15:26:43.165Z",
    "lastModified": "2023-11-14T15:26:43.165Z",
    "version": 1,
    "id": "d286e108-698b-4f6c-97b7-21f090f17e46"
}

In the response, you might have noticed the following properties which were not part of the creation request:

• id: The ID the facility has in the fulfillmenttools platform.

• version: The entity's version is in the database. This is important for locking mechanisms, and it's usually version 1 when creating the facility.

• fulfillmentProcessBuffer: Duration in minutes until an order is fully processed.

• capacityEnabled: Indicates that configured capacity limits for picking times are considered.

• created: Indicates the date and time the facility was created in the fulfillmenttools platform.

• lastModified: indicates the date and time the facility was last modified.

We can create the other facilities now that we have created the first facility. The other calls won't be logged here to avoid an unnecessary long page. In our case, every store has the same picking times each day, except that German, Swiss, and Austrian stores won't pick on Sundays.

Adding warehouses

After we added the stores, we now want to add the warehouses as well. While the endpoint stays the same, the payload differs. Let's make the first call together. Warehouses are picking from 5 AM to 12 AM, monday to saturday in all countries. They also have higher capacities - even though we do not use them, yet. Currently, our platform does not support picking times until 12 AM, so 11.59 PM is what we set.

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities

{
    "name": "LU.XY Warehouse Frankfurt",
    "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": "[e-mail]",
                "recipient": "LU.XY Warehouse FRA"
            }
        ]
    },
    "locationType": "WAREHOUSE",
    "tenantFacilityId": "21",
    "status": "ONLINE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "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
            }
        ]
    }
}

The platform should now respond with a 201 CREATED response:

201 CREATED response

{
    "name": "LU.XY Warehouse Frankfurt",
    "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": "[e-mail]",
                "recipient": "LU.XY Warehouse FRA"
            }
        ]
    },
    "locationType": "WAREHOUSE",
    "tenantFacilityId": "21",
    "status": "ONLINE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "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
            }
        ]
    },
    "fulfillmentProcessBuffer": 240,
    "capacityEnabled": false,
    "created": "2023-11-15T12:54:24.084Z",
    "lastModified": "2023-11-15T12:54:24.084Z",
    "version": 1,
    "id": "946f17d0-2d14-48f0-a912-d358f2c70e8f"
}

Now, the facilities are set for us. At a later stage, it is imaginable to periodically check with an ERP system whether there are new facilities that should be created in the platform or react to an event from the ERP on the integration layer. But for now, we are good.

Disclaimer

The addresses were randomly picked by looking up the city on Google Maps and zooming into a random place in that city. If one of the addresses offends you in any way, please let us know, and we will change it immediately.