Skip to content

Aramex Shipping API

Reference5 minPractitionerAdd-on · Integration hub

Use Aramex Shipping 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 Aramex Shipping API through a saved Integration hub connection. The catalog includes 6 actions, listed below.

Shipping and delivery

Aramex Shipping API

Authentication: Basic authentication (enter the credentials requested by the connection form)

Actions

ActionDescription
Create pickup
create_pickup		Schedules a pickup from the sender’s address.
Create shipment
create_shipment		Creates a new shipment in Aramex.
Get rate
get_rate		Gets shipping rate quotation for a package.
List cities
list_cities		Lists cities under a specified country.
List countries
list_countries		Lists supported countries for Aramex shipping.
Track shipment
track_shipment		Tracks shipment status by AWB number.

How to connect

Section titled “How to connect”

Open Integration hub, choose Aramex Shipping API, and create a named connection. Fill the username, password or other credentials 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