1. Starshipit
  2. Couriers
  3. Fastway

How to set up Aramex (MyFastway & FastLabel)

Avatar
Esha Singh

Overview

This article outlines how to set up the courier service Aramex (MyFastway) in Starshipit.

Fastway Couriers MyFastway and FastLabel 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 Fastway/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 Fastway/Aramex account manager.
  • If you are setting up MyFastway, you need to generate an API Key, Client ID and Secret. To do this:
    • Log into MyFastway. 
    • Go to Administration > API Keys > Create Key.  
    • Click Save. 
    • Copy your Client ID and Secret.  

1. Set up MyFastway

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

  1. In your Starshipit account, select the Settings tabs, then select Couriers.  
  2. Click Add New Courier, then select Fastway.  
  3. Select Use MyFastway. 

    Use_MyFastway_checkbox.png

  4. Enter the Client ID and Client Secret copied from Fastway/Aramex.  
  5. Click Save.

1.1. 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:

  • Package/Parcel = P
  • Satchel A2 = A2
  • Satchel A3 = A3
  • Satchel A4 = A4
  • Satchel A5 = A5
  • DL (only available in New Zealand) = DL
  • 300g = 300gm

Fastway_Code.png

2. Set up FastLabel

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

2.1. Set up FastLabel manually

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

  1. In your Starshipit account, select the Settings tab, then select Couriers.
  2. Click Add New Courier, then select Fastway.
  3. Select Enable Fastway.

    Enable_fastway_checkbox.png

  4. Enter your Fastway 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.

2.2. Request FastLabel set up

Alternatively, you can request Starshipit support to set up your FastLabel account. Send an email to support@starshipit.com or your Account Manager with your company name, FastLabel login email address, and API Key. Starshipit will forward this information to Fastway to activate your account. We will notify you once this is done.

Note: This step is only required if you're using FastLabel and you haven't linked the accounts yourself.

2.3. 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

Note: The Parcel service acts as a single service for all coloured label options. Fastway's API will choose the most appropriate coloured label when you use this service.

 

Returns

Returns with Aramex is supported for MyFastway 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

Note: To generate a returns label with Aramex you will need to ensure your outgoing shipment has an email associated with the sender. 

 

Troubleshooting 

Q. Error: "Area Off Limit"

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

A. To resolve this, send an email to it.support@fastway.com.au  or (Australia) or it.support@fastway.co.nz or (New Zealand) and request access to your account. Once you receive a reply from Fastway, go back to the integration page and click Lookup.

 

Q. The price in Starshipit doesn't match the price in the MyFastway portal

  1. The MyFastway portal doesn't show you the fuel surcharge in the final cost where as 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 

Other relevant information for you:

To find out more about MyFastway API, click here

Articles in this section

Was this article helpful?
1 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.