githubEdit

Facilities in your free trial

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 facilities and suppliers.

Managed facilities are fulfillment locations operated and controlled within the network. The defining characteristic of these facilities is that the complete operational fulfillment process — including picking, packing, shipping, and related tasks — is managed internally or by a partner.

Suppliers are external entities within the supply chain that provide products to the network. These can include manufacturers, publishers, wholesalers, and distributors, among others.

For more information, see the Facilities article.

Why does it matter for my free trial?

For fulfillmenttools, everything is attached to a facility. Without one, a consumer could never receive their order.

So, to work with fulfillmenttools, let's create a facility.

Create a facility

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.

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

You can change the name, address, and so on for testing, or leave it as it is to see how it works.

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:

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.

The facility will also be visible in Backoffice for other team members to use, but we'll go through that later in this section.

In the next article, we'll take you through listings. What they are, how to set them up, and how to edit them.

Last updated