Add your first facility

Learn how to add your first facility where orders can be fulfilled.

On our platform, facilities are representations of the locations where orders are fulfilled. In this example we will add a store which sells candy - Bill's Candy Shop. Our platform differences between stores and warehouses. Warehouses usually don't offer Click&Collect, while stores might offer this service. Bill's Candy Shop offers only Ship from Store as we try to stay basic in this tutorial. For a more detailed view of what you can do with facilities, see Add and manage facilities.

Placeholders

Whenever you see your.api.fulfillmenttools.com, replace it with the tenant information you received from Professional Service, e.g. ocff-wonkacandycompany-pre.api.fulfillmenttools.com.

Placeholder	Replace with	Example
{TOKEN}	JWT from Identity provider	eyJhbGciOX49.eyJzdWV9.dyt0CoI

Create the facility

For creating a facility, only little information is required. See more in the REST API documentation of facilities as this only a short tutorial. Please note, there is no check whether the facility's address exists.

Let's add the facility via the API.

curl -sSL -X POST 'https://your.api.fulfillmenttools.com/api/facilities' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Bills Candy Shop",
    "address": {
        "companyName": "Bills Candy Shop Ltd.",
        "country": "DE",
        "postalCode": "81669",
        "city": "München",
        "street": "Lilienstr.",
        "houseNumber": "58"
    },
    "services": [
    {
      "type": "SHIP_FROM_STORE"
    }
  ],
  "status": "ONLINE",
  "locationType": "STORE"
}'

The fields "services", "status" and "locationType" are not required, but we highly recommend adding at least the services section as this enables the store to ship orders.

If your request was successful, you'll receive a 201 CREATED response with a body like this:

{
    "name": "Bills Candy Shop",
    "address": {
        "companyName": "Bills Candy Shop Ltd.",
        "country": "DE",
        "postalCode": "81669",
        "city": "München",
        "street": "Lilienstr.",
        "houseNumber": "58"
    },
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "status": "ONLINE",
    "locationType": "STORE",
    "fulfillmentProcessBuffer": 240,
    "capacityEnabled": false,
    "created": "2023-08-22T14:39:27.014Z",
    "lastModified": "2023-08-22T14:39:27.014Z",
    "version": 1,
    "id": "0dee02e8-f6a7-4080-b5ab-ffa477132f35"
}