Skip to main content

Marketplace Configurations

This feature helps you to call one API for creating and picking your orders up. You don't need to care about creating pickup requests or pickup locations as everything will be done automatically with a just single request.

Register as a Business Admin (User)​

  • First, you will need to register as a Business Admin through calling this API:
POST
https://app.bosta.co/api/v2
/users/business/admin
More Info

With this Payload:

{
  "email": "test@email.com",
  "password": "dcmkasndgoin",
  "profile": {
    "firstName": "Sasuke",
    "lastName": "Uchiha",
    "phone": "+201111111111"
  },
  "heardAboutUsFrom": "zVendo",
  "countryId": "60e4482c7cb7d4bc4849c4d5"
  // Egypt countryId is 60e4482c7cb7d4bc4849c4d5 and KSA countryId is eF-3f9FZr
}

Verify Your Phone Number​

  • Then you will need to verify the phone number you entered through calling this API:
POST
https://app.bosta.co/api/v2
/users/business-admin/phone/confirm
More Info

With this Payload:

{
  "phone": "yourEnteredPhoneNumber",
  "token": "OTP you received on the above phone"
}

Verify Your Email​

  • Then you will need to verify the email you entered through calling this API:
POST
https://app.bosta.co/api/v2
/users/mail/confirm
More Info

With this Payload:

{
  "token": "ee959df3a8e3a0cca1ec59343a2b67c916c2fa77" // via email verification link
}

Register as a Bosta Business​

  • Second, you will need to register as a business through calling this API:
POST
https://app.bosta.co/api/v2
/businesses
More Info

With this Payload:

{
  "name": "Business Name",
  "industry": "Books, Arts and Media",
  "monthlyShipmentVolume": "PRO_1",
  "salesChannel": ["Facebook Shop", "Instagram"],
  "autoCreatePickups": true // This flag is very important to activate this feature
}

Create Your Default Location​

  • Use this API to create your default location
PUT
https://app.bosta.co/api/v2
/businesses/{businessIdReceviedOnRegistration}

With the following payload:

{
  "pickupAddress": [
    {
      "locationName": "yourLocationName",
      "districtId": "zoJP71_5Ca1", // You have to get districtId of your address through the below API
      "firstLine": "Your address first line details",
      "buildingNumber": "1",
      "floor": "2",
      "apartment": "3",
      "secondLine": "Your address second line details like: landmarks"
    }
  ]
}
tip

You can use this API to list districts

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

Now, you registered as Marketplace! 🎉

Create your first delivery​

  • You can start calling our add delivery endpoint to create your deliveries.
POST
https://app.bosta.co/api/v2
/deliveries
More Info
  • You need to provide the pickupAddress with firstLine and city as required fields in the payload as following:
  "pickupAddress": {
    "city": "Cairo",
    "zone": "ElMaadi",
    "district": "ElMaadi",
    "firstLine": "Midan degla",
    "buildingNumber": "123",
    "floor": "4",
    "apartment": "2"
  },
  • and aslo you need to provide pickupLocationContact field in the payload as following:
"pickupLocationContact": {
  "firstName": "contactpersonFirstname",
  "lastName": "contactpersonFirstname",
  "phone": "+201111111111",
  "email":"test@email.com"
  }
  • So the complete body will be somthing like this:
{
  "type": 10,
  "specs": {
    "packageType": "Parcel",
    "packageDetails": {
      "itemsCount": 5,
      "description": "Desc."
    }
  },
  "notes": "Welcome Note",
  "cod": 50,
  "dropOffAddress": {
    "districtId": "Iy7-lFD0BE0",
    "city": "Red Sea",
    "zone": "Qesm Hurghada 2",
    "district": "Qesm Hurghada 2",
    "firstLine": "Hurghada street",
    "buildingNumber": "123",
    "floor": "4",
    "apartment": "2"
  },
  "pickupAddress": {
    "city": "Cairo",
    "zone": "ElMaadi",
    "district": "ElMaadi",
    "firstLine": "Midan degla",
    "buildingNumber": "123",
    "floor": "4",
    "apartment": "2"
  },
  "pickupLocationContact": {
    "firstName": "contactpersonFirstname",
    "lastName": "contactpersonFirstname",
    "phone": "+201111111111",
    "email": "test@email.com"
  },
  "businessReference": "43535252",
  "receiver": {
    "firstName": "Sasuke",
    "lastName": "Uchiha",
    "phone": "01065685435",
    "email": "ahmed@ahmed.com"
  },
  "webhookUrl": "https://www.google.com/"
}