Skip to content

Bosta Logistics API

Reference5 minPractitionerAdd-on · Integration hub

Use Bosta Logistics API through a saved Integration hub connection. The catalog includes 6 actions, listed below.

What you can do

Section titled “What you can do”

Use Bosta Logistics API through a saved Integration hub connection. The catalog includes 6 actions, listed below.

Shipping and delivery

Bosta Logistics API

Authentication: API key (enter the key and other details requested by the connection form)

Actions

ActionDescription
Cancel shipment
cancel_shipment		Cancels an existing shipment.
Create pickup
create_pickup		Schedules a pickup from the merchant’s address.
Create shipment
create_shipment		Creates a new delivery shipment in Bosta.
Get shipment
get_shipment		Fetches details of a specific shipment.
List cities
list_cities		Lists available delivery cities supported by Bosta.
Track shipment
track_shipment		Retrieves the live tracking status of a shipment.

How to connect

Section titled “How to connect”

Open Integration hub, choose Bosta Logistics API, and create a named connection. Fill the key and any additional account details requested by the connection form. Save the connection.

For the shared connection process, follow Connect an app.

Use it in a workflow

Section titled “Use it in a workflow”

Add an Integration step. Choose the app, saved connection and action, then map the action inputs from your record or workflow data.

The action list comes from the integration catalog. The connection form supplies the provider-specific input fields.

What's next

Connect an app and use it in a workflowConnect an app in the Integration hub, then add an Integration step to a workflow that reads from or writes to it.IntegrationRun an action of an Integration hub connection from a workflow, such as reading or writing data in a connected app.

Last checked