Create Your First Pickup

Create Your First Pickup

Create your business pickup

You can create the business pickup through the following endpoint:

POST

https://app.bosta.co/api/v2

/pickups

More Info

{
  scheduledDate: "YYYY-MM-DD",
  businessLocationId: "location_id"
  contactPerson: {
      name: "person_name",
      phone: "person_phone",
      secPhone: "second_phone",
      email: "person_email"
  },
  notes: "any_note_you_want_to_add",
  numberOfParcels: "no_of_packages",
  packageType: "Normal", // Allowed values: [Normal, Light Bulky, Heavy Bulky]
  repeatedData: {
      repeatedType: "", // Allowed values: [One Time, Daily, Weekly]
      days: [], // Must be an array of valid days(s): ["Sunday", "Monday", …]
      startDate: "YYYY-MM-DD", // Must be an array of valid date
      endDate: "YYYY-MM-DD",
  }
}

• You shall see the following response, and now you created your pickup request successfully.

{
  success: "true",
  message: "Pickup Request Created Successfully",
}

Error Codes

Code	Message
1010	Business not found.
1028	Invalid authorization token or API key.
1077	Please provide a default contact for your pickUp location
1078	Cannot create two pickup requests at the same date and pickup location
1080	Scheduled date can not be Friday!
1081	Can not choose today because it’s after the cut-off time
1082	Pickup is canceled but did not create scheduled one for it as it in the past
1083	Scheduled date can not be in the past.
2022	Pickup scheduled date can not be in holiday.
2024	Can not create new pickup, there is already a pickup assigned to a star today.
2025	Can not create new pickup, there is already a pickup picked up by a star today.
2026	Can not create new pickup for today, there is already a pickup marked with exception by a star today.
2027	Can not create new pickup, you already created a pickup today.