Fez Business API
  • Introduction
  • API ENDPOINTS
    • Auth
      • Authenticate
      • Logout
      • Change Password
    • Orders
      • Create
      • Get
      • Update
      • Delete
      • Search
      • Search via Waybill Number
      • Status With Date Range
      • Fetch Delivery Cost
      • Track
      • Delivery Time Estimate
    • International Orders
      • Create Import Order
      • Import Items Categories
      • Import Locations
      • Import Delivery Cost
      • Export Locations
      • Create Export Order
      • Export Delivery Cost
    • Users
      • Create
      • Get All
      • Delete
    • Locker
      • Get All
      • Check Availability
    • Webhook
      • Register Order Webhook
      • Order Webhook Request
Powered by GitBook
On this page
  1. API ENDPOINTS
  2. Locker

Get All

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.

In case of an unsuccessful request, the response will include a status code of 401 and a JSON object with empty "status" and "description" fields.

The response for a successful request will include a "Lockers" array containing objects with "lockerID" and "lockerAddress" fields, along with "maxWeight" and "maxValueOfItem" fields.

The locker ID will be required to be passed as a parameter when creating order that is meant to be saved in the locker.

Get All.

GET /lockers/{state}

Headers

Name
Type
Description

secret-key*

user secret key

Authorization*

Token

{
  "status": "Success",
  "description": "Lockers Fetched Successfully Fetched",
  "Lockers": [
    {
      "lockerID": "2100015346",
      "lockerAddress": "1234 testing location"
    }
  ],
  "maxWeight": "5",
  "maxValueOfItem": "100000"
}
{
    "status": "Error",
    "description": "Organization Secret Key is Required"
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://apisandbox.fezdelivery.co/v1/Lockers/{{State}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'secret-key: {{Your Secret Key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
PreviousLockerNextCheck Availability

Last updated 1 year ago