Skip to main content

Format Bosta Address

Zoning Sheets

You can download Bosta zoning sheets from here.

Download Egypt Zoning Sheet

How it works​

  1. Bosta requires the delivery address to be sent in a format to help us automatically map it to the correct hub and deliver it faster

  2. You need to know cities and districts that bosta support to be able to insert a correct address

  3. Bosta is supporting 1 country right now (Egypt) with the following format:

      {
        _id: “60e4482c7cb7d4bc4849c4d5”,
        name: “Egypt”,
        code: “EG”
      }

  4. To get the cities list in each country you need to hit the following public API using one of the countries ids listed above

    GET
    https://app.bosta.co/api/v2
    /cities?countryId={countryId}

  5. You also can go further and get a list of zones or districts within each city using the following APIs:

    GET
    https://app.bosta.co/api/v2
    /cities/{cityId}/districts
    GET
    https://app.bosta.co/api/v2
    /cities/{cityId}/zones

    Or you can directly list all the available districts using the following API:

    GET
    https://app.bosta.co/api/v2
    /cities/getAllDistricts?countryId={countryId}

  6. Each district has a pickupAvailability and dropOffAvailability to specify whether we can pick and deliver to it or not. The district object will be as follow :

    {
      "zoneId": "qWckBs-T7",
      "zoneName": "15 May",
      "zoneOtherName": "١٥ مايو",
      "districtId": "Iy7-lFD0BE0",
      "districtName": "15 May",
      "districtOtherName": "١٥ مايو",
      "pickupAvailability": true,
      "dropOffAvailability": true,
      "coverage": "BOSTA"
    }

How to use​

Bosta Address format comes with the following parameters and can be used while creating orders or specifying your pickup locations

First format​

{
  "city": "City name from the cities list (Required)",
  "districtId": "District ID from /cities/{cityId}/districts or /cities/getAllDistricts (Required unless districtName and cityId are provided)",
  "zoneId": "Zone ID from /cities/{cityId}/zones (Optional)",
  "firstLine": "Address line 1 (Required, and must be more than 5 characters)",
  "secondLine": "Nearby landmark (Optional)",
  "buildingNumber": "(Optional)",
  "floor": "(Optional)",
  "apartment": "Apartment number (Optional)",
  "isWorkAddress": false
}

Second format​

{
  "city": "City name from the cities list (Required)",
  "cityId": "City ID from /cities?countryId={countryId} (Required when using districtName)",
  "districtName": "District name (Required when districtId is not provided)",
  "zoneId": "Zone ID from /cities/{cityId}/zones (Optional)",
  "firstLine": "Address line 1 (Required, and must be more than 5 characters)",
  "secondLine": "Nearby landmark (Optional)",
  "buildingNumber": "(Optional)",
  "floor": "(Optional)",
  "apartment": "Apartment number (Optional)",
  "isWorkAddress": false
}