# API ENDPOINTS

- [Auth](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/auth.md): Auth collection holds endpoints that verifies the identity of a user, process, or device. These endpoints protect systems and resources from unauthorized access.
- [Authenticate](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/auth/authenticate.md): This is authentication endpoint to authenticate users.
- [Logout](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/auth/logout.md): This endpoint invalidates a user's session. It takes a mandatory parameter of user\_id.
- [Change Password](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/auth/change-password.md): This endpoint allows user change their password.It is recommended that this endpoint be called to change any password that may have been generated for your user during the onboarding process.
- [Orders](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders.md): The order collection holds endpoints that begins and end the lifecycle of a delivery request, these include other endpoints for search and data analysis purposes post delivery lifecycle.
- [Create](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/create.md): This is the endpoint for creating an order or requesting a pick up.
- [Get](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/get.md): This is the endpoint for getting the details of an order. The details gotten includes the status of the order and the timelines of the order - pick up date, dispatched date, delivery date etc.
- [Update](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/update.md): This is the endpoint for updating orders. It can be used for single or multiple orders and it takes an array object.
- [Delete](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/delete.md): This is the endpoint for deleting an order or a pick up.
- [Search](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/search.md): This endpoint allows you spool your orders.
- [Search via Waybill Number ](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/search-via-waybill-number.md): This endpoint allows you get an order via clients own waybill number (unique idnetifier)
- [Status With Date Range](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/status-with-date-range.md): This endpoint return the counts of order per each status - Pending Pick-Up,  Picked Up, Dispatched, Delivered, Returned.
- [Fetch Delivery Cost](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/fetch-delivery-cost.md): This is the endpoint for fetching the cost of delivery .It takes a non mandatory parameter - state. If state is not passed, the cost of delivery to all the states and FCT is returned.
- [Track](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/track.md): This is the endpoint can be used to get the status of an order and view the delivery timeline of that order.
- [Delivery Time Estimate](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/delivery-time-estimate.md): This is the endpoint for provides the time estimate to deliver an order.
- [Pickup Hubs](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/pickup-hubs.md): This is the endpoint for provides a list of all Fez hubs in a state.
- [States](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/orders/states.md): This is the endpoint for provides a list of all states in nigeria.
- [International Orders](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders.md): The International order collection holds endpoints that begins and end the lifecycle of International (Nigeria to other countries and vice versa) delivery request.
- [Create Import Order](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/create-import-order.md): This is the endpoint for creating an import order or requesting a pick up from a vendor/business.
- [Import Items Categories](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/import-items-categories.md): This is the endpoint for getting the possible item categories of the item to be imported.
- [Import Locations](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/import-locations.md): This is the endpoint for getting the list of locations where an item can be imported from to Nigeria.
- [Import Delivery Cost](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/import-delivery-cost.md): This is the endpoint for fetching Import delivery  cost.
- [Export Locations](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/export-locations.md): This is the endpoint for getting the list of locations where an item can be exported to, from Nigeria. Its also shows the acceptable weights.
- [Create Export Order](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/create-export-order.md): This is the endpoint for creating an export order from Nigeria to other countries.
- [Export Delivery Cost](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/international-orders/export-delivery-cost.md): This is the endpoint for fetching Export delivery  cost.
- [Users](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/users.md): The users collection is a basic CRUD on users ie registered individuals that has access to the application.
- [Create](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/users/create.md): This endpoint can be used to create other users for your organization.
- [Get All](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/users/get-all.md): This endpoint returns all users created for your organization.
- [Delete](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/users/delete.md): This endpoint is used to delete a user. Pass the id of the user (from the response of the All User API) as a URL parameter i.e /user/{id of user}/delete
- [Locker](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/locker.md): The Locker API documentation provides comprehensive guidance on how to integrate and utilize the Fez Smart Locker API in your applications.
- [Get All](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/locker/get-all.md): This endpoint retrieves information about lockers in a specific state. A successful response includes details about available lockers, maximum weight, and maximum value of items that can be stored.
- [Check Availability](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/locker/check-availability.md): This endpoint is for determining if a locker has available spaces. The Available flag returns true if the locker has available spaces and false if not.
- [Webhook](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/webhook.md): The Webhook API documentation provides comprehensive guidance on how to integrate and utilize the Event on Fez models (orders) in your applications.
- [Register Order Webhook](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/webhook/register-order-webhook.md): This endpoint stores client webhook (url) for to be called when an Order is created or altered. A successful response includes the order number and the status of the order.
- [Order Webhook Request](https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints/webhook/order-webhook-request.md): This endpoint is defined by the client, typically specified as a callback URL during webhook registration. It is invoked whenever an order changes its state (status).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fez-delivery-co.gitbook.io/fezcorporate-api-docs/api-endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
