API documentation Incident Management Feedback

Quickstart

Last updated 5 months ago

Quickstart

This tutorial will guide you through the initial setup required to make your first API call to fulfillmenttools.

Setup Access

If you haven't already done so, request your free trial at to get started immediately!
You will receive the following details:
1. URL of your fulfillmenttools instance (a "tenant"). We refer to this value by using https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com it throughout the documentation. Use this URL for requests to the REST API.
2. URL to the fulfillmenttools Backoffice to use in your browser.
3. Credentials for the project's initial admin user comprising username and password.
4. A security-related API key (used for Authorization). Will be referred to as AUTHKEY in this documentation.

Request an auth token

Once your tenant is ready, you can request an auth token by sending the following request with your user credentials:

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={AUTHKEY}

{
  "email": {USERNAME},  
  "password": {PASSWORD}, 
  "returnSecureToken": true
}

If all credentials are successful, the endpoint will respond with a body similar to the following

{
  "kind": "identitytoolkit#VerifyPasswordResponse",
  "localId": "jdwBuqqYWdYoqWTH1Xv85EJJMpm2",
  "email": "willy@wonkacandycompany.com",
  "displayName": "Willy Wonka",
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZ...ynLgbiNgHJJxtBXSTSFnp2fA",
  "registered": true,
  "refreshToken": "AE0u-NeGDdHWPB0RjOYO...pRMKoncagBq30OFCJkEgpvyI",
  "expiresIn": "3600"
}

The idToken is your auth token for any future requests to the platform. Make sure to always include it as a header in each of your requests:

Authorization: Bearer {YOUR_ID_TOKEN}

Add a facility

Make sure to include the Content-Type: application/json header to all of your requests

You are now ready to make your first API Call. In this example, we will add a simple facility to your tenant:

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

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

If successful, the endpoint will respond with 201 CREATED

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

The facility will now be visible in the backoffice, and you can use the facility ID to make all further requests.

Next steps

You are now equipped with the basic knowledge to make your first steps on our platform. If you're looking for a guided walkthrough to get to know fulfillmenttools better, we recommend checking out the Integration tutorial.

Additionally, the following resources will be helpful to learn more about our platform and available features: