API documentationIncident ManagementFeedback
Edit

Quickstart

This tutorial guides you through the initial setup required to make your first Application Programming Interface (API) call to fulfillmenttools.

Setup access

  1. If you have not already done so, request a free trial at https://fulfillmenttools.com/en/request-free-trial/ to get started.

  2. The trial provides the following details:

    1. The URL of your fulfillmenttools instance, known as a tenant. This documentation uses the placeholder https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com for this value. Use this URL for requests to the API.

    2. The URL to the fulfillmenttools Backoffice for use in a browser.

    3. Credentials for the project's initial admin user, including a username and password.

    4. A security-related API key, used for authorization. This documentation refers to this value as AUTHKEY.

Request an auth token

Once the tenant is ready, an authentication token can be requested by sending the following request with the user credentials.

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={AUTHKEY}
{
  "email": "{USERNAME}",
  "password": "{PASSWORD}",
  "returnSecureToken": true
}

If the credentials are valid, the endpoint responds with a body similar to the following:

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

The idToken from the response is the authentication token for subsequent requests to the platform. Include it as a header in each request:

Authorization: Bearer {YOUR_ID_TOKEN}

Add a facility

Ensure all requests include the Content-Type: application/json header.

You are now ready to make your first API call. This example adds a simple facility to the 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"
}

A successful request returns a 201 CREATED status and a response body similar to the following:

{
    "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 is now visible in the Backoffice. The facility ID can be used in all further requests.

Next steps

This guide provides the basic knowledge to begin using the platform. For a guided walkthrough to become more familiar with fulfillmenttools, it is recommended to review the Integration tutorial.

Additionally, the following resources are helpful for learning more about the platform and its available features:

For questions, contact the Professional Services team at [email protected].

Last updated