Bosta icon

Bosta

Interact with Bosta delivery and logistics API

Actions11

Delivery → Search

AI-generated

Summary

Search deliveries by specifying one or more criteria such as type, tracking numbers, mobile phones, business reference, state, and pickup or drop off zone or city IDs.

Inputs

  • Search Fields — A collection of optional search parameters including: type (delivery type), trackingNumbers (comma-separated tracking numbers), mobilePhones (comma-separated mobile phone numbers), businessReference (business reference number), state (delivery status), pickupZoneIds (comma-separated pickup zone IDs), pickupCityIds (comma-separated pickup city IDs), dropOffZoneIds (comma-separated drop off zone IDs), dropOffCityIds (comma-separated drop off city IDs).

Output shape

a list of delivery objects matching the specified search criteria

Search parameters are optional and can be combined. The operation returns the deliveries under the response data property after filtering by the given fields.

Examples

Example 1: Search deliveries using tracking numbers and state

Set trackingNumbers to one or more comma-separated tracking numbers and state to the desired delivery status to filter matching deliveries.

Discussion