BostaInstall

Summary

Create a new delivery order by specifying the delivery type, receiver details, destination address, and optional additional information such as cash on delivery amount, package description, and delivery instructions.

Inputs

• Delivery Type (required) — Choose the type of delivery: Send (send a package), Exchange (exchange a package), or Cash Collection (collect cash).
• Receiver Name (required) — Enter the full name of the delivery receiver.
• Receiver Phone (required) — Provide the phone number of the delivery receiver.
• City (required) — Specify the city where the package will be delivered.
• Address (required) — Enter the full delivery address (first line).
• Additional Fields — Optionally set additional parameters including COD amount, package description, notes, district, apartment number, floor, business reference, and whether to allow opening the package before payment.

Output shape

a single delivery record in JSON format

The output contains the newly created delivery details returned from the Bosta API. Errors during creation are returned with an error message in JSON format if 'Continue On Fail' is enabled.

Examples

Example 1: Create a simple delivery

Delivery Type=Send, Receiver Name=John Doe, Receiver Phone=1234567890, City=Riyadh, Address=123 Main St

Example 2: Create a delivery with additional fields

Delivery Type=Cash Collection, Receiver Name=Jane Smith, Receiver Phone=0987654321, City=Jeddah, Address=45 King Rd, COD Amount=150, Notes=Urgent delivery, Allow Opening Package=true