{"version":1,"pages":[{"id":"yeiBmtCgjiAzAMFel7NI","title":"Introduction","pathname":"/fezcorporate-api-docs","siteSpaceId":"sitesp_cZqSt","description":"Welcome to Fez Business API! Here you'll find all the documentation you need to get up and running with the Fez Business API."},{"id":"J5BNEa70zMCVL23aqaQD","title":"Auth","pathname":"/fezcorporate-api-docs/api-endpoints/auth","siteSpaceId":"sitesp_cZqSt","description":"Auth collection holds endpoints that verifies the identity of a user, process, or device. These endpoints protect systems and resources from unauthorized access.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"MQWEQo1CcOt1sKWfKCTX","title":"Authenticate","pathname":"/fezcorporate-api-docs/api-endpoints/auth/authenticate","siteSpaceId":"sitesp_cZqSt","description":"This is authentication endpoint to authenticate users.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Auth"}]},{"id":"afl66lbygMgSKDhY3aaT","title":"Logout","pathname":"/fezcorporate-api-docs/api-endpoints/auth/logout","siteSpaceId":"sitesp_cZqSt","description":"This endpoint invalidates a user's session. It takes a mandatory parameter of user_id.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Auth"}]},{"id":"qsUxN5mu7OqwIiooPBbS","title":"Change Password","pathname":"/fezcorporate-api-docs/api-endpoints/auth/change-password","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Auth"}]},{"id":"M3r2LDtNPwPN3m0K6PqR","title":"Orders","pathname":"/fezcorporate-api-docs/api-endpoints/orders","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"nItp4npxmEF8AVfyeeIk","title":"Create","pathname":"/fezcorporate-api-docs/api-endpoints/orders/create","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for creating an order or requesting a pick up.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"szFAuqEEjTkR66fAKJZw","title":"Get","pathname":"/fezcorporate-api-docs/api-endpoints/orders/get","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"PV1EItLUyc7RRqpBfnHK","title":"Update","pathname":"/fezcorporate-api-docs/api-endpoints/orders/update","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for updating orders. It can be used for single or multiple orders and it takes an array object.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"N10qCP1HKg0mqwsvTW2q","title":"Delete","pathname":"/fezcorporate-api-docs/api-endpoints/orders/delete","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for deleting an order or a pick up.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"KX7M2Rc1R0TZuFyfU8yo","title":"Search","pathname":"/fezcorporate-api-docs/api-endpoints/orders/search","siteSpaceId":"sitesp_cZqSt","description":"This endpoint allows you spool your orders.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"CgYpuwxjYiedeLG4AE0T","title":"Search via Waybill Number ","pathname":"/fezcorporate-api-docs/api-endpoints/orders/search-via-waybill-number","siteSpaceId":"sitesp_cZqSt","description":"This endpoint allows you get an order via clients own waybill number (unique idnetifier)","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"szTpcWsPXiJNGpK4BMfb","title":"Status With Date Range","pathname":"/fezcorporate-api-docs/api-endpoints/orders/status-with-date-range","siteSpaceId":"sitesp_cZqSt","description":"This endpoint return the counts of order per each status - Pending Pick-Up,  Picked Up, Dispatched, Delivered, Returned.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"ao1FtoEQ2a0x9MizkIgt","title":"Fetch Delivery Cost","pathname":"/fezcorporate-api-docs/api-endpoints/orders/fetch-delivery-cost","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"xgxk4SLuJ2wvBNbHYGhu","title":"Track","pathname":"/fezcorporate-api-docs/api-endpoints/orders/track","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint can be used to get the status of an order and view the delivery timeline of that order.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"lBmRHP33eaW4oF6YWtb3","title":"Delivery Time Estimate","pathname":"/fezcorporate-api-docs/api-endpoints/orders/delivery-time-estimate","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for provides the time estimate to deliver an order.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"l97zrsarTrBBJ7cqpEQm","title":"Pickup Hubs","pathname":"/fezcorporate-api-docs/api-endpoints/orders/pickup-hubs","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for provides a list of all Fez hubs in a state.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"dzK3eDdvjRSKX501NlMs","title":"States","pathname":"/fezcorporate-api-docs/api-endpoints/orders/states","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for provides a list of all states in nigeria.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Orders"}]},{"id":"k0tqBDDjSJX0CUIMgymB","title":"International Orders","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders","siteSpaceId":"sitesp_cZqSt","description":"The International order collection holds endpoints that begins and end the lifecycle of International (Nigeria to other countries and vice versa) delivery request.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"VLr7SOSnHG04zSdAf1hO","title":"Create Import Order","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/create-import-order","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for creating an import order or requesting a pick up from a vendor/business.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"VX6s4zFKITdzt4Mcozjg","title":"Import Items Categories","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/import-items-categories","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for getting the possible item categories of the item to be imported.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"kUp5fiqa25DBKnXimFNv","title":"Import Locations","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/import-locations","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for getting the list of locations where an item can be imported from to Nigeria.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"i9NqGN6RxAVNxImZPjRV","title":"Import Delivery Cost","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/import-delivery-cost","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for fetching Import delivery  cost.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"xiAAcj8FJpZRUTcAm542","title":"Export Locations","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/export-locations","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"0YAMEVB1iCCxDHEbXq9N","title":"Create Export Order","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/create-export-order","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for creating an export order from Nigeria to other countries.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"RVZjEZ4Y1PGANkieZ7Ga","title":"Export Delivery Cost","pathname":"/fezcorporate-api-docs/api-endpoints/international-orders/export-delivery-cost","siteSpaceId":"sitesp_cZqSt","description":"This is the endpoint for fetching Export delivery  cost.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"International Orders"}]},{"id":"zawhBSp1HLluSKck77UW","title":"Users","pathname":"/fezcorporate-api-docs/api-endpoints/users","siteSpaceId":"sitesp_cZqSt","description":"The users collection is a basic CRUD on users ie registered individuals that has access to the application.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"qCAyjeHUcZEXC9ZtECm8","title":"Create","pathname":"/fezcorporate-api-docs/api-endpoints/users/create","siteSpaceId":"sitesp_cZqSt","description":"This endpoint can be used to create other users for your organization.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Users"}]},{"id":"zYCBF6HrYHWp7UINej7B","title":"Get All","pathname":"/fezcorporate-api-docs/api-endpoints/users/get-all","siteSpaceId":"sitesp_cZqSt","description":"This endpoint returns all users created for your organization.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Users"}]},{"id":"AI57yZZlCzgiLs1xlvBk","title":"Delete","pathname":"/fezcorporate-api-docs/api-endpoints/users/delete","siteSpaceId":"sitesp_cZqSt","description":"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","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Users"}]},{"id":"jo6bjhTfOgUl40tDam57","title":"Locker","pathname":"/fezcorporate-api-docs/api-endpoints/locker","siteSpaceId":"sitesp_cZqSt","description":"The Locker API documentation provides comprehensive guidance on how to integrate and utilize the Fez Smart Locker API in your applications.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"u47hsMZqB2w77SIto1SO","title":"Get All","pathname":"/fezcorporate-api-docs/api-endpoints/locker/get-all","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Locker"}]},{"id":"et8NY95O8WmdOsvCFC7b","title":"Check Availability","pathname":"/fezcorporate-api-docs/api-endpoints/locker/check-availability","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Locker"}]},{"id":"ADYHe2nlfrFiCSmOCTiw","title":"Webhook","pathname":"/fezcorporate-api-docs/api-endpoints/webhook","siteSpaceId":"sitesp_cZqSt","description":"The Webhook API documentation provides comprehensive guidance on how to integrate and utilize the Event on Fez models (orders) in your applications.","breadcrumbs":[{"label":"API ENDPOINTS"}]},{"id":"9HFRQ46As8QFurFqyRsQ","title":"Register Order Webhook","pathname":"/fezcorporate-api-docs/api-endpoints/webhook/register-order-webhook","siteSpaceId":"sitesp_cZqSt","description":"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.","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Webhook"}]},{"id":"6fq4M7YNDSdg6iYn4rDH","title":"Order Webhook Request","pathname":"/fezcorporate-api-docs/api-endpoints/webhook/order-webhook-request","siteSpaceId":"sitesp_cZqSt","description":"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).","breadcrumbs":[{"label":"API ENDPOINTS"},{"label":"Webhook"}]}]}