Facility API

The Facility API lets you implement the business processes necessary to onboard and manage facilities in a logistics network. You can use the Facility API to build your own facility management application to add and manage the facilities.

Introduction

The Facility API focuses on onboarding 'Facilities'. To do that, you first need to add a 'Property' that is a physical location (address, geo-location) of a building, compound, etc. that will host one or more facilities.

A Facility is an operating entity where logistical transactions such as storage and distribution of shipments are performed inside a Property. Pickup Center and Transit Hub are examples of a Facility in a logistics network. A Property can house one or more facilities. However, a Facility can be mapped to one Property at a time.

1904

This documentation provide an overview of the Facility API including some of the core endpoints of the API. For more information about the complete set of endpoints available, see the Facility API Reference.