githubEdit

Adding your first facility

circle-info

If you're on a free trial, we suggest following our free trial guides.

circle-check

Prerequisites

What's a facility?

Facilities represent various locations that form part of the fulfillment network. These locations fulfill distinct roles in ensuring the smooth movement of goods, both inbound and outbound. A distinction is made between two primary types of facilities: Managed facilitiesarrow-up-right and suppliersarrow-up-right.

For more information, see some other article.

Create a facility

In this guide, we'll create one managed facility, our warehouse that manages the inventory for our online store.

1

Open the create facility endpoint

In Postman, find the POST Add New Facility endpoint and click to open. You'll see the body is prefilled with some data.

Body
{
  "name": "Nerd Herd Clothing Warehouse",
  "type": "MANAGED_FACILITY",
  "address": {
    "companyName": "Nerd Herd Clothing Ltd",
    "country": "US",
    "postalCode": "10014",
    "city": "New York",
    "street": "West 10th Street"
  },
  "services": [
    {
      "type": "SHIP_FROM_STORE" // even if it's a warehouse, you need to use this type
    }
  ],
  "status": "ONLINE",
  "locationType": "WAREHOUSE",
  "tenantFacilityId": "1"
}
circle-info

We're only using the required fields in this example, and not all the available options. See our facilities article for more details and the API specification.

2

Edit the data

Change the name, address, and so on to match your company's data.

3

Send the request

Click Send.

circle-info

Ensure you've refreshed your authToken if it's been more than 60 minutes since your last refresh.

You should get a 201 Created response. You'll notice some extra fields that are part of the response and have been automatically created, including the facility id, which you'll need to make further requests:

Response
{
...
  {
...
         "resolvedCoordinates": {
            "lat": 33.9906506,
            "lon": -118.4666995
        },
        "resolvedTimeZone": {
            "offsetInSeconds": -18000,
            "timeZoneId": "America/New_York",
            "timeZoneName": "Eastern Standard Time",
            "source": "BACKEND_GENERATED"
        },
...        
    "fulfillmentProcessBuffer": 240,
...
    "capacityEnabled": false,
    "lastModified": "2025-12-02T15:12:16.505Z",
    "version": 1,
    "id": "019adf9f-1679-70ee-aeeb-4e94aa65d22b",
    "created": "2025-12-02T15:12:16.505Z"
}
4

Open the all facilities endpoint

In the collection list, select the GET all facilities endpoint and click Send. You'll see your newly created facility in the list with a 200 OK response

In the next article, we'll take you through how to import listings to your facility.

circle-info

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, let us know, and we'll change it immediately.

Last updated