How to set up Aramex (MyFastway)

This article outlines how to set up the courier service Aramex (MyFastway) in Starshipit. Aramex's integration with Starshipit allows you to use all of Starshipit's features including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking, returns, notifications and many more.

How it works

• Integrate your Aramex account using the legacy FastLabel API, or the new MyFastway API.
• If you are unsure which Fastway API you have set up, please check with your Aramex account manager.

1. Set up Aramex

To set up Aramex, you need to generate an API Key, Client ID and Secret.

1. Log into Aramex then go to Administration > API Keys > Create Key.
2. Click Save.
3. Copy your Client ID and Secret.

Once you have your API Key, Client ID and Secret, you can set up Aramex in Starshipit.

1. In Starshipit, navigate to Settings > Couriers.
2. Click Add a new courier, then select Aramex.
3. Tick Enable Aramex and Use MyFastway API.
4. Enter the Client ID and Client Secret copied fromAramex.
5. Tick Use Version 2 Quotes API.
6. Click Save.

Add the product codes

To complete the integration between Starshipit and Aramex, you need to add your product codes. You can load all MyFastway product codes by clicking Add default product codes.

The available product codes are:

• Package/Parcel = P
• Satchel A2 = A2
• Satchel A3 = A3
• Satchel A4 = A4
• Satchel A5 = A5
• Priority Parcel = P_PRIORITY
• Priority Satchel A2 = A2_PRIORITY
• Priority Satchel A3 = A3_PRIORITY
• Priority Satchel A4 = A4_PRIORITY
• Priority Satchel A5 = A5_PRIORITY
• DL (only available in New Zealand) = DL
• 300g = 300gm

2. Set up Aramex

Before you begin, you need to request an API Key from Aramex.  

Set up Aramex manually

If you know your Aramex API Key you can manually activate and set up FastLabel.

1. In Starshipit, navigate to Settings > Couriers.
2. Click Add a new courier, then select Aramex.
3. Tick **Enable Aramex.
4. Enter your Aramex API Key, User ID and Franchise ID. If you don't know your User ID, click Lookup to search for it.
5. If it hasn't been auto-populated, select your Fastway Franchise from the dropdown menu.
6. Click Save.

Request Aramex set up

Alternatively, you can ask our support team to set up your FastLabel account. Send an email to your Account Manager or reach out to our support team with your company name, Aramex login email address, and API Key. Starshipit will forward this information to Aramex to activate your account. We will then notify you once this is done.

Add the product codes

To complete the integration between Starshipit and Fastway/Aramex, you need to add your product codes. The available product codes are:

• Parcel = 1
• Satchel A2 = 4
• Satchel A3 = 5
• Satchel A4 = 6
• Satchel A5 = 7
• Small Flat Rate Parcel = 16
• Medium Flat Rate Parcel = 17
• Large Flat Rate Parcel = 18
• Blue Zone = BLUE
• Black Zone = BLACK
• Yellow Zone = YELLOW
• Brown Zone = BROWN
• Lime Zone = LIME
• Pink Zone = PINK
• Red Zone = RED
• Orange Zone = ORANGE
• Green Zone = GREEN
• White Zone = WHITE
• Grey Zone = Grey

Returns

Returns with Aramex is supported for Aramex accounts. Returns are supported for domestic shipments within New Zealand and Australia.

How to print a return label

1. Navigate to the printed or shipped tab and open the order you would like to add a return shipment to.
2. Select 'more actions' and click 'create a return order'
3. A return order will open - check the details are correct for your return shipment
4. Download or print your return label

Cancel orders

You can now cancel Aramex labels that have been printed in Starshipit.

How to cancel an order

1. Navigate to Settings > Couriers > Aramex Settings.
2. Move to the Tools tab.
3. Under Cancel a Shipment, enter the tracking number of the order you would like to cancel.
4. Click Cancel to confirm.

Troubleshooting

Error: "Area Off Limit"

If you get an "Area Off Limit", your account does not have the correct user privileges activated. 

To resolve this, send an email to Fastway Australia/Aramex Australia or Fastway New Zealand/Aramex New Zealand and request access to your account. Once you receive a reply from Fastway, go back to the integration page and click Lookup.

The price in Starshipit doesn't match the price in the Aramex portal

1. The Aramex portal doesn't show you the fuel surcharge in the final cost whereas Starshipit will. Ensure you have compared the prices both with tax, fuel surcharge and base price.
2. There is additional charges for Signature Required. Try unticking the option and checking to see if this produces the rate you're expecting.

Insufficient funds to complete this consignment.

This error appears when your Aramex account does not have enough credit to create a shipment. It’s triggered by Aramex (not Starshipit) when your prepaid balance is too low or you have outstanding invoices.

How to fix:

1. Log in to your Aramex customer portal.
2. Check your account balance and any unpaid invoices.
3. Add credit or pay outstanding invoices.
4. Once your balance is updated, try creating the shipment again in Starshipit.

Tip: This error is common with prepaid Aramex accounts and does not relate to your Starshipit billing.

Other relevant information

To find out more about Aramex API, click here